signoz-agent
Aplicación Docker from JSONbored's Repository
Visión general
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.
Requisitos
Argumentos en tiempo de ejecución
- Red
bridge- Concha
sh- Privilegiado
- false
Configuración de plantillas
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.
- Objetivo
- SIGNOZ_AGENT_ENDPOINT
Local OTLP gRPC receiver port for apps and collectors that send telemetry to this agent.
- Objetivo
- 4317
- Por defecto
- 4317
- Valor
- 4317
Local OTLP HTTP receiver port for apps and collectors that send telemetry to this agent.
- Objetivo
- 4318
- Por defecto
- 4318
- Valor
- 4318
Persistent root for generated collector configuration, status, and diagnostics.
- Objetivo
- /appdata
- Por defecto
- /mnt/user/appdata/signoz-agent
- Valor
- /mnt/user/appdata/signoz-agent
Container timezone.
- Objetivo
- TZ
- Por defecto
- UTC
- Valor
- UTC
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.
- Objetivo
- SIGNOZ_AGENT_PROTOCOL
- Por defecto
- grpc|http/protobuf
- Valor
- grpc
Advanced. Set true for plain-text or self-hosted gRPC endpoints without TLS. Set false for trusted TLS endpoints.
- Objetivo
- SIGNOZ_AGENT_INSECURE
- Por defecto
- true|false
- Valor
- true
Advanced. Optional comma-separated exporter headers in key=value form. Values are masked because headers may contain credentials.
- Objetivo
- SIGNOZ_AGENT_HEADERS
Advanced. Optional SigNoz ingestion key. This is added as the signoz-ingestion-key header and is masked.
- Objetivo
- SIGNOZ_AGENT_INGESTION_KEY
Advanced. OpenTelemetry collector log level.
- Objetivo
- SIGNOZ_AGENT_LOG_LEVEL
- Por defecto
- info|debug|warn|error
- Valor
- info
Advanced. Comma-separated resource attributes added to telemetry, for example host.name=unraid-remote,service.namespace=homelab.
- Objetivo
- SIGNOZ_AGENT_RESOURCE_ATTRIBUTES
Advanced. Optional deployment.environment resource attribute such as homelab, production, or staging.
- Objetivo
- SIGNOZ_AGENT_DEPLOYMENT_ENVIRONMENT
Advanced. Collector batch send size.
- Objetivo
- SIGNOZ_AGENT_BATCH_SEND_SIZE
- Por defecto
- 8192
- Valor
- 8192
Advanced. Collector batch timeout.
- Objetivo
- SIGNOZ_AGENT_BATCH_TIMEOUT
- Por defecto
- 5s
- Valor
- 5s
Advanced. OpenTelemetry memory limiter cap in MiB.
- Objetivo
- SIGNOZ_AGENT_MEMORY_LIMIT_MIB
- Por defecto
- 512
- Valor
- 512
Advanced. Internal OTLP gRPC receiver listen endpoint.
- Objetivo
- SIGNOZ_AGENT_OTLP_GRPC_ENDPOINT
- Por defecto
- 0.0.0.0:4317
- Valor
- 0.0.0.0:4317
Advanced. Internal OTLP HTTP receiver listen endpoint.
- Objetivo
- SIGNOZ_AGENT_OTLP_HTTP_ENDPOINT
- Por defecto
- 0.0.0.0:4318
- Valor
- 0.0.0.0:4318
Advanced. Collector health extension endpoint. This port is not published by default.
- Objetivo
- SIGNOZ_AGENT_HEALTH_ENDPOINT
- Por defecto
- 0.0.0.0:13133
- Valor
- 0.0.0.0:13133
Advanced. Enables hostmetrics collection. Requires explicitly setting the Host Root Path mount below.
- Objetivo
- SIGNOZ_AGENT_ENABLE_HOST_METRICS
- Por defecto
- false|true
- Valor
- false
Advanced optional host metrics mount. Leave blank unless host metrics are enabled. Set to / to mount the Unraid host root read-only.
- Objetivo
- /hostfs
Advanced. Host metrics collection interval.
- Objetivo
- SIGNOZ_AGENT_HOST_COLLECTION_INTERVAL
- Por defecto
- 30s
- Valor
- 30s
Advanced. Enables Docker container metrics. Requires explicitly setting the Docker Socket mount below.
- Objetivo
- SIGNOZ_AGENT_ENABLE_DOCKER_METRICS
- Por defecto
- false|true
- Valor
- false
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.
- Objetivo
- /var/run/docker.sock
Advanced. Docker metrics collection interval.
- Objetivo
- SIGNOZ_AGENT_DOCKER_COLLECTION_INTERVAL
- Por defecto
- 30s
- Valor
- 30s
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.
- Objetivo
- SIGNOZ_AGENT_DOCKER_EXCLUDED_IMAGES
Advanced. Enables Docker JSON log tailing. Requires explicitly setting the Docker Container Logs Path mount below.
- Objetivo
- SIGNOZ_AGENT_ENABLE_DOCKER_LOGS
- Por defecto
- false|true
- Valor
- false
Advanced optional Docker log mount. Leave blank unless Docker logs are enabled. Set to /var/lib/docker/containers to read local Docker JSON logs.
- Objetivo
- /var/lib/docker/containers
Advanced. Optional comma-separated Prometheus scrape targets, for example node-exporter:9100,cadvisor:8080.
- Objetivo
- SIGNOZ_AGENT_PROMETHEUS_TARGETS
Advanced. Prometheus metrics path used for all configured simple scrape targets.
- Objetivo
- SIGNOZ_AGENT_PROMETHEUS_METRICS_PATH
- Por defecto
- /metrics
- Valor
- /metrics
Advanced. Prometheus scrape interval.
- Objetivo
- SIGNOZ_AGENT_PROMETHEUS_SCRAPE_INTERVAL
- Por defecto
- 30s
- Valor
- 30s
Advanced. Use generated for the Unraid-managed config. Use custom only when mounting and managing your own collector config.
- Objetivo
- SIGNOZ_AGENT_CONFIG_MODE
- Por defecto
- generated|custom
- Valor
- generated
Advanced. Path inside the container to a custom OpenTelemetry collector config when custom config mode is enabled.
- Objetivo
- SIGNOZ_AGENT_CUSTOM_CONFIG_PATH
Categorías
Descargar estadísticas
Detalles
jsonbored/signoz-agent:latestEjecute signoz-agent en Unraid.
signoz-agent se encuentra en Community Apps para Unraid OS. Explore Unraid para crear un servidor doméstico flexible, un NAS o un laboratorio doméstico.