Prophet forecasting plugin

The Prophet Forecasting Plugin enables time series forecasting for data in InfluxDB 3 Enterprise using Facebook’s Prophet library. Generate predictions for future data points based on historical patterns, including seasonality, trends, and custom events. Supports both scheduled batch forecasting and on-demand HTTP-triggered forecasts with model persistence and validation capabilities.

• Model persistence: Save and reuse trained models for consistent predictions
• Forecast validation: Built-in accuracy assessment using Mean Squared Relative Error (MSRE)
• Holiday support: Built-in holiday calendars and custom holiday configuration
• Advanced seasonality: Configurable seasonality modes and changepoint detection
• Flexible time intervals: Support for microseconds through years

Configuration

Plugin parameters may be specified as key-value pairs in the --trigger-arguments flag (CLI) or in the trigger_arguments field (API) when creating a trigger. Some plugins support TOML configuration files, which can be specified using the plugin’s config_file_path parameter.

If a plugin supports multiple trigger specifications, some parameters may depend on the trigger specification that you use.

Plugin metadata

This plugin includes a JSON metadata schema in its docstring that defines supported trigger types and configuration parameters. This metadata enables the InfluxDB 3 Explorer UI to display and configure the plugin.

Scheduled trigger parameters

Set these parameters with --trigger-arguments when creating a scheduled trigger:

HTTP request parameters

Send these parameters as JSON in the HTTP POST request body. Trigger arguments are not used by the HTTP endpoint; a JSON null means “not set”, so the default applies.

Advanced parameters

Available to both trigger types:

Notification parameters

Scheduled triggers only:

Each channel listed in senders needs its own keys (slack_webhook_url, discord_webhook_url, http_webhook_url, twilio_sid, twilio_token, twilio_from_number, twilio_to_number, and the optional *_headers). See the influxdata/notifier plugin.

TOML configuration

To use a TOML configuration file, set the PLUGIN_DIR environment variable and specify the config_file_path in the trigger arguments. This is in addition to the --plugin-dir flag when starting InfluxDB 3 Enterprise. Relative paths are resolved against the first directory that is set: PLUGIN_DIR, then INFLUXDB3_PLUGIN_DIR, then the parent of VIRTUAL_ENV. Only that directory is used — the file is not looked up in the remaining ones.

When config_file_path is set, the TOML file provides the whole configuration and inline trigger arguments are ignored. INFLUXDB3_AUTH_TOKEN from the environment still applies when influxdb3_auth_token is not set in the file. In TOML, tag_values, senders, changepoints, holiday_date_list, holiday_names and holiday_country_names can use native structures (a table or a list) instead of the inline string formats, though the inline strings are also accepted. The HTTP endpoint ignores config_file_path.

Example TOML configuration

prophet_forecasting_scheduler.toml

For more information on using TOML configuration files, see the Using TOML Configuration Files section in the influxdb3_plugins/README.md.

Software Requirements

• InfluxDB 3 Enterprise: with the Processing Engine enabled.
• Python packages:
  • influxdata-plugin-utils>=0.3.0 (configuration loading, parsing, and writing)
  • pandas (for data manipulation; 2.x and 3.x are both supported)
  • requests (for HTTP requests)
  • prophet (for time series forecasting)
• Notification Sender Plugin (optional): Required if using the senders parameter. See the influxdata/notifier plugin.

Installation steps

1. Start InfluxDB 3 Enterprise with the Processing Engine enabled (--plugin-dir /path/to/plugins):

   influxdb3 serve \
     --node-id node0 \
     --object-store file \
     --data-dir ~/.influxdb3 \
     --plugin-dir ~/.plugins

2. Install required Python packages:

   influxdb3 install package influxdata-plugin-utils
   influxdb3 install package pandas
   influxdb3 install package requests
   influxdb3 install package prophet

3. (Optional) For notifications, install the influxdata/notifier plugin and create an HTTP trigger for it.

Trigger setup

Scheduled trigger

Create a trigger for periodic forecasting:

influxdb3 create trigger \
  --database mydb \
  --path "gh:influxdata/prophet_forecasting/prophet_forecasting.py" \
  --trigger-spec "every:1d" \
  --trigger-arguments "measurement=temperature,field=value,window=30d,forecast_horizont=2d,tag_values=region:us-west.device:sensor1,target_measurement=temperature_forecast,model_mode=train,unique_suffix=20250619_v1,target_database=mydb" \
  prophet_forecast_trigger

HTTP trigger

Create a trigger for on-demand forecasting:

influxdb3 create trigger \
  --database mydb \
  --path "gh:influxdata/prophet_forecasting/prophet_forecasting.py" \
  --trigger-spec "request:forecast" \
  prophet_forecast_http_trigger

Enable triggers

influxdb3 enable trigger --database mydb prophet_forecast_trigger
influxdb3 enable trigger --database mydb prophet_forecast_http_trigger

Example usage

Example 1: Basic scheduled forecasting

Write historical data and create a forecast:

# Write historical temperature data
influxdb3 write \
  --database mydb \
  "temperature,region=us-west,device=sensor1 value=22.5"

# Create and enable the trigger
influxdb3 create trigger \
  --database mydb \
  --path "gh:influxdata/prophet_forecasting/prophet_forecasting.py" \
  --trigger-spec "every:1d" \
  --trigger-arguments "measurement=temperature,field=value,window=30d,forecast_horizont=2d,tag_values=region:us-west.device:sensor1,target_measurement=temperature_forecast,model_mode=train,unique_suffix=v1,target_database=mydb" \
  prophet_forecast

influxdb3 enable trigger --database mydb prophet_forecast

# Query forecast results (after trigger runs)
influxdb3 query \
  --database mydb \
  "SELECT time, forecast, yhat_lower, yhat_upper FROM temperature_forecast ORDER BY time DESC LIMIT 5"

Expected output

+----------------------+---------+------------+------------+
| time                 | forecast| yhat_lower | yhat_upper |
+----------------------+---------+------------+------------+
| 2025-06-21T00:00:00Z | 23.2    | 21.8       | 24.6       |
| 2025-06-20T00:00:00Z | 22.9    | 21.5       | 24.3       |
+----------------------+---------+------------+------------+

Example 2: On-demand HTTP forecasting

curl -X POST http://localhost:8181/api/v3/engine/forecast \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "measurement": "temperature",
    "field": "value",
    "forecast_horizont": "7d",
    "tag_values": {"region":"us-west","device":"sensor1"},
    "target_measurement": "temperature_forecast",
    "target_database": "mydb",
    "unique_suffix": "model_v1_20250722",
    "start_time": "2025-05-20T00:00:00Z",
    "end_time": "2025-06-19T00:00:00Z",
    "seasonality_mode": "additive",
    "changepoint_prior_scale": 0.05,
    "validation_window": "3d",
    "validation_alignment": "nearest",
    "msre_threshold": 0.05
  }'

Expected response

{"message": "[<task_id>] Forecast written to temperature_forecast"}

Example 3: Advanced forecasting with holidays

curl -X POST http://localhost:8181/api/v3/engine/forecast \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "measurement": "sales",
    "field": "revenue",
    "forecast_horizont": "30d",
    "tag_values": {"store":"main_branch"},
    "target_measurement": "revenue_forecast",
    "target_database": "mydb",
    "unique_suffix": "retail_model_v2",
    "save_mode": true,
    "start_time": "2024-01-01T00:00:00Z",
    "end_time": "2025-06-01T00:00:00Z",
    "holiday_country_names": ["US"],
    "holiday_date_list": ["2025-07-04"],
    "holiday_names": ["Independence Day"],
    "changepoints": ["2025-01-01", "2025-03-01"],
    "inferred_freq": "1D"
  }'

Output data structure

Forecast results are written to the target measurement in target_database, or to a database named default when that parameter is omitted.

Tags

• model_version: Model identifier from the unique_suffix parameter
• One tag per entry in tag_values

Fields

• forecast: Predicted value (yhat from the Prophet model)
• yhat_lower: Lower bound of the confidence interval
• yhat_upper: Upper bound of the confidence interval
• run_time: Time the forecast ran, ISO 8601 with UTC offset

Timestamp

• time: Forecast timestamp in nanoseconds

Points where a forecast value is not finite are skipped, and their count is logged as a warning.

Code overview

Files

• prophet_forecasting.py: The main plugin code containing handlers for scheduled and HTTP triggers
• prophet_forecasting_scheduler.toml: Example TOML configuration file for scheduled triggers
• requirements.txt, requirements-dev.txt: Runtime and development dependencies

Logging

Logs are stored in the trigger’s database in the system.processing_engine_logs table. To view logs:

influxdb3 query --database YOUR_DATABASE "SELECT * FROM system.processing_engine_logs WHERE trigger_name = 'prophet_forecast_trigger'"

Main functions

process_scheduled_call(influxdb3_local, call_time, args)

Handles scheduled forecasting. The training window ends at call_time - validation_window and starts at call_time - window; forecast points are written from call_time onward.

Key operations:

1. Loads and validates the configuration from the trigger arguments or the TOML file
2. Queries the historical window with the configured tag filters
3. Trains a model or loads the saved one, depending on model_mode
4. Forecasts at the resolved frequency, from one step after the last queried point up to call_time plus forecast_horizont
5. Validates the forecast when validation_window is set, and sends an alert on failure
6. Writes the forecast points

process_request(influxdb3_local, query_parameters, request_headers, request_body, args)

Handles on-demand forecasts over an explicit window. The training window is start_time to end_time - validation_window, and forecast points are written from end_time onward. Returns {"message": ...} describing the outcome.

Troubleshooting

Common issues

Issue: Model training failures

Solution: Ensure sufficient historical data points for the specified window. Verify the data contains the forecast field with numeric values; rows where the field is missing or non-numeric are dropped and counted in a warning. Set inferred_freq manually when the frequency cannot be inferred (at least three points are required); a frequency that does not move time forward, such as 0h, is rejected.

Issue: Validation failures

Solution: Review the msre_threshold setting — values that are too low cause frequent failures. Ensure the validation window holds enough data. With validation_alignment=nearest, an actual value is only compared when a forecast point falls within half a frequency step of it, and validation is skipped when nothing matches; check that inferred_freq matches the real cadence of the data.

Issue: Invalid unique_suffix

Solution: unique_suffix becomes part of the model file name and accepts up to 64 characters from letters, digits, ., _ and -.

Issue: HTTP trigger issues

Solution: Verify the JSON request body matches the expected schema. Check authentication tokens and database permissions. Ensure start_time and end_time are valid ISO 8601 values with a timezone.

Issue: Forecast results are not in the expected database

Solution: Set target_database. Without it, results are written to a database named default, which is created on the first write.

Model storage

• Location: prophet_models/ under the resolved plugin directory (PLUGIN_DIR, INFLUXDB3_PLUGIN_DIR, or the parent of VIRTUAL_ENV)
• Naming: Files named prophet_model_{unique_suffix}.json
• Writing: Models are written to a temporary file and renamed into place
• Versioning: Use descriptive unique_suffix values for model management
• Reuse: A model loaded from disk forecasts the timestamps derived from the freshly queried data, so it stays usable after the data has moved on; its coefficients still come from the data it was trained on, so the further the run is from that training window, the wider the extrapolation

Frequency support

The forecast step comes from inferred_freq or is inferred from the data. Fixed aliases (1s, 30min, 1h) and calendar aliases (D, W-SUN, MS, QS, YS) are both supported; calendar steps follow the calendar, so a monthly forecast lands on month starts. Forecast timestamps start one step after the last queried point and run until forecast_horizont past the trigger’s call time (or end_time for HTTP requests).

Time format support

Supported units for window, forecast_horizont and validation_window:

• us (microseconds), ms (milliseconds), s (seconds), min (minutes), h (hours)
• d (days), w (weeks)
• m (months ≈30.42 days), q (quarters ≈91.25 days), y (years = 365 days)

Validation process

When validation_window is set:

1. Training data: window start to window_end - validation_window
2. Validation data: window_end - validation_window to window_end
3. Actual and forecasted values are paired according to validation_alignment; nearest compares each actual value with the forecast point closest in time — at most half a frequency step away — and ignores actual values that fall outside the forecast range
4. MSRE: mean((actual - predicted)² / actual²), computed over non-zero actual values
5. Validation fails when MSRE exceeds msre_threshold or cannot be computed at all — the validation window holds no data, no actual value is close enough to a forecast point, or every actual value is zero. A failed validation withholds the forecast and sends an alert if configured

Report an issue

For plugin issues, see the Plugins repository issues page.

Find support for InfluxDB 3 Enterprise

The InfluxDB Discord server is the best place to find support for InfluxDB 3 Core and InfluxDB 3 Enterprise. For other InfluxDB versions, see the Support and feedback options.