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

Merge pull request #6465 from influxdata/fix/python-dir-requirement-6366 

fix(influxdb3): add python directory requirement note to plugins setup
pull/6419/head^2
Jameelah Mercer 2025-10-17 12:03:49 -07:00 committed by GitHub
parent f272a980ec 059d60117c
commit e17c8e1da8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
content/shared/influxdb3-get-started/processing-engine.md
View File

@ -48,6 +48,9 @@ when starting the {{% product-name %}} server.
`PLUGIN_DIR` is your file system location for storing [plugin](#plugin) files for `PLUGIN_DIR` is your file system location for storing [plugin](#plugin) files for
the processing engine to run. the processing engine to run.
> [!Note]
> If you manually installed {{% product-name %}} from a tar archive, ensure the `influxdb3` binary and `python/` directory remain in the same parent directory. The install script handles this automatically.
{{% code-placeholders "PLUGIN_DIR" %}} {{% code-placeholders "PLUGIN_DIR" %}}
<!-- pytest.mark.skip --> <!-- pytest.mark.skip -->
```bash ```bash

17
content/shared/influxdb3-plugins/_index.md
View File

@ -34,6 +34,19 @@ Once you have all the prerequisites in place, follow these steps to implement th
To activate the Processing Engine, start your {{% product-name %}} server with the `--plugin-dir` flag. This flag tells InfluxDB where to load your plugin files. To activate the Processing Engine, start your {{% product-name %}} server with the `--plugin-dir` flag. This flag tells InfluxDB where to load your plugin files.
> [!Important]
> #### Keep the influxdb3 binary with its python directory
>
> The influxdb3 binary requires the adjacent `python/` directory to function.
> If you manually extract from tar.gz, keep them in the same parent directory:
> ```
> your-install-location/
> ├── influxdb3
> └── python/
> ```
>
> Add the parent directory to your PATH; do not move the binary out of this directory.
{{% code-placeholders "NODE_ID|OBJECT_STORE_TYPE|PLUGIN_DIR" %}} {{% code-placeholders "NODE_ID|OBJECT_STORE_TYPE|PLUGIN_DIR" %}}
```bash ```bash
@ -297,7 +310,7 @@ def process_request(influxdb3_local, query_parameters, request_headers, request_
After writing your plugin: After writing your plugin:
- [Create a trigger](#use-the-create-trigger-command) to connect your plugin to database events - [Create a trigger](#use-the-create-trigger-command) to connect your plugin to database events
- [Install any Python dependencies](#install-python-dependencies) your plugin requires - [Install any Python dependencies](#manage-plugin-dependencies) your plugin requires
- Learn how to [extend plugins with the API](/influxdb3/version/extend-plugin/) - Learn how to [extend plugins with the API](/influxdb3/version/extend-plugin/)
## Set up a trigger ## Set up a trigger
@ -578,7 +591,7 @@ These examples install the specified Python package (for example, pandas) into t
> If you need to create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3. Don't use the system Python. > If you need to create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3. Don't use the system Python.
> Creating a virtual environment with the system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures. > Creating a virtual environment with the system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures.
> >
>For more information, see the [processing engine README](https://github.com/influxdata/influxdb/blob/main/README_processing_engine.md#official-builds). >For more information, see the [processing engine README](https://github.com/influxdata/influxdb/blob/main/README_processing_engine.md).
{{% /code-placeholders %}} {{% /code-placeholders %}}