Skip to main content

Reference: /etc/atherops/config.yaml

The agent's editable configuration. The installer writes a default version on first install. You may edit it; the agent watches the file and restarts the collector when it changes. You never write raw OpenTelemetry Collector YAML.

Default file​

# /etc/atherops/config.yaml
# Managed by atherops-otel-agent. You may edit this file; the agent
# will pick up changes and restart the collector automatically.

platform:
  url: "https://api.atherops.com"   # AtherOps platform base URL

# Credentials are written by the installer to /etc/atherops/credentials.json.
# Do not edit manually. Delete credentials.json to force re-registration.

collection:
  scrape_interval: 30s              # [remote] how often to scrape host metrics

  logs:
    journald: true                  # collect systemd journal
    files:                          # additional file log paths (glob ok)
      - /var/log/syslog
      - /var/log/app/*.log

  traces:
    enabled: true                   # [remote] enable OTLP receiver
    # grpc_port: 4317               # optional: override the OTLP gRPC port
    # http_port: 4318               # optional: override the OTLP HTTP port

ports:
  otlp_grpc: 4317                   # OTLP gRPC port apps send spans to
  otlp_http: 4318                   # OTLP HTTP port apps send spans to

Fields​

FieldTypeDefaultDescription
platform.urlstringhttps://api.atherops.comAtherOps platform base URL. Used for registration, heartbeat, and remote config.
api_urlstringfalls back to platform.urlOptional. Override only if the management API is on a separate origin.
ingest_urlstringfalls back to platform.urlOptional. Override only if the ingest backend is on a separate origin.
collection.scrape_intervalduration30s[remote] How often host metrics are collected. Go-style duration (15s, 1m).
collection.logs.journaldbooltrueCollect the systemd journal. Set false on non-systemd hosts.
collection.logs.fileslist of strings/var/log/syslog, /var/log/app/*.logFile paths to tail. Globs allowed. New lines only (start_at: end).
collection.traces.enabledbooltrue[remote] Enable the OTLP receiver for app spans.
collection.traces.grpc_portint4317Override the OTLP gRPC receiver port for this host. Takes precedence over ports.otlp_grpc when both are set.
collection.traces.http_portint4318Override the OTLP HTTP receiver port for this host. Takes precedence over ports.otlp_http when both are set.
collector.binary_pathstring/var/lib/atherops/otelcol/current/otelcol-contribPath to the active collector binary. Managed automatically; rarely set by hand.
collector.config_pathstring/var/run/atherops/otelcol.yamlWhere the agent writes the generated collector YAML.
collector.manifest_urlstringhttps://releases.atherops.com/otel-agent/manifest.jsonVersion manifest URL.
collector.install_dirstring/var/lib/atherops/otelcolBase dir for versioned collector binaries.
ports.proxyint9599Loopback auth-proxy port.
ports.prometheusint8889Collector Prometheus exporter port (scraped locally).
ports.otlp_grpcint4317OTLP gRPC receiver port (apps send spans here). Overridden by collection.traces.grpc_port when both are set.
ports.otlp_httpint4318OTLP HTTP receiver port (apps send spans here). Overridden by collection.traces.http_port when both are set.
ports.healthint13133Collector health_check port.

Fields marked # [remote] can be overridden by the platform's remote config. A value pushed from the platform takes precedence over the local one. See Versioning & updates.

Fields you will not find here​

These are intentionally not in config.yaml:

  • host_id and api_key: written to /etc/atherops/credentials.json by the installer (mode 0600, owner root). Never edit by hand. Delete the file to force re-registration.
  • The install token: it lives only during install (passed as INSTALL_TOKEN); only the derived API key is stored.
  • Raw OpenTelemetry Collector YAML: generated by the agent from this file.

Environment variable overrides​

The agent reads these env vars (set via the systemd EnvironmentFile /etc/atherops/env); they override the file values. See CLI & env.

See also​