From eef29546d776ce0d413cfdc6ec9ba251cd5914e8 Mon Sep 17 00:00:00 2001 From: meelahme Date: Thu, 16 Oct 2025 12:02:37 -0700 Subject: [PATCH 1/8] fix(influxdb3): add python directory requirement note to plugins setup --- .../influxdb3-get-started/processing-engine.md | 3 +++ content/shared/influxdb3-plugins/_index.md | 14 ++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/content/shared/influxdb3-get-started/processing-engine.md b/content/shared/influxdb3-get-started/processing-engine.md index 009b3d4ee..cf54ca3e8 100644 --- a/content/shared/influxdb3-get-started/processing-engine.md +++ b/content/shared/influxdb3-get-started/processing-engine.md @@ -48,6 +48,9 @@ when starting the {{% product-name %}} server. `PLUGIN_DIR` is your file system location for storing [plugin](#plugin) files for the processing engine to run. +> [!Note] +> If you manually installed from tar.gz, ensure the `influxdb3` binary and `python/` directory remain in the same parent location. The install script handles this automatically. + {{% code-placeholders "PLUGIN_DIR" %}} ```bash diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index 14dace282..d127cbc73 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -34,6 +34,20 @@ 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. +> [!Important] +> #### Keep influxdb3 and python/ together +> +> The influxdb3 binary requires the adjacent `python/` directory to function. +> If you manually extract from tar.gz, keep them in the same parent directory: +> +> {{< filesystem-diagram >}} +> - your-install-location/ +> - influxdb3 +> - python/ +> {{< /filesystem-diagram >}} +> +> Add the directory (not just the binary) to your PATH. Moving only the binary will cause Python runtime errors. + {{% code-placeholders "NODE_ID|OBJECT_STORE_TYPE|PLUGIN_DIR" %}} ```bash From b2109ce005421c99bcd2d31de8fdb1f0ba8d10b5 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 16 Oct 2025 12:07:16 -0700 Subject: [PATCH 2/8] Update content/shared/influxdb3-plugins/_index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- content/shared/influxdb3-plugins/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index d127cbc73..7459735c1 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -35,7 +35,7 @@ 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. > [!Important] -> #### Keep influxdb3 and python/ together +> **Keep influxdb3 and python/ together.** > > The influxdb3 binary requires the adjacent `python/` directory to function. > If you manually extract from tar.gz, keep them in the same parent directory: From 6bcec0050aaa790cc2ab5aba5d5774fadbbac8c0 Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Thu, 16 Oct 2025 12:07:23 -0700 Subject: [PATCH 3/8] Update content/shared/influxdb3-plugins/_index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- content/shared/influxdb3-plugins/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index 7459735c1..bf1b27505 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -46,7 +46,7 @@ To activate the Processing Engine, start your {{% product-name %}} server with t > - python/ > {{< /filesystem-diagram >}} > -> Add the directory (not just the binary) to your PATH. Moving only the binary will cause Python runtime errors. +> Add the parent directory that contains both influxdb3 and python/ to your PATH; do not move the binary out of this directory. {{% code-placeholders "NODE_ID|OBJECT_STORE_TYPE|PLUGIN_DIR" %}} From e25d29a5145e7797417415da82d5431a749fe59c Mon Sep 17 00:00:00 2001 From: meelahme Date: Thu, 16 Oct 2025 12:42:07 -0700 Subject: [PATCH 4/8] fix(influxdb3): fix broken links in plugins documentation --- content/shared/influxdb3-plugins/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index bf1b27505..becaa9026 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -311,7 +311,7 @@ def process_request(influxdb3_local, query_parameters, request_headers, request_ After writing your plugin: - [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/) ## Set up a trigger @@ -592,7 +592,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. > 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 %}} From f1dc112f4319c3feec58f4e13dec25a943d8861c Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 17 Oct 2025 10:40:45 -0700 Subject: [PATCH 5/8] Update content/shared/influxdb3-get-started/processing-engine.md Co-authored-by: Scott Anderson --- content/shared/influxdb3-get-started/processing-engine.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-get-started/processing-engine.md b/content/shared/influxdb3-get-started/processing-engine.md index cf54ca3e8..954a01050 100644 --- a/content/shared/influxdb3-get-started/processing-engine.md +++ b/content/shared/influxdb3-get-started/processing-engine.md @@ -49,7 +49,7 @@ when starting the {{% product-name %}} server. the processing engine to run. > [!Note] -> If you manually installed from tar.gz, ensure the `influxdb3` binary and `python/` directory remain in the same parent location. The install script handles this automatically. +> 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" %}} From 631fb5c802e4975cbb7b23c42b75b1411075559b Mon Sep 17 00:00:00 2001 From: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com> Date: Fri, 17 Oct 2025 10:41:00 -0700 Subject: [PATCH 6/8] Update content/shared/influxdb3-plugins/_index.md Co-authored-by: Scott Anderson --- content/shared/influxdb3-plugins/_index.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index becaa9026..de65a5095 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -35,18 +35,20 @@ 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. > [!Important] -> **Keep influxdb3 and python/ together.** +> #### Keep influxdb3 and python/ together > -> The influxdb3 binary requires the adjacent `python/` directory to function. -> If you manually extract from tar.gz, keep them in the same parent directory: +> The `influxdb3` tar archive includes the `influxdb3` binary and a `python/` directory. +> If you move the `influxdb3` binary, ensure that the `influxdb3` binary and the `python/` +> directory remain together. > > {{< filesystem-diagram >}} -> - your-install-location/ +> - your-install-location/ > - influxdb3 > - python/ > {{< /filesystem-diagram >}} > -> Add the parent directory that contains both influxdb3 and python/ to your PATH; do not move the binary out of this directory. +> Add the parent directory that contains both the `influxdb3` binary and the `python/` directory +> to your system $PATH. {{% code-placeholders "NODE_ID|OBJECT_STORE_TYPE|PLUGIN_DIR" %}} From 9e767bcd63edad4a852f0a72bd28dc6bfbceecad Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 17 Oct 2025 10:55:09 -0700 Subject: [PATCH 7/8] fixing filesystem-diagram --- content/shared/influxdb3-plugins/_index.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index de65a5095..0a860f656 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -37,18 +37,15 @@ To activate the Processing Engine, start your {{% product-name %}} server with t > [!Important] > #### Keep influxdb3 and python/ together > -> The `influxdb3` tar archive includes the `influxdb3` binary and a `python/` directory. -> If you move the `influxdb3` binary, ensure that the `influxdb3` binary and the `python/` -> directory remain together. +> 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/ +> ``` > -> {{< filesystem-diagram >}} -> - your-install-location/ -> - influxdb3 -> - python/ -> {{< /filesystem-diagram >}} -> -> Add the parent directory that contains both the `influxdb3` binary and the `python/` directory -> to your system $PATH. +> 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" %}} From 059d60117c8da204736dfd870d5928934f8b06d6 Mon Sep 17 00:00:00 2001 From: meelahme Date: Fri, 17 Oct 2025 11:19:46 -0700 Subject: [PATCH 8/8] update to title in importatnt note to make it more clear --- content/shared/influxdb3-plugins/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index 0a860f656..145a34bfd 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -35,7 +35,7 @@ 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. > [!Important] -> #### Keep influxdb3 and python/ together +> #### 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: