Plugin library
Browse plugins for InfluxDB 3 Core. Use these plugins to extend your database functionality with custom Python code that runs on write events, schedules, or HTTP requests.
Example plugins
Start with example plugins that demonstrate common use cases.
Official plugins
Production-ready plugins developed and maintained by InfluxData.
Requirements
All plugins require:
- InfluxDB 3 Core or InfluxDB 3 Enterprise with Processing Engine enabled
- Python environment (managed automatically by InfluxDB 3)
- Appropriate trigger configuration
Plugin metadata
Plugins in this library include a JSON metadata schema in a docstring header that defines supported trigger types and configuration parameters. This metadata enables:
- the InfluxDB 3 Explorer UI to display and configure the plugin
- automated testing and validation of plugins in the repository
Using TOML Configuration Files
Many plugins in this library support using TOML configuration files to specify all plugin arguments. This is useful for complex configurations or when you want to version control your plugin settings.
Important Requirements
To use TOML configuration files, you must set the PLUGIN_DIR
environment variable in the InfluxDB 3 Core host environment. This is required in addition to the --plugin-dir
flag when starting InfluxDB 3 Core:
--plugin-dir
tells InfluxDB 3 Core where to find plugin Python filesPLUGIN_DIR
environment variable tells the plugins where to find TOML configuration files
Set up TOML Configuration
Start InfluxDB 3 Core with the PLUGIN_DIR environment variable set:
PLUGIN_DIR=~/.plugins influxdb3 serve --node-id node0 --object-store file --data-dir ~/.influxdb3 --plugin-dir ~/.plugins
Copy or create a TOML configuration file in your plugin directory:
# Example: copy a plugin's configuration template cp plugin_config_example.toml ~/.plugins/my_config.toml
Edit the TOML file to match your requirements. The TOML file should contain all the arguments defined in the plugin’s argument schema.
Create a trigger with the
config_file_path
argument: When creating a trigger, specify theconfig_file_path
argument to point to your TOML configuration file.- Specify only the filename (not the full path)
- The file must be located under
PLUGIN_DIR
influxdb3 create trigger \ --database mydb \ --plugin-filename plugin_name.py \ --trigger-spec "every:1d" \ --trigger-arguments config_file_path=my_config.toml \ my_trigger_name
For more information on using TOML configuration files, see the project README.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB 3 Core and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.