Merge remote-tracking branch 'origin/explorer-ga' into core-ent-3.2
Jason Stirnaman
commit
b5f511f9e4
|
|
@ -97,4 +97,4 @@ blockquote {
|
|||
"blocks/important",
|
||||
"blocks/warning",
|
||||
"blocks/caution",
|
||||
"blocks/beta";
|
||||
"blocks/special-state";
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
.block.beta {
|
||||
.block.special-state {
|
||||
@include gradient($grad-burningDusk);
|
||||
padding: 4px;
|
||||
border: none;
|
||||
border-radius: 25px !important;
|
||||
|
||||
.beta-content {
|
||||
.state-content {
|
||||
background: $article-bg;
|
||||
border-radius: 21px;
|
||||
padding: calc(1.65rem - 4px) calc(2rem - 4px) calc(.1rem + 4px) calc(2rem - 4px);
|
||||
|
|
@ -12,6 +12,7 @@ influxdb3/core/tags: [databases]
|
|||
related:
|
||||
- /influxdb3/core/write-data/best-practices/schema-design/
|
||||
- /influxdb3/core/reference/cli/influxdb3/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/admin/buckets/
|
||||
cloud_dedicated: /influxdb3/cloud-dedicated/admin/databases/
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ list_code_example: |
|
|||
{{% /code-placeholders %}}
|
||||
related:
|
||||
- /influxdb3/core/reference/cli/influxdb3/create/database/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
source: /shared/influxdb3-admin/databases/create.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ list_code_example: |
|
|||
{{% /code-placeholders %}}
|
||||
related:
|
||||
- /influxdb3/core/reference/cli/influxdb3/delete/database/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
source: /shared/influxdb3-admin/databases/delete.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ list_code_example: |
|
|||
```
|
||||
related:
|
||||
- /influxdb3/core/reference/cli/influxdb3/show/databases/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
source: /shared/influxdb3-admin/databases/list.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ influxdb3/enterprise/tags: [databases]
|
|||
related:
|
||||
- /influxdb3/enterprise/write-data/best-practices/schema-design/
|
||||
- /influxdb3/enterprise/reference/cli/influxdb3/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
alt_links:
|
||||
cloud: /influxdb/cloud/admin/buckets/
|
||||
cloud_dedicated: /influxdb3/cloud-dedicated/admin/databases/
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ list_code_example: |
|
|||
{{% /code-placeholders %}}
|
||||
related:
|
||||
- /influxdb3/enterprise/reference/cli/influxdb3/create/database/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
source: /shared/influxdb3-admin/databases/create.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ list_code_example: |
|
|||
{{% /code-placeholders %}}
|
||||
related:
|
||||
- /influxdb3/enterprise/reference/cli/influxdb3/delete/database/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
source: /shared/influxdb3-admin/databases/delete.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ list_code_example: |
|
|||
```
|
||||
related:
|
||||
- /influxdb3/enterprise/reference/cli/influxdb3/show/databases/
|
||||
- /influxdb3/explorer/manage-databases/
|
||||
source: /shared/influxdb3-admin/databases/list.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ menu:
|
|||
influxdb3_enterprise:
|
||||
parent: Administer InfluxDB
|
||||
weight: 202
|
||||
related:
|
||||
- /influxdb3/explorer/manage-tokens/
|
||||
source: /shared/influxdb3-admin/tokens/_index.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,9 @@ menu:
|
|||
parent: Manage tokens
|
||||
name: Admin tokens
|
||||
weight: 101
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb3/explorer/manage-tokens/
|
||||
influxdb3/enterprise/tags: [tokens]
|
||||
source: /shared/influxdb3-admin/tokens/admin/_index.md
|
||||
---
|
||||
|
|
|
|||
|
|
@ -0,0 +1,132 @@
|
|||
---
|
||||
title: Get started with InfluxDB 3 Explorer
|
||||
description: >
|
||||
Learn how to use InfluxDB 3 Explorer to connect to InfluxDB 3, write data, and
|
||||
query data.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
name: Get started
|
||||
weight: 3
|
||||
---
|
||||
|
||||
Get started with {{% product-name %}} by connecting it to an InfluxDB 3 instance,
|
||||
writing data to InfluxDB, and then querying that data. This guide walks you
|
||||
through each of those steps.
|
||||
|
||||
1. [Connect to an InfluxDB 3 server](#connect-to-an-influxdb-3-server)
|
||||
2. [Write data to InfluxDB](#write-data-to-influxdb)
|
||||
3. [Query data from InfluxDB](#query-data-from-influxdb)
|
||||
|
||||
> [!Note]
|
||||
> This guide assumes you have already [installed {{% product-name %}}](/influxdb3/explorer/install/).
|
||||
|
||||
## Connect to an InfluxDB 3 server
|
||||
|
||||
InfluxDB 3 Explorer supports the following InfluxDB 3 products:
|
||||
|
||||
- [InfluxDB 3 Core](/influxdb3/core/)
|
||||
- [InfluxDB 3 Enterprise](/influxdb3/enterprise/)
|
||||
|
||||
1. Navigate to **Configure** > **Servers**.
|
||||
2. Click **+ Connect Your First Server**.
|
||||
3. Provide the following InfluxDB 3 server information:
|
||||
|
||||
- **Server name**: A name to identify the InfluxDB 3 server you're connecting to.
|
||||
- **Server URL**: The URL used to connect to your InfluxDB 3 server.
|
||||
- Select the protocol to use (http or https).
|
||||
- Provide the host and, if necessary, the port.
|
||||
- **Token**: The authorization token to use to connect to your InfluxDB 3 server.
|
||||
We recommend using an InfluxDB 3 _admin_ token.
|
||||
|
||||
> [!Important]
|
||||
> #### Token permissions may limit Explorer functionality
|
||||
>
|
||||
> The permissions associated with the provided token determine what
|
||||
> databases you can access using this server configuration. InfluxDB 3
|
||||
> tokens with limited permissions may not be able to use some Explorer
|
||||
> functionality.
|
||||
|
||||
4. Click **Add Server**.
|
||||
|
||||
InfluxDB 3 Explorer attempts to verify the connection. If successful, Explorer
|
||||
saves the server configuration and selects it as the active server.
|
||||
|
||||
> [!Note]
|
||||
> If you already have data in your InfluxDB 3 instance, skip to
|
||||
> [Query data from InfluxDB](#query-data-from-influxdb).
|
||||
|
||||
## Write data to InfluxDB
|
||||
|
||||
{{% product-name %}} lets you write data to InfluxDB 3 and provides multiple
|
||||
options. For this getting started guide, use Explorer to write one of the
|
||||
sample data sets to InfluxDB:
|
||||
|
||||
1. Navigate to **Write Data** > **Sample/Dev Data**.
|
||||
2. Select any of the available sample data sets.
|
||||
3. Click **Write Sample Data**.
|
||||
|
||||
{{% product-name %}} creates a new database and then writes the sample data to
|
||||
the database.
|
||||
|
||||
### Other write methods
|
||||
|
||||
{{% product-name %}} provides other ways to write data to InfluxDB, including
|
||||
the following:
|
||||
|
||||
- Line protocol
|
||||
- CSV or JSON
|
||||
- InfluxDB 3 client libraries
|
||||
- Telegraf
|
||||
|
||||
## Query data from InfluxDB
|
||||
|
||||
To use {{% product-name %}} to query data from InfluxDB 3, navigate to
|
||||
**Query Data** > **Data Explorer**.
|
||||
|
||||
The _Data Explorer_ lets you explore the
|
||||
schema of your database and automatically builds SQL queries by either
|
||||
selecting columns in the _Schema Browser_ or by using _Natural Language_ with
|
||||
the {{% product-name %}} OpenAI integration.
|
||||
|
||||
For this getting started guide, use the Schema Browser to build a SQL query
|
||||
that returns data from the newly written sample data set.
|
||||
|
||||
1. On the **Data Explorer** in the **Schema** column, select the database you
|
||||
want to query from the database dropdown menu.
|
||||
Once selected, all tables in the database appear.
|
||||
2. Click the name of the table you want to query to expand and view all the
|
||||
columns in that table.
|
||||
3. Select each column you want to query.
|
||||
As you select columns in the Schema Browser, Explorer generates and updates
|
||||
an SQL query in the _Query pane_.
|
||||
4. Use the time range dropdown menu above the Query pane to select a time range
|
||||
to query. You can select one of the predefined relative time ranges, or you
|
||||
can select _Custom Range_ to define an absolute time range to query.
|
||||
5. With columns and a time range selected, click **Run Query**.
|
||||
|
||||
{{% product-name %}} runs the query and returns the results in the _Results pane_.
|
||||
The Results pane provides three view options:
|
||||
|
||||
- **Table** _(default)_: Displays raw query results in paginated table format.
|
||||
- **Line**: Displays query results in a line graph.
|
||||
- **Bar**: Displays query results in a bar graph.
|
||||
|
||||
> [!Tip]
|
||||
> SQL query results may not be ordered by `time` and Line and Bar graph
|
||||
> visualizations may behave unexpectedly. To order results by time:
|
||||
>
|
||||
> - Ensure that you query the `time` column
|
||||
> - Update the query to include an `ORDER BY time` clause.
|
||||
|
||||
Congratulations! You have successfully used {{% product-name %}} to connect to,
|
||||
write data to, and query data from an InfluxDB 3 instance.
|
||||
|
||||
## Video walkthrough
|
||||
|
||||
{{< youtube "zW2Hi1Ki4Eo" >}}
|
||||
|
||||
<!--
|
||||
## Next steps
|
||||
|
||||
TO-DO: Provide links to deeper content as we release it
|
||||
-->
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
title: Get started using InfluxDB 3 Explorer
|
||||
description: Follow steps to get started using InfluxDB 3 Explorer.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
name: Get started
|
||||
weight: 3
|
||||
---
|
||||
|
||||
Follow steps to get started using InfluxDB 3 Explorer.
|
||||
|
||||
{{< youtube "zW2Hi1Ki4Eo" >}}
|
||||
|
||||
<!-- {{< page-nav next="/explorer/v1/get-started/connect/" >}} -->
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: Connect to a server
|
||||
description:
|
||||
Use InfluxDB 3 Explorer to connect to an InfluxDB 3 server.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
parent: Get started
|
||||
weight: 101
|
||||
draft: true
|
||||
---
|
||||
|
||||
Use InfluxDB 3 Explorer to connect to an InfluxDB 3 server.
|
||||
|
|
@ -73,7 +73,11 @@ Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**.
|
|||
- `$(pwd)/db:/db:rw`
|
||||
- `$(pwd)/config:/app-root/config:ro`
|
||||
- `$(pwd)/ssl:/etc/nginx/ssl:ro`
|
||||
- Any of the available [environment variables](#environment-variables)
|
||||
- Any of the available [environment variables](#environment-variables)
|
||||
|
||||
> [!Note]
|
||||
> To persist sessions across container restarts, see the detailed instructions
|
||||
> on setting the [`SESSION_SECRET_KEY` environment variable](#session_secret_key).
|
||||
|
||||
```bash
|
||||
docker run --detach \
|
||||
|
|
@ -114,6 +118,13 @@ To enable TLS/SSL, mount valid certificate and key files into the container:
|
|||
The nginx web server automatically uses certificate files when they are present
|
||||
in the mounted path.
|
||||
|
||||
> [!Note]
|
||||
> You can use a custom location for certificate and key files.
|
||||
> Use the [`SSL_CERT_PATH`](#ssl_cert_path) and [`SSL_KEY_PATH`](#ssl_key_path)
|
||||
> environment variables to identify the custom location.
|
||||
> Also update the SSL directory volume mount path inside the container.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Pre-configure InfluxDB connection settings
|
||||
|
|
@ -191,11 +202,91 @@ If `--mode` is not set, the container defaults to query mode.
|
|||
Use the following environment variables to customize {{% product-name %}} settings
|
||||
in your container.
|
||||
|
||||
| Variable | Description | Default |
|
||||
|----------------|--------------------------------------------------|----------------------|
|
||||
| `DATABASE_URL` | Path to SQLite DB inside container | `/db/sqlite.db` |
|
||||
- [DATABASE_URL](#database_url)
|
||||
- [SESSION_SECRET_KEY](#session_secret_key)
|
||||
- [SSL_CERT_PATH](#ssl_cert_path)
|
||||
- [SSL_KEY_PATH](#ssl_key_path)
|
||||
|
||||
---
|
||||
### DATABASE_URL
|
||||
|
||||
Path to SQLite DB inside container. The default is `/db/sqlite.db`.
|
||||
|
||||
{{< expand-wrapper >}}
|
||||
{{% expand "View `DATABASE_URL` example" %}}
|
||||
<!-- pytest.mark.skip -->
|
||||
|
||||
```bash
|
||||
docker run --detach \
|
||||
# ...
|
||||
--volume $(pwd)/db:/custom/db-path:rw \
|
||||
--env DATABASE_URL=/custom/db-path/sqlite.db \
|
||||
quay.io/influxdb/influxdb3-explorer:latest
|
||||
```
|
||||
{{% /expand %}}
|
||||
{{< /expand-wrapper >}}
|
||||
|
||||
### SESSION_SECRET_KEY
|
||||
|
||||
Specifies the secret key for session management. If none is provided, Explorer
|
||||
uses a random 32-byte hex string as the session secret key.
|
||||
|
||||
{{< expand-wrapper >}}
|
||||
{{% expand "View `SESSION_SECRET_KEY` example" %}}
|
||||
<!-- pytest.mark.skip -->
|
||||
|
||||
```bash
|
||||
docker run --detach \
|
||||
# ...
|
||||
--env SESSION_SECRET_KEY=xxX0Xx000xX0XxxxX0Xx000xX0XxX00x \
|
||||
quay.io/influxdb/influxdb3-explorer:latest
|
||||
```
|
||||
{{% /expand %}}
|
||||
{{< /expand-wrapper >}}
|
||||
|
||||
> [!Important]
|
||||
> #### Always set SESSION_SECRET_KEY in production
|
||||
>
|
||||
> When you restart the container, {{% product-name %}} generates a new key if
|
||||
> not explicitly set. For production use cases, always set the `SESSION_SECRET_KEY`
|
||||
> environment variable to persist sessions across restarts.
|
||||
|
||||
### SSL_CERT_PATH
|
||||
|
||||
Defines the path to the SSL certificate file inside the container.
|
||||
Default is `/etc/nginx/ssl/cert.pem`.
|
||||
|
||||
{{< expand-wrapper >}}
|
||||
{{% expand "View `SSL_CERT_PATH` example" %}}
|
||||
<!-- pytest.mark.skip -->
|
||||
|
||||
```bash
|
||||
docker run --detach \
|
||||
# ...
|
||||
--volume $(pwd)/ssl:/custom/ssl:ro \
|
||||
--env SSL_CERT_PATH=/custom/ssl/cert.pem \
|
||||
quay.io/influxdb/influxdb3-explorer:latest
|
||||
```
|
||||
{{% /expand %}}
|
||||
{{< /expand-wrapper >}}
|
||||
|
||||
### SSL_KEY_PATH
|
||||
|
||||
Defines the path to the SSL private key file inside the container.
|
||||
Default is `/etc/nginx/ssl/key.pem`.
|
||||
|
||||
{{< expand-wrapper >}}
|
||||
{{% expand "View `SSL_KEY_PATH` example" %}}
|
||||
<!-- pytest.mark.skip -->
|
||||
|
||||
```bash
|
||||
docker run --detach \
|
||||
# ...
|
||||
--volume $(pwd)/ssl:/custom/ssl:ro \
|
||||
--env SSL_KEY_PATH=/custom/ssl/key.pem \
|
||||
quay.io/influxdb/influxdb3-explorer:latest
|
||||
```
|
||||
{{% /expand %}}
|
||||
{{< /expand-wrapper >}}
|
||||
|
||||
## Volume Reference
|
||||
|
||||
|
|
@ -205,8 +296,6 @@ in your container.
|
|||
| `/app-root/config` | JSON config for defaults | `./config` |
|
||||
| `/etc/nginx/ssl` | SSL certs for HTTPS | `./ssl` |
|
||||
|
||||
---
|
||||
|
||||
## Exposed Ports
|
||||
|
||||
| Port | Protocol | Purpose |
|
||||
|
|
|
|||
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: Manage databases with InfluxDB 3 Explorer
|
||||
seotitle: Manage InfluxDB databases with InfluxDB 3 Explorer
|
||||
description: >
|
||||
Use InfluxDB 3 Explorer to manage databases in an InfluxDB 3 instance.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
name: Manage databases
|
||||
weight: 4
|
||||
related:
|
||||
- /influxdb3/core/admin/databases/, Manage databases in InfluxDB 3 Core
|
||||
- /influxdb3/enterprise/admin/databases/, Manage databases in InfluxDB 3 Enterprise
|
||||
---
|
||||
|
||||
{{% product-name %}} lets you manage databases in your InfluxDB 3 Core instance
|
||||
or InfluxDB 3 Enterprise cluster.
|
||||
|
||||
> [!Important]
|
||||
> Using {{% product-name %}} to manage a database in InfluxDB 3 requires that
|
||||
> Explorer is running in [admin mode](/influxdb3/explorer/install/#run-in-query-or-admin-mode)
|
||||
> and that the token used in the InfluxDB 3 server configuration is an
|
||||
> [admin token](/influxdb3/enterprise/admin/tokens/admin/).
|
||||
|
||||
To manage databases, navigate to **Manage Databases** in Explorer.
|
||||
This page provides a list of databases in the connected InfluxDB 3 server that
|
||||
contains the database name, retention period, and number of tables
|
||||
(which includes system tables).
|
||||
|
||||
## Create a database
|
||||
|
||||
1. On the **Manage Databases** page, click **+ Create New**.
|
||||
2. Provide a **Database name**.
|
||||
_For information about naming restrictions, see
|
||||
[InfluxDB 3 naming restrictions](/influxdb3/enterprise/admin/databases/create/#database-naming-restrictions)._
|
||||
3. _(Optional)_ Specify a **Retention Period** for the database.
|
||||
This determines how long InfluxDB retains data (based on timestamp) in the
|
||||
database before expiring and removing the data. If no retention period is
|
||||
specified, InfluxDB does not expire data in the database.
|
||||
|
||||
Set the following:
|
||||
|
||||
- **Retention Period**: The number of time units to retain data.
|
||||
- **Unit**: The unit of time to use in the retention period definition.
|
||||
|
||||
4. Click **{{< icon "check" >}} Create Database**.
|
||||
|
||||
## Delete a database
|
||||
|
||||
1. On the **Manage Databases** page, click **{{< icon "trash" >}}**.
|
||||
2. Confirm that you want to delete the database.
|
||||
|
||||
> [!Caution]
|
||||
> Deleting a database is a destructive action and cannot be undone.
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
---
|
||||
title: Manage InfluxDB 3 plugins with InfluxDB 3 Explorer
|
||||
description: >
|
||||
Use InfluxDB 3 Explorer to manage InfluxDB 3 processing engine plugins.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
name: Manage InfluxDB plugins
|
||||
weight: 5
|
||||
cascade:
|
||||
related:
|
||||
- /influxdb3/core/plugins/, InfluxDB 3 Core Processing engine plugins
|
||||
- /influxdb3/enterprise/plugins/, InfluxDB 3 Enterprise Processing engine plugins
|
||||
cascade:
|
||||
prepend: |
|
||||
> [!Warning]
|
||||
> #### {{% product-name %}} plugin management is currently in beta
|
||||
>
|
||||
> The {{% product-name %}} plugin management tools and the Plugin Library are
|
||||
> currently in **beta**.
|
||||
---
|
||||
|
||||
{{% product-name %}} lets you manage plugins in your InfluxDB 3 instance or cluster.
|
||||
[InfluxDB 3 Processing engine plugins](/influxdb3/enterprise/plugins/) let you
|
||||
extend your database with custom Python code.
|
||||
Use {{% product-name %}} to manage plugins in your InfluxDB 3 instance and
|
||||
install prebuilt plugins from the _Plugin Library_.
|
||||
|
||||
Each plugin can define one or more _triggers_—rules that
|
||||
specify when the plugin should execute. Triggers are typically based on
|
||||
conditions such as data arriving in a specific table or matching certain
|
||||
criteria.
|
||||
|
||||
- **Data writes** - Process and transform data as it enters the database
|
||||
- **Scheduled events** - Run code at defined intervals or specific times
|
||||
- **HTTP requests** - Expose custom API endpoints that execute your code
|
||||
|
||||
When a trigger condition is met, InfluxDB 3 automatically runs the associated
|
||||
plugin code. This enables real-time data processing, enrichment, or alerting
|
||||
without manual intervention.
|
||||
Use the InfluxDB 3 Explorer UI to enable, disable, or configure triggers for each plugin.
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [View installed plugins](#view-installed-plugins)
|
||||
- [Filter installed plugins](#filter-installed-plugins)
|
||||
- [Enable or disable a plugin](#enable-or-disable-a-plugin)
|
||||
- [ View Plugin Logs](#-view-plugin-logs)
|
||||
- [Delete a plugin](#delete-a-plugin)
|
||||
- [Use the Plugin Library](#use-the-plugin-library)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## View installed plugins
|
||||
|
||||
To view plugins installed in your InfluxDB 3 server, navigate to
|
||||
**Manage Plugins** > **Overview**.
|
||||
|
||||
1. Navigate to the **Manage Plugins** > **Overview** section in the left sidebar.
|
||||
2. All installed plugins are listed under the _All Plugins_ tab.
|
||||
|
||||
### Filter installed plugins
|
||||
|
||||
To filter installed plugins by state, use the top tabs to filter by:
|
||||
|
||||
- **All Plugins**
|
||||
- **Running**
|
||||
- **Stopped**
|
||||
- **Errors**
|
||||
|
||||
You can also use the **search bar** to filter by plugin name.
|
||||
|
||||
## Enable or disable a plugin
|
||||
|
||||
1. In the plugin list, locate the desired plugin.
|
||||
|
||||
- **If the plugin is currently running (enabled)**, click {{< icon "pause" >}} to disable the plugin.
|
||||
- **If the plugin is currently stopped (disabled)**, click the {{< icon "play" >}} button to enable the plugin.
|
||||
|
||||
## View plugin logs
|
||||
|
||||
1. In the plugin list, locate the desired plugin.
|
||||
2. Click **Logs** to view the most recent logs output by the plugin.
|
||||
3. To view more log entries, click **View More**.
|
||||
4. To export the logs, click **Export**.
|
||||
|
||||
## Delete a plugin
|
||||
|
||||
1. In the plugin list, locate the desired plugin.
|
||||
2. Click the **{{< icon "trash" >}} button** to delete the plugin.
|
||||
3. Confirm that you want to delete the plugin.
|
||||
|
||||
{{< children hlevel="h2" >}}
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
---
|
||||
title: Use the Plugin Library
|
||||
description: >
|
||||
Use InfluxDB 3 Explorer Plugin Library to view and install pre-built InfluxDB
|
||||
3 processing engine plugins.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
name: Plugin Library
|
||||
parent: Manage InfluxDB plugins
|
||||
weight: 101
|
||||
---
|
||||
|
||||
The _InfluxDB Plugin Library_ is a collection of pre-built InfluxDB 3 plugins that
|
||||
you can install in your InfluxDB 3 server. To view the Plugin library, navigate
|
||||
to **Manage Plugins** > **Plugin Library** in the left sidebar.
|
||||
|
||||
## Search the Plugin Library
|
||||
|
||||
To search for plugins in the Plugin library, submit a search term in the search bar.
|
||||
|
||||
## Install a plugin
|
||||
|
||||
1. In the **Plugin Library**, locate the plugin you want to install.
|
||||
2. Click on the plugin card to open its details.
|
||||
3. To install a plugin from {{% product-name %}} select **Install Plugin**:
|
||||
4. Provide the following:
|
||||
|
||||
- **Database**: The name of the InfluxDB 3 database to associate the
|
||||
plugin with.
|
||||
- **Trigger Name**: A unique name for the plugin and trigger combination.
|
||||
- **Trigger Type**: The trigger type. What trigger types are available
|
||||
depend on the plugin.
|
||||
|
||||
_For more information about InfluxDB 3 plugin triggers, see
|
||||
[Understand trigger types](/influxdb3/enterprise/plugins/#understand-trigger-types)._
|
||||
|
||||
Depending on the selected trigger type, provide the following:
|
||||
|
||||
- **Data Writes (All Tables)**: _no additional configuration options_.
|
||||
- **Data Writes (Single Table)**:
|
||||
- **Table Name**: The name of the table that, when written to, triggers the plugin to run.
|
||||
- **Schedule**:
|
||||
- **Frequency**: When to run the plugin using one of the following patterns:
|
||||
- `every:<duration>`: Run at specified intervals--for example:
|
||||
`every:15m`.
|
||||
- `cron:<cron-expression>`: Run on a cron schedule--for
|
||||
example: `cron:0 */12 * * *`.
|
||||
- **HTTP Endpoint**:
|
||||
- **API Endpoint**: The API endpoint name to use to trigger the plugin--for
|
||||
example: `downsample`. To trigger the plugin, you would then send
|
||||
a request to the `/api/v3/engine/downsample` endpoint of your InfluxDB
|
||||
server to trigger the plugin.
|
||||
|
||||
- **Advanced Settings**
|
||||
- **Run Asynchronously**: Execute the plugin asynchronously and do not
|
||||
wait for a response.
|
||||
- **Error Behavior**: Specify the action you want the plugin to take
|
||||
when it encounters an error:
|
||||
- **Log**: Log the error to your InfluxDB server's logs.
|
||||
- **Retry**: Retry the plugin execution.
|
||||
- **Disable**: Disable the plugin.
|
||||
|
||||
- **Arguments**: Specific arguments to pass to the Plugin.
|
||||
Plugins can have both required and optional arguments.
|
||||
|
||||
5. Click **Deploy** to install the plugin.
|
||||
|
||||
### Other plugin installation options
|
||||
|
||||
{{% product-name %}} also lets you do the following:
|
||||
|
||||
- **Download Code**: Download the plugin code to view it or modify it for your own use.
|
||||
- **Copy Install Command**: Copy the `influxdb3` CLI command you can use to
|
||||
manually install the plugin on your InfluxDB 3 server.
|
||||
|
|
@ -0,0 +1,104 @@
|
|||
---
|
||||
title: Manage tokens with InfluxDB 3 Explorer
|
||||
seotitle: Manage InfluxDB tokens with InfluxDB 3 Explorer
|
||||
description: >
|
||||
Use InfluxDB 3 Explorer to manage authorization tokens for an InfluxDB 3 instance.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
name: Manage tokens
|
||||
weight: 4
|
||||
related:
|
||||
- /influxdb3/core/admin/tokens/, Manage tokens in InfluxDB 3 Core
|
||||
- /influxdb3/enterprise/admin/tokens/, Manage tokens in InfluxDB 3 Enterprise
|
||||
---
|
||||
|
||||
{{% product-name %}} lets you manage authorization tokens for your InfluxDB 3
|
||||
Core instance or InfluxDB 3 Enterprise cluster.
|
||||
|
||||
> [!Important]
|
||||
> Using {{% product-name %}} to manage authorization tokens in InfluxDB 3 requires that
|
||||
> Explorer is running in [admin mode](/influxdb3/explorer/install/#run-in-query-or-admin-mode)
|
||||
> and that the token used in the InfluxDB 3 server configuration is an
|
||||
> [admin token](/influxdb3/enterprise/admin/tokens/admin/).
|
||||
|
||||
To manage InfluxDB authorization tokens, navigate to **Manage Tokens** in Explorer.
|
||||
This page provides a list of databases in the connected InfluxDB 3 server that
|
||||
contains the database name, retention period, and number of tables
|
||||
(which includes system tables).
|
||||
|
||||
## Create a token
|
||||
|
||||
Use {{% product-name %}} to create an admin token or a resource token
|
||||
_(Enterprise only)_ for your InfluxDB 3 instance or cluster.
|
||||
|
||||
For more information about InfluxDB tokens, see:
|
||||
|
||||
- [Manage tokens in InfluxDB 3 Core](/influxdb3/core/admin/tokens/)
|
||||
- [Manage tokens in InfluxDB 3 Enterprise](/influxdb3/enterprise/admin/tokens/)
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
[Admin Token](#)
|
||||
[Resource Token _(Enterprise only)_](#)
|
||||
{{% /tabs %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!----------------------------- BEGIN ADMIN TOKEN ----------------------------->
|
||||
|
||||
To create an _admin_ token:
|
||||
|
||||
1. On the **Manage Databases** page, click **+ Create New**.
|
||||
2. Select **Admin Token** to create an admin token.
|
||||
3. Provide a **Token Name**.
|
||||
4. Click **Create Admin Token**.
|
||||
5. Copy the generated token string and store it in a secure place.
|
||||
|
||||
<!------------------------------ END ADMIN TOKEN ------------------------------>
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
|
||||
<!---------------------------- BEGIN RESOURCE TOKEN --------------------------->
|
||||
|
||||
To create a _resource_ token with read or write permissions for specific databases:
|
||||
|
||||
1. On the **Manage Databases** page, click **+ Create New**.
|
||||
2. Select **Database Token** to create a resource token _(InfluxDB 3 Enterprise only)_.
|
||||
3. Provide a **Token Name**.
|
||||
4. _(Optional)_ Select a **Token Expiry**.
|
||||
5. Select **Database Permissions** to assign to the token.
|
||||
|
||||
To grant the token read or write permissions on all databases, select the
|
||||
_Read_ and _Write_ column headings.
|
||||
To grant permissions for specific databases, select the checkboxes next
|
||||
to each respective database name.
|
||||
|
||||
6. Copy the generated token string and store it in a secure place.
|
||||
|
||||
<!----------------------------- END RESOURCE TOKEN ---------------------------->
|
||||
|
||||
{{% /tab-content %}}
|
||||
{{< /tabs-wrapper >}}
|
||||
|
||||
> [!Note]
|
||||
> #### Store tokens in a secure secret store
|
||||
>
|
||||
> This is the _only_ time you are able to view and copy the raw token string.
|
||||
> We recommend storing tokens in a **secure secret store**.
|
||||
|
||||
|
||||
## Delete a token
|
||||
|
||||
On the **Manage Databases** page, click the **{{< icon "trash" >}}** button
|
||||
on the row of the token you want to delete.
|
||||
|
||||
> [!Caution]
|
||||
> Deleting a token is a destructive action and cannot be undone.
|
||||
> Any clients using the deleted token will no longer be able to access your
|
||||
> InfluxDB 3 instance.
|
||||
|
||||
> [!Note]
|
||||
> #### You cannot delete the _admin token
|
||||
>
|
||||
> When using InfluxDB 3 Enterprise, the first token created in the cluster is
|
||||
> named `_admin`. This functions as the "operator" token and cannot be deleted.
|
||||
|
|
@ -111,7 +111,7 @@
|
|||
<div class="products">
|
||||
<div class="product">
|
||||
<div class="product-info">
|
||||
<h3 state="beta"><a href="/influxdb3/explorer/">InfluxDB 3 Explorer</a></h3>
|
||||
<h3 state="New"><a href="/influxdb3/explorer/">InfluxDB 3 Explorer</a></h3>
|
||||
<p>A standalone UI designed for visualizing, querying, and managing data in InfluxDB 3 Core and Enterprise.</p>
|
||||
</div>
|
||||
<ul class="product-links">
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
{{ partial "article/supported-versions.html" . }}
|
||||
{{ partial "article/page-meta.html" . }}
|
||||
</div>
|
||||
{{ partial "article/beta.html" . }}
|
||||
{{ partial "article/special-state.html" . }}
|
||||
{{ partial "article/stable-version.html" . }}
|
||||
{{ partial "article/flux-experimental.html" . }}
|
||||
{{ partial "article/flux-contrib.html" . }}
|
||||
|
|
|
|||
|
|
@ -8,19 +8,23 @@
|
|||
{{ $earlyAccessList := slice "influxdb3/explorer" }}
|
||||
|
||||
{{ if in $earlyAccessList (print $product "/" $version )}}
|
||||
<div class="block beta">
|
||||
<div class="beta-content">
|
||||
<h4 id="public-beta">{{ $displayName }} is in Public Beta</h4>
|
||||
<div class="block special-state">
|
||||
<div class="state-content">
|
||||
<h4 id="influxdb3-explorer-ga">{{ $displayName }} is Generally Available</h4>
|
||||
<p>
|
||||
{{ $displayName }} is in public beta and available for testing and feedback,
|
||||
but is <strong>not meant for production use yet</strong>.
|
||||
Both the product and this documentation are works in progress.
|
||||
We welcome and encourage your input about your experience with the beta and
|
||||
{{ $displayName }} is generally available and is ready for production use.
|
||||
We welcome and encourage your input about your experience with Explorer and
|
||||
invite you to <strong>join our public channels</strong> for updates and to
|
||||
share feedback.
|
||||
</p>
|
||||
<p>
|
||||
<em>The {{ $displayName}} documentation is a work in progress, and we are actively
|
||||
working to improve it. If you have any questions or suggestions, please
|
||||
<a href="https://github.com/influxdata/docs-v2/issues/new?labels=InfluxDB%203%20Explorer">submit an issue</a>.
|
||||
We welcome any and all contributions.</em>
|
||||
</p>
|
||||
<div class="expand-wrapper">
|
||||
<div class="expand" id="beta-feedback-channels">
|
||||
<div class="expand" id="feedback-channels">
|
||||
<p class="expand-label">
|
||||
<span class="expand-toggle"></span><span>Join our public channels</span>
|
||||
</p>
|
||||
|
|
@ -60,7 +60,7 @@ Identify products by their product path. Dictionary schema:
|
|||
<li>{{ template "productLink" (merge (dict "productPath" "influxdb3/cloud-dedicated") $templateDefaults) }}</li>
|
||||
</ul>
|
||||
<ul class="item-list products" data-category="Tools">
|
||||
<li>{{ template "productLink" (merge (dict "productPath" "influxdb3/explorer" "state" "beta") $templateDefaults) }}</li>
|
||||
<li>{{ template "productLink" (merge (dict "productPath" "influxdb3/explorer" "state" "New") $templateDefaults) }}</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="product-group">
|
||||
|
|
|
|||
Loading…
Reference in New Issue