InfluxDB 3 Plugins

This repository contains publicly shared plugins compatible with the InfluxDB 3 Core and InfluxDB 3 Enterprise built-in processing engine. You can install these plugins to your InfluxDB 3 Enterprise or Core instance with a single command from the influxdb3 CLI.

Description

InfluxDB 3 plugins extend the functionality of your InfluxDB instance with custom data processing, transformation, and notification capabilities. The plugin ecosystem supports three main trigger types: scheduled execution, data write events, and HTTP requests.

For more information about using plugins and triggers, see the InfluxDB 3 Get Started tutorial:

• Process data in InfluxDB 3 Core
• Process data in InfluxDB 3 Enterprise

Plugin Organization

Plugins are organized in a structured directory hierarchy that reflects their contributor or organizational grouping:

organization/
├── plugin_name/
│   ├── README.md
│   ├── plugin_name.py
│   ├── config_*.toml (optional)
│   └── plugin_library.json (for influxdata plugins)

Directory Structure Examples

influxdata/basic_transformation/basic_transformation.py
examples/schedule/system_metrics/system_metrics.py
suyashcjoshi/data-replicator/data-replicator.py

Naming Conventions

• The Python file must have the same name as its parent directory
• Use snake_case for Python files and directory names
• Plugin directories may contain additional files such as configuration templates, test data, and documentation

Plugin Installation

Install plugins using the InfluxDB 3 CLI:

# Create trigger for scheduled plugin
influxdb3 create trigger \
  --database DATABASE_NAME \
  --plugin-filename plugin_name.py \
  --trigger-spec "every:1h" \
  --trigger-arguments param1=value1 \
  trigger_name

Replace the following:

• DATABASE_NAME: the name of the database to use
• plugin_name.py: the path to the plugin file
• trigger_name: a unique name for this trigger instance

Plugin Development

Requirements

• Python 3.7 or higher
• InfluxDB 3 CLI installed and configured
• Required Python libraries (varies by plugin)

Plugin Types

1. Scheduled Plugins: Execute on time intervals

   • Implement process_scheduled_call(influxdb3_local, call_time, args)

2. Data Write Plugins: Trigger on WAL flush events

   • Implement process_writes(influxdb3_local, table_batches, args)

3. HTTP Plugins: Respond to HTTP requests

   • Implement process_http_request(influxdb3_local, request_body, args)

Development Guidelines

• Follow Google Python docstring style
• Use type hints where possible
• Include comprehensive error handling
• Support both dry-run and live execution modes
• Follow the Style Guide for documentation standards

Configuration

Plugins use TOML configuration files for parameter management:

# Required parameters
measurement = "temperature"
window = "30d"
target_measurement = "transformed_temperature"

# Optional parameters
dry_run = false
target_database = "analytics"

Configuration supports:

• Environment variable substitution via PLUGIN_DIR
• Runtime argument parsing from trigger configurations
• Both inline arguments and external configuration files

Contributing

When contributing new plugins:

1. Create a new directory under your organization/username
2. Follow the established directory structure
3. Include comprehensive documentation following the Style Guide
4. Test your plugin thoroughly before submission
5. Update the plugin library metadata if applicable
6. Submit a pull request to this repository with a clear description of changes

License

All plugins in this repository are dual licensed MIT or Apache 2 at the user's choosing, unless a LICENSE file is present in the plugin's directory.