This is an automated email from the ASF dual-hosted git repository.
dominikriemer pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 8564e6c6c docs audit logging (#239)
8564e6c6c is described below
commit 8564e6c6cd4eabe1f4e80dd88bb8566dd6f8b149
Author: Jacqueline Höllig <[email protected]>
AuthorDate: Thu Oct 29 22:26:22 2026 +0100
docs audit logging (#239)
---
docs/06_configure-operate-audit-logging.md | 74 ++++++++++++++++++++++
docs/06_configure-operate-environment-variables.md | 12 ++++
website-v2/sidebars.json | 1 +
3 files changed, 87 insertions(+)
diff --git a/docs/06_configure-operate-audit-logging.md
b/docs/06_configure-operate-audit-logging.md
new file mode 100644
index 000000000..2c0855e76
--- /dev/null
+++ b/docs/06_configure-operate-audit-logging.md
@@ -0,0 +1,74 @@
+---
+id: configure-operate-audit-logging
+title: Audit Logging
+sidebar_label: Audit Logging
+---
+
+## Introduction
+
+Audit logging records selected administrative and data-management actions in
StreamPipes. It provides an operational record of those actions together with
the non-sensitive context captured for them. Audit events are written to a
dedicated InfluxDB database.
+
+Audit logging is disabled by default. Enable it only after providing a
reachable InfluxDB endpoint and credentials for the audit database.
+
+## Enable audit logging
+
+Configure the following environment variables on the StreamPipes backend
service, then restart the service. In a Docker Compose deployment, add them to
the `environment` section of the `backend` service; use the equivalent
environment-variable mechanism for Kubernetes or another deployment platform.
+
+```yaml
+environment:
+ SP_AUDIT_ENABLED: "true"
+ SP_AUDIT_INFLUX_URL: "http://localhost:8086";
+ SP_AUDIT_INFLUX_DATABASE: "audit"
+ SP_AUDIT_INFLUX_TOKEN: "sp-admin"
+ SP_AUDIT_RETENTION_SCHEDULER_CRON: "0 0 10 * * *"
+```
+
+| Variable | Purpose |
+|---|---|
+| `SP_AUDIT_ENABLED` | Enables audit logging when set to `true`. |
+| `SP_AUDIT_INFLUX_URL` | URL of the InfluxDB instance that stores audit
events. |
+| `SP_AUDIT_INFLUX_DATABASE` | Name of the database used for audit events. |
+| `SP_AUDIT_INFLUX_TOKEN` | Token used to authenticate against the audit
InfluxDB instance. Treat this value as a secret. |
+| `SP_AUDIT_RETENTION_SCHEDULER_CRON` | Six-field cron expression that
schedules the audit-retention job. The example runs it daily at 10:00. |
+
+Use an InfluxDB endpoint that is reachable from the backend container or pod.
Do not commit a real `SP_AUDIT_INFLUX_TOKEN` to a Compose file or source
repository; provide it through your deployment platform's secret-management
mechanism instead.
+
+## Recorded information
+
+Each event records the action. Where an action needs additional context,
StreamPipes captures the metadata described below. Sensitive configuration
values and credentials are intentionally not included.
+
+| Audit event | Description | Additional information tracked |
+|---|---|---|
+| `sp.export.download` | Export package downloaded | Up to 100 asset IDs,
total asset count, overwrite-existing-documents flag, and
override-broker-settings flag |
+| `sp.import.execute` | Asset import executed | Up to 100 asset IDs, total
asset count, overwrite-existing-documents flag, and override-broker-settings
flag |
+| `sp.export-provider.create` | Export provider created | Provider type |
+| `sp.export-provider.update` | Export provider updated | Provider type and
names of changed provider fields |
+| `sp.export-provider.delete` | Export provider deleted | Provider type |
+| `sp.file.upload` | File upload attempted | File type |
+| `sp.file.delete` | File deletion attempted | — |
+| `sp.mail.configuration.update` | Mail configuration updated | Names of
changed mail-configuration fields; no configuration values |
+| `sp.mail.template.update` | Mail template updated | — |
+| `sp.dataset.data.delete` | Dataset data deleted for a time range | Start and
end timestamps |
+| `sp.dataset.data.truncate` | Dataset data truncated | — |
+| `sp.dataset.drop` | Dataset dropped | — |
+| `sp.dataset.data.clear` | All dataset data cleared | — |
+| `sp.dataset.retention.configure` | Dataset retention configured | — |
+| `sp.dataset.retention.remove` | Dataset retention removed | — |
+| `sp.dataset.retention.run` | Dataset retention job executed | — |
+| `sp.dashboard.create` | Dashboard created | — |
+| `sp.dashboard.edit` | Dashboard edited | — |
+| `sp.dashboard.delete` | Dashboard deleted | — |
+| `sp.chart.create` | Chart created | — |
+| `sp.chart.edit` | Chart edited | — |
+| `sp.chart.delete` | Chart deleted | — |
+| `sp.asset.create` | Asset created | — |
+| `sp.asset.edit` | Asset edited | — |
+| `sp.asset.delete` | Asset deleted | — |
+| `sp.pipeline.create` | Pipeline creation attempted | — |
+| `sp.pipeline.start` | Pipeline start attempted | — |
+| `sp.pipeline.stop` | Pipeline stop attempted | `forced` |
+| `sp.pipeline.edit` | Pipeline edit attempted | — |
+| `sp.adapter.create` | Adapter created through Connect | Stream ID and
adapter-creation reason code; no adapter configuration or credentials |
+| `sp.adapter.start` | Adapter start attempted | — |
+| `sp.adapter.stop` | Adapter stop attempted | `forced` |
+| `sp.adapter.edit` | Adapter edit attempted | List of recorded changes |
diff --git a/docs/06_configure-operate-environment-variables.md
b/docs/06_configure-operate-environment-variables.md
index febe692be..c15f19fed 100644
--- a/docs/06_configure-operate-environment-variables.md
+++ b/docs/06_configure-operate-environment-variables.md
@@ -198,6 +198,18 @@ These variables configure file and console logging
behavior.
| `SP_LOGGING_FILE_DIR` | Core + Extensions | `logs` | Directory used for
file-based logs. |
| `SP_LOGGING_FILE_PATTERN` | Core + Extensions | `%d{yyyy-MM-dd HH:mm:ss}
%-5level %logger{36} - %msg%n` | Logback-style pattern used for file logging. |
+## Audit logging
+
+These variables configure optional audit-event storage in InfluxDB. For the
activation procedure and the list of recorded events, see [Audit
Logging](./06_configure-operate-audit-logging.md).
+
+| Env Variable Name | Scope | Default Value | Description |
+|---|---|---|---|
+| `SP_AUDIT_ENABLED` | Core | `false` | Enables audit logging. |
+| `SP_AUDIT_INFLUX_URL` | Core | Empty | URL of the InfluxDB instance used to
store audit events. |
+| `SP_AUDIT_INFLUX_DATABASE` | Core | Empty | Database used to store audit
events. |
+| `SP_AUDIT_INFLUX_TOKEN` | Core | Empty | Authentication token for the audit
InfluxDB instance. Treat this value as a secret. |
+| `SP_AUDIT_RETENTION_SCHEDULER_CRON` | Core | Empty | Six-field cron
expression used to schedule the audit-retention job. |
+
## Load management and resource balancing
These variables influence the optional load-management features and their
weighting model.
diff --git a/website-v2/sidebars.json b/website-v2/sidebars.json
index 83e2c5929..578318266 100644
--- a/website-v2/sidebars.json
+++ b/website-v2/sidebars.json
@@ -71,6 +71,7 @@
"configure-operate-deployment",
"configure-operate-tls",
"configure-operate-environment-variables",
+ "configure-operate-audit-logging",
"configure-operate-general-settings",
"configure-operate-extensions",
"configure-operate-extension-services",
