signoz-agent

概述

SigNoz Agent is a lightweight OpenTelemetry collector companion for signoz-aio.
[center][color=#ff8c00]JSONbored Verified Companion Template[/color][/center]

This Unraid template runs a separate collector that can receive local application telemetry, scrape optional Prometheus targets, collect optional host metrics, collect optional Docker metrics, and tail optional Docker container logs before forwarding telemetry to your main SigNoz endpoint.

When to use this:
Use signoz-agent on remote Unraid servers, separate Docker hosts, or any machine where you want collection separated from the main signoz-aio backend. If you only need same-box collection on the server running signoz-aio, the built-in local host agent inside signoz-aio is usually simpler.

Initial Setup:

Enter your SigNoz OTLP endpoint. For signoz-aio on another host, use HOST_OR_IP:4317 with the default gRPC exporter.
Click Apply.
Point local apps at this agent on OTLP gRPC port 4317 or OTLP HTTP port 4318.
Optional: enable host metrics, Docker metrics, Docker logs, or Prometheus targets in Advanced View and explicitly set the matching mounts or target list.

Security Note: Host root, Docker socket, and Docker log mounts are blank by default. Enable only the collection sources you need. Docker socket access can expose Docker control access to this collector container.

要求

Requires a reachable SigNoz OTLP endpoint, usually your main signoz-aio instance or a remote SigNoz deployment. If signoz-agent is installed on the same Unraid host as signoz-aio, the default 4317 and 4318 host ports will conflict unless one template is adjusted. Host root, Docker socket, and Docker log mounts are blank by default; explicitly configure only the host access you need. Mounting /var/run/docker.sock can expose Docker control access to the collector container.

运行时参数

网络: bridge
外壳: sh
特权: false

模板配置

SigNoz OTLP EndpointVariable

Required. Destination SigNoz OTLP endpoint. For signoz-aio on another host with the default gRPC exporter, use HOST_OR_IP:4317. For HTTP/protobuf, use an http:// or https:// endpoint ending at the OTLP HTTP listener.

目标: SIGNOZ_AGENT_ENDPOINT

OTLP gRPC PortPorttcp

Local OTLP gRPC receiver port for apps and collectors that send telemetry to this agent.

目标: 4317
默认值: 4317
价值: 4317

OTLP HTTP PortPorttcp

Local OTLP HTTP receiver port for apps and collectors that send telemetry to this agent.

目标: 4318
默认值: 4318
价值: 4318

AppData - SigNoz AgentPathrw

Persistent root for generated collector configuration, status, and diagnostics.

目标: /appdata
默认值: /mnt/user/appdata/signoz-agent
价值: /mnt/user/appdata/signoz-agent

TimezoneVariable

Container timezone.

目标: TZ
默认值: UTC
价值: UTC

[Exporter] ProtocolVariable

Advanced. Export protocol used to forward telemetry to SigNoz. Use grpc for signoz-aio 4317 and http/protobuf for SigNoz Cloud or 4318-style endpoints.

目标: SIGNOZ_AGENT_PROTOCOL
默认值: grpc|http/protobuf
价值: grpc

[Exporter] Insecure TLSVariable

Advanced. Set true for plain-text or self-hosted gRPC endpoints without TLS. Set false for trusted TLS endpoints.

目标: SIGNOZ_AGENT_INSECURE
默认值: true|false
价值: true

[Exporter] HeadersVariable

Advanced. Optional comma-separated exporter headers in key=value form. Values are masked because headers may contain credentials.

目标: SIGNOZ_AGENT_HEADERS

[Exporter] SigNoz Ingestion KeyVariable

Advanced. Optional SigNoz ingestion key. This is added as the signoz-ingestion-key header and is masked.

目标: SIGNOZ_AGENT_INGESTION_KEY

[Collector] Log LevelVariable

Advanced. OpenTelemetry collector log level.

目标: SIGNOZ_AGENT_LOG_LEVEL
默认值: info|debug|warn|error
价值: info

[Collector] Resource AttributesVariable

Advanced. Comma-separated resource attributes added to telemetry, for example host.name=unraid-remote,service.namespace=homelab.

目标: SIGNOZ_AGENT_RESOURCE_ATTRIBUTES

[Collector] Deployment EnvironmentVariable

Advanced. Optional deployment.environment resource attribute such as homelab, production, or staging.

目标: SIGNOZ_AGENT_DEPLOYMENT_ENVIRONMENT

[Collector] Batch Send SizeVariable

Advanced. Collector batch send size.

目标: SIGNOZ_AGENT_BATCH_SEND_SIZE
默认值: 8192
价值: 8192

[Collector] Batch TimeoutVariable

Advanced. Collector batch timeout.

目标: SIGNOZ_AGENT_BATCH_TIMEOUT
默认值: 5s
价值: 5s

[Collector] Memory Limit MiBVariable

Advanced. OpenTelemetry memory limiter cap in MiB.

目标: SIGNOZ_AGENT_MEMORY_LIMIT_MIB
默认值: 512
价值: 512

[Receiver] gRPC Listen EndpointVariable

Advanced. Internal OTLP gRPC receiver listen endpoint.

目标: SIGNOZ_AGENT_OTLP_GRPC_ENDPOINT
默认值: 0.0.0.0:4317
价值: 0.0.0.0:4317

[Receiver] HTTP Listen EndpointVariable

Advanced. Internal OTLP HTTP receiver listen endpoint.

目标: SIGNOZ_AGENT_OTLP_HTTP_ENDPOINT
默认值: 0.0.0.0:4318
价值: 0.0.0.0:4318

[Receiver] Health EndpointVariable

Advanced. Collector health extension endpoint. This port is not published by default.

目标: SIGNOZ_AGENT_HEALTH_ENDPOINT
默认值: 0.0.0.0:13133
价值: 0.0.0.0:13133

[Host Metrics] EnableVariable

Advanced. Enables hostmetrics collection. Requires explicitly setting the Host Root Path mount below.

目标: SIGNOZ_AGENT_ENABLE_HOST_METRICS
默认值: false|true
价值: false

[Host Metrics] Host Root PathPathro

Advanced optional host metrics mount. Leave blank unless host metrics are enabled. Set to / to mount the Unraid host root read-only.

目标: /hostfs

[Host Metrics] Collection IntervalVariable

Advanced. Host metrics collection interval.

目标: SIGNOZ_AGENT_HOST_COLLECTION_INTERVAL
默认值: 30s
价值: 30s

[Docker Metrics] EnableVariable

Advanced. Enables Docker container metrics. Requires explicitly setting the Docker Socket mount below.

目标: SIGNOZ_AGENT_ENABLE_DOCKER_METRICS
默认值: false|true
价值: false

[Docker Metrics] Docker SocketPathro

Advanced optional Docker metrics mount. Leave blank unless Docker metrics are enabled. Mounting /var/run/docker.sock can expose Docker control access to this collector container.

目标: /var/run/docker.sock

[Docker Metrics] Collection IntervalVariable

Advanced. Docker metrics collection interval.

目标: SIGNOZ_AGENT_DOCKER_COLLECTION_INTERVAL
默认值: 30s
价值: 30s

[Docker Metrics] Excluded ImagesVariable

Advanced. Optional comma-separated image names to exclude from docker_stats collection, for example pause,otel/opentelemetry-collector-contrib. Container-name-specific exclusions require custom config mode.

目标: SIGNOZ_AGENT_DOCKER_EXCLUDED_IMAGES

[Docker Logs] EnableVariable

Advanced. Enables Docker JSON log tailing. Requires explicitly setting the Docker Container Logs Path mount below.

目标: SIGNOZ_AGENT_ENABLE_DOCKER_LOGS
默认值: false|true
价值: false

[Docker Logs] Docker Container Logs PathPathro

Advanced optional Docker log mount. Leave blank unless Docker logs are enabled. Set to /var/lib/docker/containers to read local Docker JSON logs.

目标: /var/lib/docker/containers

[Prometheus] TargetsVariable

Advanced. Optional comma-separated Prometheus scrape targets, for example node-exporter:9100,cadvisor:8080.

目标: SIGNOZ_AGENT_PROMETHEUS_TARGETS

[Prometheus] Metrics PathVariable

Advanced. Prometheus metrics path used for all configured simple scrape targets.

目标: SIGNOZ_AGENT_PROMETHEUS_METRICS_PATH
默认值: /metrics
价值: /metrics

[Prometheus] Scrape IntervalVariable

Advanced. Prometheus scrape interval.

目标: SIGNOZ_AGENT_PROMETHEUS_SCRAPE_INTERVAL
默认值: 30s
价值: 30s

[Custom Config] ModeVariable

Advanced. Use generated for the Unraid-managed config. Use custom only when mounting and managing your own collector config.

目标: SIGNOZ_AGENT_CONFIG_MODE
默认值: generated|custom
价值: generated

[Custom Config] Config PathVariable

Advanced. Path inside the container to a custom OpenTelemetry collector config when custom config mode is enabled.

目标: SIGNOZ_AGENT_CUSTOM_CONFIG_PATH

类别

Network > Management Tools > Utilities

下载统计数据

1,502

下载总数

链接

模板支持 Docker Hub Pro连接

详细信息

存储库

jsonbored/signoz-agent:latest

登记处

https://hub.docker.com/r/jsonbored/signoz-agent

最后更新2026-05-28

初见2026-05-01

在Unraid 上运行 signoz-agent 。

signoz-agent 已被列入Unraid OS 的社区应用程序。探索Unraid ，构建灵活的家庭服务器、NAS 或家庭实验室。

探索Unraid OS