Opentelemetry collector

Options

services.opentelemetry-collector.enable

Whether to enable opentelemetry-collector.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix

services.opentelemetry-collector.package

The OpenTelemetry Collector package to use

Type: package

Default: pkgs.opentelemetry-collector-contrib

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix

services.opentelemetry-collector.configFile

Override the configuration file used by OpenTelemetry Collector. By default, a configuration is generated from services.opentelemetry-collector.settings.

If overriding, enable the health_check extension to allow process-compose to check whether the Collector is ready. Otherwise, disable the readiness probe by setting processes.opentelemetry-collector.process-compose.readiness_probe = lib.mkForce {};.

Type: null or absolute path

Default: null

Example:

pkgs.writeTextFile { name = "otel-config.yaml"; text = "..."; }

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix

services.opentelemetry-collector.settings

OpenTelemetry Collector configuration. Refer to https://opentelemetry.io/docs/collector/configuration/ for more information on how to configure the Collector.

Type: YAML 1.1 value

Default:

{
  extensions = {
    health_check = {
      endpoint = "localhost:13133";
    };
  };
  service = {
    extensions = [
      "health_check"
    ];
  };
}

Declared by: - https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix