Skip to content

Commit 683c6f9

Browse files
Jackson Newhousejstirnaman
andauthored
Apply suggestions from code review
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent 0054a9b commit 683c6f9

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

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

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -221,12 +221,32 @@ influxdb3_local.info("This is an info message with an object", obj_to_log)
221221

222222
### Trigger Settings
223223

224-
#### Run Asynchronously
225-
Triggers can be optionally configured to run asynchronously. This is enabled in the CLI via the `--run-asynchronously` flag.
226-
If this flag is set individual instances of the trigger will run simultaneously.
224+
#### Control trigger execution
227225

228-
#### Error Behavior
229-
By default, errors in a plugin will simply be _logged_, writing to the server output and the system.processing_engine_logs system table.
226+
By default, triggers run synchronously—each instance waits for previous instances to complete before executing.
227+
228+
To allow multiple instances of the same trigger to run simultaneously, configure triggers to run asynchronously:
229+
230+
```bash
231+
# Create an asynchronous trigger
232+
influx create trigger --run-asynchronously
233+
234+
#### Configure error handling
235+
#### Configure error behavior for plugins
236+
237+
The Processing engine logs all plugin errors to stdout and the `system.processing_engine_logs` system table.
238+
239+
To configure additional error handling for a trigger, use the `--error-behavior` flag:
240+
241+
- `--error-behavior retry`: Attempt to run the plugin again immediately after an error
242+
- `--error-behavior disable`: Automatically disable the plugin when an error occurs (can be re-enabled later via CLI)
243+
244+
```bash
245+
# Create a trigger that retries on error
246+
influx create trigger --error-behavior retry
247+
248+
# Create a trigger that disables the plugin on error
249+
influx create trigger --error-behavior disable
230250
This behavior can be changed by specifying the "Error behavior", via the `--error-behavior` flag. Apart from the default `log`, you may set
231251
232252
* `--error-behavior retry` will immediately retry the plugin trigger in the event of error.
@@ -401,7 +421,7 @@ influxdb3 create trigger \
401421

402422
On Request plugins are triggered by a request to a custom HTTP API endpoint.
403423
The plugin receives the shared API, query parameters `Dict[str, str]`, request headers `Dict[str, str]`, the request body (as bytes), and any arguments passed in the trigger definition.
404-
The response conventions for On Request plugins follows Flask conventions, as detailed [here](https://flask.palletsprojects.com/en/stable/quickstart/#about-responses).
424+
On Request plugin responses follow conventions for [Flask responses](https://flask.palletsprojects.com/en/stable/quickstart/#about-responses).
405425

406426
#### Example: On Request plugin
407427

0 commit comments

Comments
 (0)