The OpenTelemetry supervisor is the process that runs the OpenTelemetry collector. The supervisor's responsibilities include but are not limited to:
- Starting & stopping the collector
- Communicating to OpAMP server on behalf of the collector
- Managing the collector's config based on OpAMP messages from the OpAMP server.
- Restarting the collector if it crashes
In the case of the BDOT, a custom OTel collector built using the OpenTelemetry builder is used, the manifest for which can be found here.
The install scripts are oriented towards running the supervisor connected to an OpAMP management platform, specifically BindPlane. The supervisor acts as a middle man between BindPlane and the collector and manages the collector's config.
The supervisor's config file can be located depending on your OS:
| OS | Default Location |
|---|---|
| Linux | /opt/bindplane-otel-collector/supervisor.yaml |
| Windows | C:\Program Files\observIQ OpenTelemetry Collector\supervisor.yaml |
| macOS | /opt/bindplane-otel-collector/supervisor.yaml |
Configuration options for the supervisor can be found here.
If this model of running the collector via the supervisor and an OpAMP management platform doesn't work for your use case, you can opt to run the collector manually instead.
The collector's binary can be found depending on your OS below:
| OS | Default Location |
|---|---|
| Linux | /opt/bindplane-otel-collector/bindplane-otel-collector |
| Windows | C:\Program Files\observIQ OpenTelemetry Collector\bindplane-otel-collector.exe |
| macOS | /opt/bindplane-otel-collector/bindplane-otel-collector |
You can create an OTel configuration for the collector and run it like any other OTel collector. For more information on OTel configurations, see the OpenTelemetry docs.