All apps · 0 apps
signoz-aio
Docker app from JSONbored's Repository
Overview
SigNoz is a self-hosted observability platform for traces, metrics, and logs.
[center][color=#ff8c00]JSONbored Verified AIO Template[/color][/center]
This Unraid AIO template packages the official SigNoz Docker stack into a single container with sensible defaults for a first deployment. It internally manages SigNoz, the SigNoz OTEL collector, ClickHouse, and ZooKeeper, so you do not need to translate the upstream multi-container compose stack yourself. Advanced users can also override the metadata database and ClickHouse endpoints with supported upstream-backed settings.
All-In-One (AIO) Edition
Install it, keep the defaults, and point your OpenTelemetry senders at the published OTLP ports. Advanced settings are available for power users, but they are intentionally limited to real upstream-backed options instead of speculative extras.
Initial Setup:
- Click Apply.
- Wait for first startup to complete. This image boots multiple internal services, so the first run is heavier than a typical single-service container.
- Open the WebUI on port 8080.
- Send telemetry to OTLP gRPC on 4317 or OTLP HTTP on 4318.
- Optional: enable the built-in local host agent and explicitly fill the advanced host/Docker path fields if you want this same Unraid machine to forward host metrics, Docker metrics, and Docker logs into SigNoz.
Resource Note: ClickHouse makes SigNoz powerful, but also heavier on RAM, disk, and startup time than lighter AIO apps.
Readme
View on GitHubSigNoz Unraid Suite
This repo packages two Unraid Community Applications for SigNoz:
signoz-aio: the full self-hosted backend, UI, collector, ClickHouse, and ZooKeeper stack.signoz-agent: a lightweight OpenTelemetry Collector companion for remote hosts, stricter separation, and custom edge collection.
Both templates use the same support surface: JSONbored/signoz-aio issues.
Templates
signoz-aio
signoz-aio packages the full self-hosted SigNoz stack into a single Unraid-friendly image and CA app template.
The image follows the current official SigNoz Docker deployment instead of inventing a custom rewrite. It supervises the services SigNoz currently expects for a complete small-to-medium self-hosted install:
signozsignoz-otel-collectorclickhousezookeeper
signoz-agent
signoz-agent packages the official OpenTelemetry Collector Contrib collector as a SigNoz-focused Unraid companion app.
Use it when you want to:
- collect telemetry from remote machines and forward it to
signoz-aio - keep host/Docker mounts out of the main SigNoz backend container
- run advanced collector pipelines without replacing the backend AIO template
The agent defaults to no host root, Docker socket, or Docker log mounts. Those are advanced opt-in settings only.
What Is Inside The Image
The image includes all of the stateful pieces needed for a self-contained SigNoz install:
signoz- the main SigNoz UI and API service
- stores application metadata in an internal SQLite database persisted under
/appdata/signoz
signoz-otel-collector- receives OTLP data on
4317and4318 - runs the telemetry-store migrations SigNoz needs in ClickHouse
- receives OTLP data on
clickhouse- the primary telemetry database for traces, logs, metrics, and derived telemetry tables
zookeeper- internal coordination layer used by the official SigNoz ClickHouse deployment
The image does not require any separate Postgres, TimescaleDB, or Redis sidecars. SigNoz's long-term telemetry data lives in ClickHouse, while SigNoz's app/config metadata in this AIO image lives in SQLite.
Advanced Database Options
The default install is fully self-contained and uses:
- SQLite for SigNoz metadata
- bundled ClickHouse for telemetry storage
- bundled ZooKeeper for ClickHouse coordination
For power users, the advanced app settings also support:
- external PostgreSQL for SigNoz metadata
- root user provisioning through official SigNoz environment variables
- external ClickHouse endpoints for advanced deployments
Important limitation:
- PostgreSQL can replace SQLite for metadata
- PostgreSQL does not replace ClickHouse for traces, metrics, and logs
- if you move to external ClickHouse, you are moving into a more advanced deployment model and should already understand your ClickHouse and ZooKeeper topology
Architecture
flowchart LR
A["Apps / SDKs / Agents"] -->|"OTLP gRPC :4317"| B["signoz-otel-collector"]
A -->|"OTLP HTTP :4318"| B
B -->|"metrics / logs / traces"| C["ClickHouse"]
D["SigNoz UI/API :8080"] -->|"query + metadata reads"| C
D -->|"app metadata"| E["SQLite (/appdata/signoz/signoz.db)"]
C -->|"cluster coordination"| F["ZooKeeper"]
G["/appdata"] --> C
G --> E
G --> F
G --> H["generated.env / runtime config"]
Persistence Layout
The Unraid app intentionally keeps the mount surface simple by using one root path:
/appdata
Inside that mount, the container manages:
/appdata/clickhouse/appdata/signoz/appdata/zookeeper/appdata/config/appdata/tmp
Current Status
The single-image runtime is implemented and validated.
- the image supervises
signoz,signoz-otel-collector,clickhouse, andzookeeper linux/amd64build passes- pytest-backed Docker integration testing covers:
- first boot
- telemetry-store migrations
- OTLP listener readiness
- restart and persistence
- advanced runtime preflight paths
signoz-agenthas a separate image, template, generated collector config, and Docker-backed integration tests for forwarding, Prometheus scraping, and fail-fast security checks
First-Run Notes
- first startup is heavier than a typical single-service app because ClickHouse, ZooKeeper, SigNoz, and the collector all need to initialize
- expect more RAM and disk use than lighter AIO images
- the default setup keeps things intentionally simple:
- one
/appdataroot - one UI port
- two OTLP ingest ports
- sane advanced defaults for the collector and internal ZooKeeper housekeeping
- one
Getting Data Into SigNoz
SigNoz is only useful once something is sending telemetry into it. This image gives you ready OTLP endpoints, but it does not automatically reach out and scrape your entire server by default.
The easiest ingestion paths are:
- instrument applications with OpenTelemetry and send directly to:
http://YOUR-UNRAID-IP:4317for OTLP gRPChttp://YOUR-UNRAID-IP:4318for OTLP HTTP
- run a separate OpenTelemetry Collector or Alloy agent on the Unraid host
- run
signoz-agenton this host or another machine - configure that agent to:
- scrape Prometheus endpoints
- collect Docker container metrics
- tail Docker or file-based logs
- forward everything into this
signoz-aiocontainer
Why keep the host agent separate?
- it avoids giving the main SigNoz container broad access to the Docker socket
- it avoids mounting host
/proc,/sys, and container log directories into the main UI/database image - it keeps the AIO install safe and beginner-friendly while still giving power users a clean upgrade path
Recommended Monitoring Layout For Unraid
flowchart LR
A["Unraid host"] -->|"host metrics"| B["Optional built-in host agent"]
C["Docker containers"] -->|"docker stats + logs"| B
D["Apps with OTel SDKs"] -->|"direct OTLP or via agent"| B
E["Apps with Prometheus endpoints"] -->|"optional scrape targets"| B
B -->|"local OTLP"| F["SigNoz internal collector"]
F --> G["SigNoz UI"]
F --> H["ClickHouse + SQLite + ZooKeeper"]
For most single-host users, this is the sweet spot:
signoz-aiostays the central backend and UI- the optional built-in local host agent can handle host collection on the same Unraid machine
- instrumented apps can either send directly to SigNoz or rely on the local host agent for extra collection
For remote hosts or stricter separation, run signoz-agent and point it at the signoz-aio OTLP endpoint.
Releases
signoz-aio uses upstream-version-plus-AIO-revision releases such as v0.120.0-aio.1.
signoz-agent uses upstream-collector-version-plus-agent-revision releases such as 0.139.0-agent.1.
Every main build publishes latest, the exact pinned upstream version, an explicit packaging line tag, and sha-<commit>.
See docs/releases.md for the central release process details.
The CA templates use the Docker Hub image names:
jsonbored/signoz-aiojsonbored/signoz-agent
Quick Start Paths
1. Instrumented apps
If an app already supports OpenTelemetry, point it at:
OTEL_EXPORTER_OTLP_ENDPOINT=http://YOUR-UNRAID-IP:4317for gRPC exportersOTEL_EXPORTER_OTLP_ENDPOINT=http://YOUR-UNRAID-IP:4318for HTTP exporters
Then verify in SigNoz:
- traces appear in APM / Traces
- application metrics appear in Metrics Explorer
- application logs appear in Logs if the app also exports logs
2. Prometheus scrape targets
If an app exposes a /metrics endpoint, use a host collector to scrape it and forward to SigNoz.
Starter example:
3. Unraid host + Docker telemetry
If you want host metrics, Docker container metrics, and container logs from the same Unraid machine, enable the built-in local host agent in the app settings and explicitly fill only the advanced host/Docker path fields you want to use.
Starter example:
The built-in host agent is auto-generated from the mounts and variables you provide. A default install does not mount the host root, Docker socket, or Docker log directory. When you opt in, it can enable:
- Unraid CPU, memory, disk, and filesystem metrics
- Docker container resource metrics
- Docker stdout/stderr logs
- optional Prometheus scrape targets you define
Common explicit path values are:
- Host Root Path:
/ - Docker Socket:
/var/run/docker.sock - Docker Container Logs Path:
/var/lib/docker/containers
This is the best fit for users who want:
- one main AIO install
- minimal extra setup
- local Unraid and Docker observability without a second app
What We Recommend Newcomers Do First
- Get
signoz-aiorunning with defaults. - Verify the UI loads on port
8080. - Point one app or one collector at OTLP
4317or4318. - Confirm data appears in SigNoz.
- Only then expand into Prometheus scraping, host metrics, and container logs.
What This AIO Does Not Bundle
This image is self-contained for the SigNoz backend stack, but observability data still has to come from somewhere. It does not automatically collect telemetry from every remote host or every service you run.
That means you still need to connect senders such as:
- OpenTelemetry SDKs inside apps
- OpenTelemetry Collector agents
- Prometheus scrape pipelines
- log shippers or agent-based host collectors
The optional built-in local host agent can collect from the same Unraid machine when you explicitly populate the advanced mounts, including the Docker socket. That is useful, but it is also a security tradeoff and it does not replace proper agents for remote systems.
Docs And Examples
- Ingestion guide
- Configuration matrix
- signoz-agent component README
- Docker / host collector example
- Prometheus scrape collector example
Helpful References
- SigNoz self-host Docker docs
- SigNoz Docker Collection Agent overview
- SigNoz Docker Collection Agent configuration
- SigNoz Prometheus metrics guide
- SigNoz deployment README
- SigNoz single-binary consolidation issue
Star History
Media gallery
1 / 3Install signoz-aio on Unraid in a few clicks.
Find signoz-aio in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Requirements
Categories
Download Statistics
Related apps
Explore more like this
Explore allDetails
jsonbored/signoz-aio:latestRuntime arguments
- Web UI
http://[IP]:[PORT:8080]- Network
bridge- Shell
sh- Privileged
- false
Template configuration
Main SigNoz UI and API port.
- Target
- 8080
- Default
- 8080
- Value
- 8080
OTLP gRPC ingest port for agents, SDKs, and collectors sending telemetry into SigNoz.
- Target
- 4317
- Default
- 4317
- Value
- 4317
OTLP HTTP ingest port for telemetry senders that use HTTP instead of gRPC.
- Target
- 4318
- Default
- 4318
- Value
- 4318
Single persistent root that stores ClickHouse data, ZooKeeper state, generated config, and SigNoz SQLite metadata by default.
- Target
- /appdata
- Default
- /mnt/user/appdata/signoz-aio
- Value
- /mnt/user/appdata/signoz-aio
Advanced. Set to true to let this same container also collect local host metrics, Docker metrics, Docker logs, or Prometheus targets after you explicitly configure the host mounts or targets below.
- Target
- SIGNOZ_ENABLE_HOST_AGENT
- Default
- false|true
- Value
- false
Container timezone.
- Target
- TZ
- Default
- UTC
- Value
- UTC
Advanced. Maximum seconds the wrapper waits for SigNoz or ClickHouse readiness before failing with a clear startup error.
- Target
- SIGNOZ_AIO_WAIT_TIMEOUT_SECONDS
- Default
- 300
- Value
- 300
Advanced. Shows the upstream SigNoz startup version banner.
- Target
- SIGNOZ_VERSION_BANNER_ENABLED
- Default
- true|false
- Value
- true
Advanced. Log level for SigNoz internal instrumentation logs.
- Target
- SIGNOZ_INSTRUMENTATION_LOGS_LEVEL
- Default
- info|debug|warn|error
- Value
- info
Advanced. Enables SigNoz self-tracing; only enable when you have a clear internal telemetry target.
- Target
- SIGNOZ_INSTRUMENTATION_TRACES_ENABLED
- Default
- false|true
- Value
- false
Advanced. OTLP endpoint used by SigNoz self-tracing when internal tracing is enabled.
- Target
- SIGNOZ_INSTRUMENTATION_TRACES_PROCESSORS_BATCH_EXPORTER_OTLP_ENDPOINT
- Default
- localhost:4317
- Value
- localhost:4317
Advanced. Enables SigNoz self-metrics.
- Target
- SIGNOZ_INSTRUMENTATION_METRICS_ENABLED
- Default
- true|false
- Value
- true
Advanced. Internal Prometheus host used for SigNoz self-metrics. This port is not published by the Unraid template.
- Target
- SIGNOZ_INSTRUMENTATION_METRICS_READERS_PULL_EXPORTER_PROMETHEUS_HOST
- Default
- 0.0.0.0
- Value
- 0.0.0.0
Advanced. Internal Prometheus port used for SigNoz self-metrics. This port is not published by the Unraid template.
- Target
- SIGNOZ_INSTRUMENTATION_METRICS_READERS_PULL_EXPORTER_PROMETHEUS_PORT
- Default
- 9090
- Value
- 9090
Advanced. Public SigNoz URL used in generated links when serving through a reverse proxy.
- Target
- SIGNOZ_GLOBAL_EXTERNAL__URL
Advanced. Public ingestion endpoint URL if agents should advertise a different OTLP endpoint than the UI URL.
- Target
- SIGNOZ_GLOBAL_INGESTION__URL
Advanced. Metadata database backend for organizations, users, dashboards, and settings. Leave at sqlite for the built-in self-contained install, or set to postgres to use an external PostgreSQL database.
- Target
- SIGNOZ_SQLSTORE_PROVIDER
- Default
- sqlite|postgres
- Value
- sqlite
Advanced. SQLite file path for SigNoz metadata when the metadata DB provider is set to sqlite.
- Target
- SIGNOZ_SQLSTORE_SQLITE_PATH
- Default
- /appdata/signoz/signoz.db
- Value
- /appdata/signoz/signoz.db
Advanced. SQLite journal mode for the default metadata database.
- Target
- SIGNOZ_SQLSTORE_SQLITE_MODE
- Default
- wal|delete
- Value
- wal
Advanced. How long SQLite waits for metadata database locks before failing.
- Target
- SIGNOZ_SQLSTORE_SQLITE_BUSY__TIMEOUT
- Default
- 10s
- Value
- 10s
Advanced. SQLite transaction locking mode.
- Target
- SIGNOZ_SQLSTORE_SQLITE_TRANSACTION__MODE
- Default
- deferred|immediate|exclusive
- Value
- deferred
Advanced. Maximum open SQL metadata-store connections.
- Target
- SIGNOZ_SQLSTORE_MAX__OPEN__CONNS
- Default
- 100
- Value
- 100
Advanced. Maximum SQL metadata connection lifetime. Use 0s for no lifetime limit.
- Target
- SIGNOZ_SQLSTORE_MAX__CONN__LIFETIME
- Default
- 0s
- Value
- 0s
Advanced. PostgreSQL connection string used when SIGNOZ_SQLSTORE_PROVIDER=postgres. Example: postgres://signoz:your_password@postgres:5432/signoz?sslmode=disable
- Target
- SIGNOZ_SQLSTORE_POSTGRES_DSN
Advanced. Set to true to provision a SigNoz root admin user on startup. This works with either SQLite or PostgreSQL metadata storage.
- Target
- SIGNOZ_USER_ROOT_ENABLED
- Default
- false|true
- Value
- false
Advanced. Root user email address used when root user provisioning is enabled.
- Target
- SIGNOZ_USER_ROOT_EMAIL
Advanced. Root user password used when root user provisioning is enabled.
- Target
- SIGNOZ_USER_ROOT_PASSWORD
Advanced. Organization name for the provisioned root user.
- Target
- SIGNOZ_USER_ROOT_ORG_NAME
- Default
- default
- Value
- default
Advanced. Optional predetermined UUIDv7 for the root user's organization.
- Target
- SIGNOZ_USER_ROOT_ORG_ID
Advanced. Maximum lifetime for invitation tokens.
- Target
- SIGNOZ_USER_PASSWORD_INVITE_MAX__TOKEN__LIFETIME
- Default
- 48h
- Value
- 48h
Advanced. Allows users to request their own password reset flow.
- Target
- SIGNOZ_USER_PASSWORD_RESET_ALLOW__SELF
- Default
- false|true
- Value
- false
Advanced. Maximum lifetime for password reset tokens.
- Target
- SIGNOZ_USER_PASSWORD_RESET_MAX__TOKEN__LIFETIME
- Default
- 6h
- Value
- 6h
Advanced optional host metrics mount. Leave blank unless enabling the local host agent. Set to / only if you want to mount the Unraid host root read-only for host metrics.
- Target
- /hostfs
Advanced optional Docker metrics mount. Leave blank unless enabling Docker metrics for the local host agent. Setting this to /var/run/docker.sock grants Docker control access to this container.
- Target
- /var/run/docker.sock
Advanced optional Docker log mount. Leave blank unless enabling Docker log collection for the local host agent. Set to /var/lib/docker/containers to read local Docker JSON logs.
- Target
- /var/lib/docker/containers
Optional. Leave blank to auto-generate a persistent secret on first boot and save it under /appdata/config/generated.env.
- Target
- SIGNOZ_TOKENIZER_JWT_SECRET
Advanced. Interval for SigNoz token rotation.
- Target
- SIGNOZ_TOKENIZER_ROTATION_INTERVAL
- Default
- 30m
- Value
- 30m
Advanced. Grace duration for previous token pairs after rotation.
- Target
- SIGNOZ_TOKENIZER_ROTATION_DURATION
- Default
- 1m
- Value
- 1m
Advanced. Idle session lifetime before reauthentication.
- Target
- SIGNOZ_TOKENIZER_LIFETIME_IDLE
- Default
- 168h
- Value
- 168h
Advanced. Maximum session lifetime before reauthentication.
- Target
- SIGNOZ_TOKENIZER_LIFETIME_MAX
- Default
- 720h
- Value
- 720h
Advanced. Garbage collection interval for opaque session tokens.
- Target
- SIGNOZ_TOKENIZER_OPAQUE_GC_INTERVAL
- Default
- 1h
- Value
- 1h
Advanced. Maximum opaque tokens tracked per user when using opaque token internals.
- Target
- SIGNOZ_TOKENIZER_OPAQUE_TOKEN_MAX__PER__USER
- Default
- 5
- Value
- 5
Advanced. Set to true to disable the bundled ClickHouse and ZooKeeper services and use external ClickHouse endpoints instead. When enabled, configure the ClickHouse DSN and healthcheck URL options below.
- Target
- SIGNOZ_USE_EXTERNAL_CLICKHOUSE
- Default
- false|true
- Value
- false
Advanced. Base ClickHouse DSN used by SigNoz. Leave at the default for the bundled database, or point it at your external ClickHouse endpoint.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_DSN
- Default
- tcp://127.0.0.1:9000
- Value
- tcp://127.0.0.1:9000
Advanced. ClickHouse cluster name used by the SigNoz server for telemetry-store queries. Leave at cluster for the bundled deployment.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_CLUSTER
- Default
- cluster
- Value
- cluster
Advanced. HTTP healthcheck URL used before SigNoz and the collector start. Change this when using external ClickHouse.
- Target
- SIGNOZ_CLICKHOUSE_HEALTHCHECK_URL
- Default
- http://127.0.0.1:8123/ping
- Value
- http://127.0.0.1:8123/ping
Advanced. Maximum open ClickHouse connections used by SigNoz.
- Target
- SIGNOZ_TELEMETRYSTORE_MAX__OPEN__CONNS
- Default
- 100
- Value
- 100
Advanced. Maximum idle ClickHouse connections used by SigNoz.
- Target
- SIGNOZ_TELEMETRYSTORE_MAX__IDLE__CONNS
- Default
- 50
- Value
- 50
Advanced. ClickHouse connection dial timeout.
- Target
- SIGNOZ_TELEMETRYSTORE_DIAL__TIMEOUT
- Default
- 5s
- Value
- 5s
Advanced. Optional ClickHouse max_execution_time query setting.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_SETTINGS_MAX__EXECUTION__TIME
Advanced. Optional ClickHouse max_execution_time_leaf query setting.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_SETTINGS_MAX__EXECUTION__TIME__LEAF
Advanced. Optional ClickHouse timeout_before_checking_execution_speed query setting.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_SETTINGS_TIMEOUT__BEFORE__CHECKING__EXECUTION__SPEED
Advanced. Optional ClickHouse max_result_rows query setting.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_SETTINGS_MAX__RESULT__ROWS
Advanced. Optional ClickHouse max_bytes_to_read query setting.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_SETTINGS_MAX__BYTES__TO__READ
Advanced. Optional comma-separated ClickHouse data-skipping indices to ignore for SigNoz queries. Leave blank for the upstream default.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_SETTINGS_IGNORE__DATA__SKIPPING__INDICES
Advanced. Optional ClickHouse secondary index bulk filtering setting. Leave blank for the upstream default.
- Target
- SIGNOZ_TELEMETRYSTORE_CLICKHOUSE_SETTINGS_SECONDARY__INDICES__ENABLE__BULK__FILTERING
Advanced. Optional comma-separated Prometheus scrape targets for the built-in local host agent, for example: node-exporter:9100,cadvisor:8080.
- Target
- SIGNOZ_HOST_AGENT_PROMETHEUS_TARGETS
Advanced. Metrics path used for the built-in host agent's Prometheus scrape targets.
- Target
- SIGNOZ_HOST_AGENT_PROMETHEUS_METRICS_PATH
- Default
- /metrics
- Value
- /metrics
Advanced. Scrape interval used for Prometheus targets defined for the built-in host agent.
- Target
- SIGNOZ_HOST_AGENT_PROMETHEUS_SCRAPE_INTERVAL
- Default
- 30s
- Value
- 30s
Advanced OpenTelemetry resource attributes injected into the internal collector. Useful if you want a clearer default host or environment label.
- Target
- OTEL_RESOURCE_ATTRIBUTES
- Default
- host.name=signoz-host,os.type=linux
- Value
- host.name=signoz-host,os.type=linux
Advanced upstream collector option for ClickHouse trace exception grouping. Leave at false unless you intentionally want the alternate grouping behavior.
- Target
- LOW_CARDINAL_EXCEPTION_GROUPING
- Default
- false|true
- Value
- false
Advanced. Optional collector-specific ClickHouse base DSN override. Leave blank to inherit the main ClickHouse base DSN.
- Target
- SIGNOZ_OTEL_COLLECTOR_CLICKHOUSE_DSN
Advanced timeout used by the internal SigNoz collector for ClickHouse operations and migrations.
- Target
- SIGNOZ_OTEL_COLLECTOR_TIMEOUT
- Default
- 10m
- Value
- 10m
Advanced cluster name used by the SigNoz collector migrations. The official external ClickHouse setup requires the cluster name to remain cluster unless you know exactly what you are changing.
- Target
- SIGNOZ_OTEL_COLLECTOR_CLICKHOUSE_CLUSTER
- Default
- cluster
- Value
- cluster
Advanced replication setting used by the SigNoz collector migrations.
- Target
- SIGNOZ_OTEL_COLLECTOR_CLICKHOUSE_REPLICATION
- Default
- false|true
- Value
- false
Advanced. Optional collector DSN for traces database. Leave blank to derive from the base ClickHouse DSN.
- Target
- SIGNOZ_CLICKHOUSE_TRACES_DSN
Advanced. Optional collector DSN for metrics database. Leave blank to derive from the base ClickHouse DSN.
- Target
- SIGNOZ_CLICKHOUSE_METRICS_DSN
Advanced. Optional collector DSN for logs database. Leave blank to derive from the base ClickHouse DSN.
- Target
- SIGNOZ_CLICKHOUSE_LOGS_DSN
Advanced. Optional collector DSN for SigNoz meter database. Leave blank to derive from the base ClickHouse DSN.
- Target
- SIGNOZ_CLICKHOUSE_METER_DSN
Advanced. Optional collector DSN for telemetry metadata database. Leave blank to derive from the base ClickHouse DSN.
- Target
- SIGNOZ_CLICKHOUSE_METADATA_DSN
Advanced. OTel collector batch send size for regular telemetry pipelines.
- Target
- SIGNOZ_OTEL_COLLECTOR_BATCH_SEND_SIZE
- Default
- 10000
- Value
- 10000
Advanced. OTel collector maximum batch size for regular telemetry pipelines.
- Target
- SIGNOZ_OTEL_COLLECTOR_BATCH_SEND_MAX_SIZE
- Default
- 11000
- Value
- 11000
Advanced. OTel collector batch timeout for regular telemetry pipelines.
- Target
- SIGNOZ_OTEL_COLLECTOR_BATCH_TIMEOUT
- Default
- 10s
- Value
- 10s
Advanced. OTel collector batch send size for SigNoz meter telemetry.
- Target
- SIGNOZ_OTEL_COLLECTOR_METER_BATCH_SEND_SIZE
- Default
- 20000
- Value
- 20000
Advanced. OTel collector maximum batch size for SigNoz meter telemetry.
- Target
- SIGNOZ_OTEL_COLLECTOR_METER_BATCH_SEND_MAX_SIZE
- Default
- 25000
- Value
- 25000
Advanced. OTel collector batch timeout for SigNoz meter telemetry.
- Target
- SIGNOZ_OTEL_COLLECTOR_METER_BATCH_TIMEOUT
- Default
- 1s
- Value
- 1s
Advanced. Scrape interval for the collector's own Prometheus metrics.
- Target
- SIGNOZ_OTEL_COLLECTOR_SELF_SCRAPE_INTERVAL
- Default
- 60s
- Value
- 60s
Advanced. Internal collector pprof endpoint. This port is not published by the Unraid template.
- Target
- SIGNOZ_OTEL_COLLECTOR_PPROF_ENDPOINT
- Default
- 0.0.0.0:1777
- Value
- 0.0.0.0:1777
Advanced. Enables upstream Segment analytics if a Segment key is configured. Leave false for homelab deployments.
- Target
- SIGNOZ_ANALYTICS_ENABLED
- Default
- false|true
- Value
- false
Advanced. Privacy default: disabled. Set true only if you want to enable upstream stats reporting internals.
- Target
- SIGNOZ_STATSREPORTER_ENABLED
- Default
- false|true
- Value
- false
Advanced. Default API request timeout.
- Target
- SIGNOZ_APISERVER_TIMEOUT_DEFAULT
- Default
- 60s
- Value
- 60s
Advanced. Maximum API request timeout.
- Target
- SIGNOZ_APISERVER_TIMEOUT_MAX
- Default
- 600s
- Value
- 600s
Advanced. Comma-separated API routes excluded from request timeout handling.
- Target
- SIGNOZ_APISERVER_TIMEOUT_EXCLUDED__ROUTES
- Default
- /api/v1/logs/tail,/api/v3/logs/livetail,/api/v1/export_raw_data
- Value
- /api/v1/logs/tail,/api/v3/logs/livetail,/api/v1/export_raw_data
Advanced. Comma-separated API routes excluded from request logging.
- Target
- SIGNOZ_APISERVER_LOGGING_EXCLUDED__ROUTES
- Default
- /api/v1/health,/api/v1/version,/
- Value
- /api/v1/health,/api/v1/version,/
Advanced. TTL for cached SigNoz query results.
- Target
- SIGNOZ_QUERIER_CACHE__TTL
- Default
- 168h
- Value
- 168h
Advanced. Recent-data interval that SigNoz should not cache.
- Target
- SIGNOZ_QUERIER_FLUX__INTERVAL
- Default
- 5m
- Value
- 5m
Advanced. Maximum concurrent SigNoz queries for missing ranges.
- Target
- SIGNOZ_QUERIER_MAX__CONCURRENT__QUERIES
- Default
- 4
- Value
- 4
Advanced. Maximum time a PromQL query may run before SigNoz aborts it.
- Target
- SIGNOZ_PROMETHEUS_TIMEOUT
- Default
- 2m
- Value
- 2m
Advanced. Enables SigNoz Prometheus active query tracking.
- Target
- SIGNOZ_PROMETHEUS_ACTIVE__QUERY__TRACKER_ENABLED
- Default
- true|false
- Value
- true
Advanced. Optional path for SigNoz Prometheus active query tracking.
- Target
- SIGNOZ_PROMETHEUS_ACTIVE__QUERY__TRACKER_PATH
Advanced. Maximum concurrent Prometheus queries tracked by SigNoz.
- Target
- SIGNOZ_PROMETHEUS_ACTIVE__QUERY__TRACKER_MAX__CONCURRENT
- Default
- 20
- Value
- 20
Advanced. Enables SigNoz internal pprof endpoint inside the container. The port is not published by default.
- Target
- SIGNOZ_PPROF_ENABLED
- Default
- true|false
- Value
- true
Advanced. Internal SigNoz pprof bind address. Do not publish this unless you understand the exposure risk.
- Target
- SIGNOZ_PPROF_ADDRESS
- Default
- 0.0.0.0:6060
- Value
- 0.0.0.0:6060
Advanced. Delay applied when evaluating alerting rules.
- Target
- SIGNOZ_RULER_EVAL__DELAY
- Default
- 2m
- Value
- 2m
Advanced. Poll interval for syncing built-in SigNoz Alertmanager state from the metadata store.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_POLL__INTERVAL
- Default
- 1m
- Value
- 1m
Advanced. Comma-separated labels used by the built-in SigNoz Alertmanager route grouping.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_ROUTE_GROUP__BY
- Default
- alertname
- Value
- alertname
Advanced. Interval at which grouped alerts are resent to receivers.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_ROUTE_GROUP__INTERVAL
- Default
- 1m
- Value
- 1m
Advanced. Initial wait before sending a newly grouped alert.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_ROUTE_GROUP__WAIT
- Default
- 1m
- Value
- 1m
Advanced. Default repeat interval for the built-in SigNoz Alertmanager route.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_ROUTE_REPEAT__INTERVAL
- Default
- 4h
- Value
- 4h
Advanced. Default global resolve timeout for the built-in SigNoz Alertmanager.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_RESOLVE__TIMEOUT
- Default
- 5m
- Value
- 5m
Advanced. External URL used by alert notifications when SigNoz is behind a reverse proxy.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_EXTERNAL__URL
Advanced. Garbage collection interval for built-in Alertmanager alerts.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_ALERTS_GC__INTERVAL
- Default
- 30m
- Value
- 30m
Advanced. Maximum stored Alertmanager silences. Use 0 for no limit.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_SILENCES_MAX
- Default
- 0
- Value
- 0
Advanced. Maximum stored Alertmanager silences size in bytes. Use 0 for no limit.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_SILENCES_MAX__SIZE__BYTES
- Default
- 0
- Value
- 0
Advanced. Maintenance interval for Alertmanager silences snapshots.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_SILENCES_MAINTENANCE__INTERVAL
- Default
- 15m
- Value
- 15m
Advanced. Retention duration for Alertmanager silences.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_SILENCES_RETENTION
- Default
- 120h
- Value
- 120h
Advanced. Maintenance interval for Alertmanager notification log snapshots.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_NFLOG_MAINTENANCE__INTERVAL
- Default
- 15m
- Value
- 15m
Advanced. Retention duration for Alertmanager notification logs.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_NFLOG_RETENTION
- Default
- 120h
- Value
- 120h
Advanced. Sender address used by built-in Alertmanager email notifications.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__FROM
Advanced. HELO/EHLO hostname used by built-in Alertmanager email notifications.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__HELLO
- Default
- localhost
- Value
- localhost
Advanced. SMTP host:port used by built-in Alertmanager email notifications, for example smtp.example.com:587.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__SMARTHOST
Advanced. SMTP username used by built-in Alertmanager email notifications.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__AUTH__USERNAME
Advanced. SMTP password used by built-in Alertmanager email notifications.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__AUTH__PASSWORD
Advanced. Optional path inside the container to a file containing the SMTP password for built-in Alertmanager email notifications.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__AUTH__PASSWORD_FILE
Advanced. Optional SMTP auth secret used by built-in Alertmanager email notifications.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__AUTH__SECRET
Advanced. Optional SMTP auth identity used by built-in Alertmanager email notifications.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__AUTH__IDENTITY
Advanced. Requires TLS for built-in Alertmanager SMTP delivery. Set false only for trusted internal relays.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__REQUIRE__TLS
- Default
- true|false
- Value
- true
Advanced. Optional CA certificate file path inside the container for Alertmanager SMTP TLS.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__TLS__CA__FILE
Advanced. Optional client certificate file path inside the container for Alertmanager SMTP TLS.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__TLS__CERT__FILE
Advanced. Optional client private key file path inside the container for Alertmanager SMTP TLS.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__TLS__KEY__FILE
Advanced. Optional server name for SNI and SMTP TLS certificate verification.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__TLS__SERVER__NAME
Advanced. Skips SMTP TLS certificate verification for built-in Alertmanager email notifications. Use only for trusted internal relays.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__TLS__CONFIG_INSECURE__SKIP__VERIFY
- Default
- false|true
- Value
- false
Advanced. Optional minimum SMTP TLS version for built-in Alertmanager notifications. Leave upstream to keep the SigNoz default.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__TLS__MIN__VERSION
- Default
- upstream|TLS12|TLS13
- Value
- upstream
Advanced. Optional maximum SMTP TLS version for built-in Alertmanager notifications. Leave upstream to keep the SigNoz default.
- Target
- SIGNOZ_ALERTMANAGER_SIGNOZ_GLOBAL_SMTP__TLS__MAX__VERSION
- Default
- upstream|TLS12|TLS13
- Value
- upstream
Advanced. ClickHouse query threads used by Metrics Explorer.
- Target
- SIGNOZ_METRICSEXPLORER_TELEMETRYSTORE_THREADS
- Default
- 8
- Value
- 8
Advanced. Segment key used only when upstream analytics are enabled.
- Target
- SIGNOZ_ANALYTICS_SEGMENT_KEY
Advanced. Interval for upstream stats reporter collection when enabled.
- Target
- SIGNOZ_STATSREPORTER_INTERVAL
- Default
- 6h
- Value
- 6h
Advanced. Privacy default: disabled. Set true only if stats reporting is enabled and you accept upstream identity and trait collection.
- Target
- SIGNOZ_STATSREPORTER_COLLECT_IDENTITIES
- Default
- false|true
- Value
- false
Advanced. Enables SigNoz email delivery through SMTP. When true, set a valid SMTP from address.
- Target
- SIGNOZ_EMAILING_ENABLED
- Default
- false|true
- Value
- false
Advanced. SMTP server host:port for SigNoz emails.
- Target
- SIGNOZ_EMAILING_SMTP_ADDRESS
- Default
- localhost:25
- Value
- localhost:25
Advanced. From address for SigNoz emails.
- Target
- SIGNOZ_EMAILING_SMTP_FROM
Advanced. Optional SMTP HELO/EHLO hostname sent by SigNoz.
- Target
- SIGNOZ_EMAILING_SMTP_HELLO
Advanced. SMTP username.
- Target
- SIGNOZ_EMAILING_SMTP_AUTH_USERNAME
Advanced. SMTP password.
- Target
- SIGNOZ_EMAILING_SMTP_AUTH_PASSWORD
Advanced. Optional SMTP auth secret for mechanisms that require it.
- Target
- SIGNOZ_EMAILING_SMTP_AUTH_SECRET
Advanced. Optional SMTP auth identity for mechanisms that require it.
- Target
- SIGNOZ_EMAILING_SMTP_AUTH_IDENTITY
Advanced. Enables TLS for SMTP.
- Target
- SIGNOZ_EMAILING_SMTP_TLS_ENABLED
- Default
- false|true
- Value
- false
Advanced. Skips SMTP TLS certificate verification. Use only for trusted internal mail relays.
- Target
- SIGNOZ_EMAILING_SMTP_TLS_INSECURE__SKIP__VERIFY
- Default
- false|true
- Value
- false
Advanced. Optional CA certificate path inside the container for SMTP TLS.
- Target
- SIGNOZ_EMAILING_SMTP_TLS_CA__FILE__PATH
Advanced. Optional client certificate path inside the container for SMTP TLS.
- Target
- SIGNOZ_EMAILING_SMTP_TLS_CERT__FILE__PATH
Advanced. Optional client private key path inside the container for SMTP TLS.
- Target
- SIGNOZ_EMAILING_SMTP_TLS_KEY__FILE__PATH
Advanced. Enables a custom header block in SigNoz email templates.
- Target
- SIGNOZ_EMAILING_TEMPLATES_FORMAT_HEADER_ENABLED
- Default
- false|true
- Value
- false
Advanced. Logo URL used in SigNoz email template headers when enabled.
- Target
- SIGNOZ_EMAILING_TEMPLATES_FORMAT_HEADER_LOGO__URL
Advanced. Enables help contact text in SigNoz email templates.
- Target
- SIGNOZ_EMAILING_TEMPLATES_FORMAT_HELP_ENABLED
- Default
- false|true
- Value
- false
Advanced. Help email address shown in SigNoz email templates when enabled.
- Target
- SIGNOZ_EMAILING_TEMPLATES_FORMAT_HELP_EMAIL
Advanced. Enables a footer block in SigNoz email templates.
- Target
- SIGNOZ_EMAILING_TEMPLATES_FORMAT_FOOTER_ENABLED
- Default
- false|true
- Value
- false
Advanced. SigNoz cache provider. Leave memory for the self-contained default; set redis only when using an external Redis cache.
- Target
- SIGNOZ_CACHE_PROVIDER
- Default
- memory|redis
- Value
- memory
Advanced. Number of Ristretto in-memory cache counters.
- Target
- SIGNOZ_CACHE_MEMORY_NUM__COUNTERS
- Default
- 100000
- Value
- 100000
Advanced. Ristretto in-memory cache max cost in bytes.
- Target
- SIGNOZ_CACHE_MEMORY_MAX__COST
- Default
- 134217728
- Value
- 134217728
Advanced. External Redis host when SIGNOZ_CACHE_PROVIDER=redis.
- Target
- SIGNOZ_CACHE_REDIS_HOST
Advanced. External Redis port.
- Target
- SIGNOZ_CACHE_REDIS_PORT
- Default
- 6379
- Value
- 6379
Advanced. External Redis database number.
- Target
- SIGNOZ_CACHE_REDIS_DB
- Default
- 0
- Value
- 0
Advanced. External Redis password.
- Target
- SIGNOZ_CACHE_REDIS_PASSWORD
Advanced. Optional upstream feature flag override for span metrics. Leave upstream to keep the SigNoz default.
- Target
- SIGNOZ_FLAGGER_CONFIG_BOOLEAN_USE__SPAN__METRICS
- Default
- upstream|true|false
- Value
- upstream
Advanced. Optional upstream feature flag override for Kafka span evaluation. Leave upstream to keep the SigNoz default.
- Target
- SIGNOZ_FLAGGER_CONFIG_BOOLEAN_KAFKA__SPAN__EVAL
- Default
- upstream|true|false
- Value
- upstream
Advanced. Enables tokenizer-based identity resolution for SigNoz requests.
- Target
- SIGNOZ_IDENTN_TOKENIZER_ENABLED
- Default
- true|false
- Value
- true
Advanced. Comma-separated headers used for tokenizer identity resolution.
- Target
- SIGNOZ_IDENTN_TOKENIZER_HEADERS
- Default
- Authorization,Sec-WebSocket-Protocol
- Value
- Authorization,Sec-WebSocket-Protocol
Advanced. Enables API-key identity resolution for SigNoz requests.
- Target
- SIGNOZ_IDENTN_APIKEY_ENABLED
- Default
- true|false
- Value
- true
Advanced. Comma-separated headers used for API-key identity resolution.
- Target
- SIGNOZ_IDENTN_APIKEY_HEADERS
- Default
- SIGNOZ-API-KEY
- Value
- SIGNOZ-API-KEY
Advanced and dangerous. Impersonates the root user for all requests when enabled; leave false unless upstream support explicitly directs you to use it.
- Target
- SIGNOZ_IDENTN_IMPERSONATION_ENABLED
- Default
- false|true
- Value
- false
Advanced. Email domain used for SigNoz service account principals.
- Target
- SIGNOZ_SERVICEACCOUNT_EMAIL_DOMAIN
- Default
- signozserviceaccount.com
- Value
- signozserviceaccount.com
Advanced. Privacy default: disabled. Set true only if you want upstream service-account analytics behavior.
- Target
- SIGNOZ_SERVICEACCOUNT_ANALYTICS_ENABLED
- Default
- false|true
- Value
- false
Advanced. SigNoz gateway API URL for deployments that use licensed gateway features.
- Target
- SIGNOZ_GATEWAY_URL
- Default
- http://localhost:8080
- Value
- http://localhost:8080
Advanced. Audit event provider. Leave noop for community defaults; otlphttp exports audit events to an OTLP HTTP endpoint.
- Target
- SIGNOZ_AUDITOR_PROVIDER
- Default
- noop|otlphttp
- Value
- noop
Advanced. Async audit event channel capacity.
- Target
- SIGNOZ_AUDITOR_BUFFER__SIZE
- Default
- 1000
- Value
- 1000
Advanced. Maximum audit events per export batch.
- Target
- SIGNOZ_AUDITOR_BATCH__SIZE
- Default
- 100
- Value
- 100
Advanced. Maximum time between audit export flushes.
- Target
- SIGNOZ_AUDITOR_FLUSH__INTERVAL
- Default
- 1s
- Value
- 1s
Advanced. OTLP HTTP log endpoint used when the auditor provider is otlphttp.
- Target
- SIGNOZ_AUDITOR_OTLPHTTP_ENDPOINT
- Default
- http://localhost:4318/v1/logs
- Value
- http://localhost:4318/v1/logs
Advanced. Uses HTTP instead of HTTPS for auditor OTLP HTTP export.
- Target
- SIGNOZ_AUDITOR_OTLPHTTP_INSECURE
- Default
- false|true
- Value
- false
Advanced. Timeout for auditor OTLP HTTP export attempts.
- Target
- SIGNOZ_AUDITOR_OTLPHTTP_TIMEOUT
- Default
- 10s
- Value
- 10s
Advanced. Enables retry for transient auditor OTLP HTTP export failures.
- Target
- SIGNOZ_AUDITOR_OTLPHTTP_RETRY_ENABLED
- Default
- true|false
- Value
- true
Advanced. Initial auditor retry wait time.
- Target
- SIGNOZ_AUDITOR_OTLPHTTP_RETRY_INITIAL__INTERVAL
- Default
- 5s
- Value
- 5s
Advanced. Maximum auditor retry backoff interval.
- Target
- SIGNOZ_AUDITOR_OTLPHTTP_RETRY_MAX__INTERVAL
- Default
- 30s
- Value
- 30s
Advanced. Maximum total auditor retry time before giving up.
- Target
- SIGNOZ_AUDITOR_OTLPHTTP_RETRY_MAX__ELAPSED__TIME
- Default
- 60s
- Value
- 60s
Advanced. Upstream cloud integration agent version used by SigNoz-managed cloud integration flows.
- Target
- SIGNOZ_CLOUDINTEGRATION_AGENT_VERSION
- Default
- v0.0.8
- Value
- v0.0.8
Advanced internal housekeeping interval in hours for ZooKeeper snapshot and log cleanup. The default matches the official SigNoz Docker deployment.
- Target
- ZOO_AUTOPURGE_INTERVAL
- Default
- 1
- Value
- 1
Advanced. Enables ZooKeeper Prometheus metrics inside the container.
- Target
- ZOO_ENABLE_PROMETHEUS_METRICS
- Default
- yes|no
- Value
- yes
Advanced. Internal ZooKeeper Prometheus metrics port. This port is not published by the Unraid template.
- Target
- ZOO_PROMETHEUS_METRICS_PORT_NUMBER
- Default
- 9141
- Value
- 9141