Add config to docker image

[pavolloffay]

Signed-off-by: Pavol Loffay [email protected]

Description: <Describe what has changed.

Add examples/otel-local-config.yaml into docker image to make it easier for users to get a default config.

@tigrannajaryan could you please have a look?

Link to tracking Issue:

Updates #886

Follow up PR should add config into other distributions and add comments into the config.

Testing: < Describe what testing was performed and which tests were added.>

Tested docker build locally.

Documentation: < Describe the documentation added.>

Once this is merged I will update Docker instructions https://opentelemetry.io/docs/collector/about/ to use

docker create --name otelcol-config otelcol
docker cp otelcol-config:/config.yaml . && docker rm otelcol-config
// Edit the config.yaml
docker run  -v "${PWD}/config.yaml":/config.yaml  otelcol --config /config.yaml

[pavolloffay]

This is not nice but seems better than setting the docker context to the root of the project.

[codecov]

Codecov Report

Merging #1792 into master will decrease coverage by 0.84%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1792      +/-   ##
==========================================
- Coverage   92.38%   91.53%   -0.85%     
==========================================
  Files         258      258              
  Lines       18201    15564    -2637     
==========================================
- Hits        16815    14247    -2568     
+ Misses        972      906      -66     
+ Partials      414      411       -3     

Impacted Files	Coverage Δ
service/internal/templates.go	30.43% <0.00%> (-21.09%)	⬇️
consumer/pdatautil/pdatautil.go	73.68% <0.00%> (-7.80%)	⬇️
processor/cloningfanoutconnector.go	61.11% <0.00%> (-7.78%)	⬇️
exporter/kafkaexporter/otlp_marshaller.go	71.42% <0.00%> (-6.35%)	⬇️
...rnal/scraper/processesscraper/processes_scraper.go	80.00% <0.00%> (-5.72%)	⬇️
extension/pprofextension/pprofextension.go	57.14% <0.00%> (-5.36%)	⬇️
service/builder/extensions_builder.go	80.76% <0.00%> (-4.53%)	⬇️
...eceiver/internal/scraper/processscraper/factory.go	55.55% <0.00%> (-4.45%)	⬇️
exporter/kafkaexporter/jaeger_marshaller.go	85.71% <0.00%> (-4.29%)	⬇️
receiver/prometheusreceiver/internal/metadata.go	87.50% <0.00%> (-4.17%)	⬇️
... and 238 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 95389af...2c50a4d. Read the comment docs.

[tigrannajaryan]

@pavolloffay this merely places the example config file in the docker image so that it is available for the user as a starting point for their custom config file, right?

[pavolloffay]

Correct see the example commands in the first comment on how the config can be edited (first copy to host then edit). Or users can run it directly with log exporters for quick demo purposes.

[tigrannajaryan]

LGTM. Will wait a bit before mering to see @owais has any comments.

[owais]

Contrib docker image uses /etc/otel/config.yaml as the default path for config file. So running the following command works:

docker -v $PWD/local/:/etc/otel otelcontribcol

assuming there is a config file at ./local/config.yaml.

Can we make the following changes?

1. Change docker entrypoint and command to:

ENTRYPOINT ["/otelcol"]
CMD ["--config", "/etc/otel/config.yaml"]

2. Copy the default config file to /etc/otel/config.yaml in the image.

This would ship a default config with the collector while being consistent with the contrib image. We should probably have a default config file for contrib image as well once this is merged.

[owais]

I'm not sure about shipping the example config as the default one. I think the default config should be more or less usable out of the box and needs to be vetted more carefully compared to an example config file. Also an example config might contains a lot of stuff than we want to enable by defaults. So probably a separate dedicated default config file would be better (even if it's a 1:1 copy of example config today).

[pavolloffay]

@owais I have made the proposed changes to the dockerfile.

I think the default config should be more or less usable out of the box and needs to be vetted more carefully compared to an example config file. Also an example config might contains a lot of stuff than we want to enable by defaults. So probably a separate dedicated default config file would be better (even if it's a 1:1 copy of example config today).

The default and example configs should be both ready to run out of the box. At the moment I don't see any difference between between example and default config. Both should use sane components and document what is being used for users to understand how to change the config.

I have copied the example config to the otel dir for now.

[owais]

LGTM but let's enable OTLP in the default config file.

[owais]

I think we should enable OTLP by default. I think it should be the default or recommended receiver for all data types.

[pavolloffay]

@owais I will submit a follow-up PR to enable OTLP in the example and default configs.