Skip to content

Commit 46b4665

Browse files
committed
Merge branch 'docs/5823-write-lp-guide' of github.com:influxdata/docs-v2 into docs/5823-write-lp-guide
2 parents 59db904 + b689ccb commit 46b4665

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

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

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The Processing engine provides four types of plugins and triggers--each type cor
3535
- **On Request**: Bound to the HTTP API `/api/v3/engine/<CUSTOM_PATH>` endpoint and triggered by a GET or POST request to the endpoint.
3636

3737
## Activate the Processing engine
38-
To enable the Processing engine, start the {{% product-name %}} server with the --plugin-dir argument and a path to your plugins directory (it doesn't need to exist yet)--for example:
38+
To enable the Processing engine, start the {{% product-name %}} server with the `--plugin-dir` option and a path to your plugins directory (it doesn't need to exist yet)--for example:
3939

4040
```bash
4141
influxdb3 serve --node-id node0 --plugin-dir /path/to/plugins
@@ -244,6 +244,7 @@ Use the `influxdb3 install` command to download and install Python packages that
244244

245245
```bash
246246
influxdb3 install package <PACKAGE_NAME>
247+
```
247248

248249
### Use `influxdb3 install` with Docker
249250

@@ -316,7 +317,10 @@ For a WAL flush trigger you specify a `trigger-spec`, which determines when the
316317
The following example creates a WAL flush trigger for the `gh:examples/wal_plugin/wal_plugin.py` plugin.
317318

318319
```bash
319-
influxdb3 create trigger --trigger-spec "table:TABLE_NAME" --plugin-filename "gh:examples/wal_plugin/wal_plugin.py" --database DATABASE_NAME TRIGGER_NAME
320+
influxdb3 create trigger \
321+
--trigger-spec "table:TABLE_NAME" \
322+
--plugin-filename "gh:examples/wal_plugin/wal_plugin.py" \
323+
--database DATABASE_NAME TRIGGER_NAME
320324
```
321325

322326
The `gh:` prefix lets you fetch a plugin file directly from the [influxdata/influxdb3_plugins](https://github.com/influxdata/influxdb3_plugins) repository in GitHub.
@@ -350,7 +354,10 @@ def process_scheduled_call(influxdb3_local, time, args=None):
350354
Schedule plugins are set with a `trigger-spec` of `schedule:<cron_expression>` or `every:<duration>`. The `args` parameter can be used to pass configuration to the plugin. For example, if we wanted to use the system-metrics example from the Github repo and have it collect every 10 seconds we could use the following trigger definition:
351355

352356
```shell
353-
influxdb3 create trigger --trigger-spec "every:10s" --plugin-filename "gh:examples/schedule/system_metrics/system_metrics.py" --database mydb system-metrics
357+
influxdb3 create trigger \
358+
--trigger-spec "every:10s" \
359+
--plugin-filename "gh:examples/schedule/system_metrics/system_metrics.py" \
360+
--database mydb system-metrics
354361
```
355362

356363
## On Request Plugin
@@ -385,5 +392,8 @@ On Request plugins are set with a `trigger-spec` of `request:<endpoint>`. The `a
385392
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:
386393

387394
```shell
388-
influxdb3 create trigger --trigger-spec "request:hello-world" --plugin-filename "hellp/hello_world.py" --database mydb hello-world
395+
influxdb3 create trigger \
396+
--trigger-spec "request:hello-world" \
397+
--plugin-filename "hellp/hello_world.py" \
398+
--database mydb hello-world
389399
```

0 commit comments

Comments
 (0)