Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update content/shared/v3-core-plugins/_index.md

jts/fix-mono-get-started
Jason Stirnaman 2025-02-24 14:42:35 -06:00 committed by GitHub
parent 5976a64844
commit 4f5122da92
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/shared/v3-core-plugins/_index.md
View File

@ -396,7 +396,15 @@ def process_request(influxdb3_local, query_parameters, request_headers, request_
#### On Request trigger configuration
On-request plugins are set with a `trigger-spec` of `request:<endpoint>`. The `args` parameter can be used to pass configuration to the plugin. For example, if we wanted the above plugin to run on the endpoint `/api/v3/engine/my_plugin`, we would use `request:my_plugin` as the `trigger-spec`.
**On Request** plugins are defined using the `request:<endpoint>` trigger-spec.
For example, the following command creates an `/api/v3/engine/my_plugin` endpoint that runs a `<plugin-directory>/examples/my-on-request.py` plugin:
```bash
influxdb3 create trigger \
--trigger-spec "request:my_plugin" \
--plugin-filename "examples/my-on-request.py" \
--database mydb my-plugin
Trigger specs must be unique across all configured plugins, regardless of which database they are tied to, given the path is the same. Here's an example to create a request trigger tied to the "hello-world' path using a plugin in the plugin-dir: