opentelemetry-collector-releases icon indicating copy to clipboard operation
opentelemetry-collector-releases copied to clipboard

Default config path changed in the contrib container image

Open pellared opened this issue 2 years ago • 5 comments

Since 0.42.0 the default config.yaml path used in the contrib container image changed from /etc/otelcol/config.yaml to /etc/otelcol-contrib/config.yaml.

As far as I understand it was done here: https://github.com/open-telemetry/opentelemetry-collector-releases/pull/43

While I have not found /etc/otelcol/config.yaml in any documentation I imagine that there may be a lot of users relying on this path.

Docker inspect dumps for reference:

pellared avatar Jan 17 '22 11:01 pellared

One more comment, similar breaking change was also introduced into base-collecto version, between 0.41.0 and 0.42.0

0.41.0: /etc/otel/config.yaml 0.42.0: /etc/otelcol/config.yaml

For details, please check https://github.com/open-telemetry/opentelemetry-collector-releases/blob/606b9299551267c8c80c818b057f08a9444458d7/distributions/otelcol/Dockerfile#L19

Kielek avatar Jan 17 '22 11:01 Kielek

This was an adjustment done to ensure that there can be two distributions running at the same time at the same node. Do you have reasons to believe this should be reverted? Or do you believe we should just document it as part of the changelog?

jpkrohling avatar Jan 17 '22 12:01 jpkrohling

For now, I think that documenting it as part of the changelog is good enough (until there are more complaints)

pellared avatar Jan 17 '22 12:01 pellared

@jpkrohling

This was an adjustment done to ensure that there can be two distributions running at the same time at the same node.

Is there any issue where this use-case is described? Seems strange for me especially that otelcol-contrib is a superset of otelcol. Why would one like to have both distributions in one container? It would only increase the image size, attack-surface etc.

pellared avatar Jan 19 '22 07:01 pellared

Because we might have other, focused distributions running on the same node. For instance, a tracing distribution, a metrics distribution, and a logging distribution. All with the smallest possible set of components for that use-case, with varying degrees of stability expectations (traces are stable, metrics almost, logs not so much).

jpkrohling avatar Jan 19 '22 13:01 jpkrohling

I am going to close this, we decided to keep this change, but we should be more careful with similar changes in the future

mx-psi avatar Jan 10 '24 15:01 mx-psi