Skip to content

Commit 0f0bb86

Browse files
sandersonCopilotjstirnaman
authored
Manage InfluxDB 3 plugins with Explorer (#6169)
* add plugin management docs * cleanup md lint * update explorer plugin frontmatter * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent d176eea commit 0f0bb86

File tree

2 files changed

+166
-0
lines changed

2 files changed

+166
-0
lines changed

‎content/influxdb3/explorer/manage-plugins/_index.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: Manage InfluxDB 3 plugins with InfluxDB 3 Explorer
3+
description: >
4+
Use InfluxDB 3 Explorer to manage InfluxDB 3 processing engine plugins.
5+
menu:
6+
influxdb3_explorer:
7+
name: Manage InfluxDB plugins
8+
weight: 5
9+
cascade:
10+
related:
11+
- /influxdb3/core/plugins/, InfluxDB 3 Core Processing engine plugins
12+
- /influxdb3/enterprise/plugins/, InfluxDB 3 Enterprise Processing engine plugins
13+
cascade:
14+
prepend: |
15+
> [!Warning]
16+
> #### {{% product-name %}} plugin management is currently in beta
17+
>
18+
> The {{% product-name %}} plugin management tools and the Plugin Library are
19+
> currently in **beta**.
20+
---
21+
22+
{{% product-name %}} lets you manage plugins in your InfluxDB 3 instance or cluster.
23+
[InfluxDB 3 Processing engine plugins](/influxdb3/enterprise/plugins/) let you
24+
extend your database with custom Python code.
25+
Use {{% product-name %}} to manage plugins in your InfluxDB 3 instance and
26+
install prebuilt plugins from the _Plugin Library_.
27+
28+
Each plugin can define one or more _triggers_—rules that
29+
specify when the plugin should execute. Triggers are typically based on
30+
conditions such as data arriving in a specific table or matching certain
31+
criteria.
32+
33+
- **Data writes** - Process and transform data as it enters the database
34+
- **Scheduled events** - Run code at defined intervals or specific times
35+
- **HTTP requests** - Expose custom API endpoints that execute your code
36+
37+
When a trigger condition is met, InfluxDB 3 automatically runs the associated
38+
plugin code. This enables real-time data processing, enrichment, or alerting
39+
without manual intervention.
40+
Use the InfluxDB 3 Explorer UI to enable, disable, or configure triggers for each plugin.
41+
42+
<!-- TOC -->
43+
44+
- [View installed plugins](#view-installed-plugins)
45+
- [Filter installed plugins](#filter-installed-plugins)
46+
- [Enable or disable a plugin](#enable-or-disable-a-plugin)
47+
- [ View Plugin Logs](#-view-plugin-logs)
48+
- [Delete a plugin](#delete-a-plugin)
49+
- [Use the Plugin Library](#use-the-plugin-library)
50+
51+
<!-- /TOC -->
52+
53+
## View installed plugins
54+
55+
To view plugins installed in your InfluxDB 3 server, navigate to
56+
**Manage Plugins** > **Overview**.
57+
58+
1. Navigate to the **Manage Plugins** > **Overview** section in the left sidebar.
59+
2. All installed plugins are listed under the _All Plugins_ tab.
60+
61+
### Filter installed plugins
62+
63+
To filter installed plugins by state, use the top tabs to filter by:
64+
65+
- **All Plugins**
66+
- **Running**
67+
- **Stopped**
68+
- **Errors**
69+
70+
You can also use the **search bar** to filter by plugin name.
71+
72+
## Enable or disable a plugin
73+
74+
1. In the plugin list, locate the desired plugin.
75+
76+
- **If the plugin is currently running (enabled)**, click {{< icon "pause" >}} to disable the plugin.
77+
- **If the plugin is currently stopped (disabled)**, click the {{< icon "play" >}} button to enable the plugin.
78+
79+
## View plugin logs
80+
81+
1. In the plugin list, locate the desired plugin.
82+
2. Click **Logs** to view the most recent logs output by the plugin.
83+
3. To view more log entries, click **View More**.
84+
4. To export the logs, click **Export**.
85+
86+
## Delete a plugin
87+
88+
1. In the plugin list, locate the desired plugin.
89+
2. Click the **{{< icon "trash" >}} button** to delete the plugin.
90+
3. Confirm that you want to delete the plugin.
91+
92+
{{< children hlevel="h2" >}}

‎content/influxdb3/explorer/manage-plugins/plugin-library.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Use the Plugin Library
3+
description: >
4+
Use InfluxDB 3 Explorer Plugin Library to view and install pre-built InfluxDB
5+
3 processing engine plugins.
6+
menu:
7+
influxdb3_explorer:
8+
name: Plugin Library
9+
parent: Manage InfluxDB plugins
10+
weight: 101
11+
---
12+
13+
The _InfluxDB Plugin Library_ is a collection of pre-built InfluxDB 3 plugins that
14+
you can install in your InfluxDB 3 server. To view the Plugin library, navigate
15+
to **Manage Plugins** > **Plugin Library** in the left sidebar.
16+
17+
## Search the Plugin Library
18+
19+
To search for plugins in the Plugin library, submit a search term in the search bar.
20+
21+
## Install a plugin
22+
23+
1. In the **Plugin Library**, locate the plugin you want to install.
24+
2. Click on the plugin card to open its details.
25+
3. To install a plugin from {{% product-name %}} select **Install Plugin**:
26+
4. Provide the following:
27+
28+
- **Database**: The name of the InfluxDB 3 database to associate the
29+
plugin with.
30+
- **Trigger Name**: A unique name for the plugin and trigger combination.
31+
- **Trigger Type**: The trigger type. What trigger types are available
32+
depend on the plugin.
33+
34+
_For more information about InfluxDB 3 plugin triggers, see
35+
[Understand trigger types](/influxdb3/enterprise/plugins/#understand-trigger-types)._
36+
37+
Depending on the selected trigger type, provide the following:
38+
39+
- **Data Writes (All Tables)**: _no additional configuration options_.
40+
- **Data Writes (Single Table)**:
41+
- **Table Name**: The name of the table that, when written to, triggers the plugin to run.
42+
- **Schedule**:
43+
- **Frequency**: When to run the plugin using one of the following patterns:
44+
- `every:<duration>`: Run at specified intervals--for example:
45+
`every:15m`.
46+
- `cron:<cron-expression>`: Run on a cron schedule--for
47+
example: `cron:0 */12 * * *`.
48+
- **HTTP Endpoint**:
49+
- **API Endpoint**: The API endpoint name to use to trigger the plugin--for
50+
example: `downsample`. To trigger the plugin, you would then send
51+
a request to the `/api/v3/engine/downsample` endpoint of your InfluxDB
52+
server to trigger the plugin.
53+
54+
- **Advanced Settings**
55+
- **Run Asynchronously**: Execute the plugin asynchronously and do not
56+
wait for a response.
57+
- **Error Behavior**: Specify the action you want the plugin to take
58+
when it encounters an error:
59+
- **Log**: Log the error to your InfluxDB server's logs.
60+
- **Retry**: Retry the plugin execution.
61+
- **Disable**: Disable the plugin.
62+
63+
- **Arguments**: Specific arguments to pass to the Plugin.
64+
Plugins can have both required and optional arguments.
65+
66+
5. Click **Deploy** to install the plugin.
67+
68+
### Other plugin installation options
69+
70+
{{% product-name %}} also lets you do the following:
71+
72+
- **Download Code**: Download the plugin code to view it or modify it for your own use.
73+
- **Copy Install Command**: Copy the `influxdb3` CLI command you can use to
74+
manually install the plugin on your InfluxDB 3 server.

0 commit comments

Comments
 (0)