# opentelemetry-collector

## Options

### services.opentelemetry-collector.enable

Whether to enable opentelemetry-collector.

*Type:* boolean

*Default:*

```nix
false
```

*Example:*

```nix
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:*

```nix
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 the readiness probe to check whether the Collector is ready. Otherwise, disable the readiness probe by setting `processes.opentelemetry-collector.ready = lib.mkForce null;`.

*Type:* null or absolute path

*Default:*

```nix
null
```

*Example:*

```nix
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:* open submodule of (YAML 1.1 value)

*Default:*

```nix
defaultSettings
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix>