[CONFIG] Implement file configuration

[marcalff]

The spec for file configuration is shaping up, opentelemetry-cpp needs to start planning for this.

• Configuration proposal oteps#225
• Define OTEL_CONFIG_FILE environment variable opentelemetry-specification#3805
• Define OTEL_CONFIG_FILE with environment variable merge semantics opentelemetry-specification#3840
• Define OTEL_CONFIG_FILE with placeholder for new environment variable override scheme opentelemetry-specification#3850
• Define OTEL_EXPERIMENTAL_CONFIG_FILE to ignore other env vars, add env var substitution default syntax opentelemetry-specification#3948
• Add spec compliance matrix entries for file configuration opentelemetry-specification#3804
• Define sdk extension component support in file configuration opentelemetry-specification#3802
• Should file configuration merge environment variable configuration? opentelemetry-specification#3752
• Deprecate environment variables which do not interoperate with file config when ready for stabilization opentelemetry-specification#3967
• Ensure that file config has solution for platforms which contribute to config opentelemetry-specification#3966
• Tracking language implementations opentelemetry-configuration#100

Spec: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/file-configuration.md

Sub tasks:

• Define the config file format (yaml)
• Define the config file schema - experimental, see https://github.com/open-telemetry/opentelemetry-configuration
• Pick a yaml parser
  • Evaluate yaml-cpp - DO NOT USE
  • Evaluate libyaml - DO NOT USE
  • Evaluate rapidyaml - OK technically. MIT License.
  • Legal - confirm license compatibility, see Need legal review, licenses compatibility of third party dependencies with the OpenTelemetry license community#2383
  • Evaluate other choices.
• Define C++ classes for the config model
  • Propagators.
  • Traces.
  • Metrics.
  • Logs.
• Implement environment variables substitution from yaml
• Populate the C++ config model from yaml
  • Propagators.
  • Traces.
  • Metrics.
  • Logs.
• Instantiate SDK and exporter objects from the C++ config model
  • Propagators.
  • Traces.
  • Metrics.
  • Logs.
• User documentation
• Define a registry for plugin components
  • propagators
  • trace plugins
    • samplers
    • span processors
    • span exporters
  • metric plugins
    • push metric exporter
    • pull metric exporter
  • logs plugins
    • log record processors
    • log record exporters
• Populate config model from yaml, for registered third party components
  • propagators
  • trace plugins
    • samplers
    • span processors
    • span exporters
  • metric plugins
    • push metric exporter
    • pull metric exporter
  • logs plugins
    • log record processors
    • log record exporters
• Instantiate plugins from config model, for registered third party components
  • propagators
  • trace plugins
    • samplers
    • span processors
    • span exporters
  • metric plugins
    • push metric exporter
    • pull metric exporter
  • logs plugins
    • log record processors
    • log record exporters
• Third party documentation (for implementing plugins)

Related issues, found while implementing this feature:

• community
  • Need legal review, licenses compatibility of third party dependencies with the OpenTelemetry license community#2383
• opentelemetry-configuration
  • Add IdGenerator in tracer_provider opentelemetry-configuration#70
  • Improve key/value pairs in headers opentelemetry-configuration#72
  • Rename file_format to avoid confusion opentelemetry-configuration#74
  • Define schema for simple propagator opentelemetry-configuration#75
  • [EXAMPLES] Periodic exporter interval default value is inconsistent. opentelemetry-configuration#108
  • [SCHEMA] The MetricExporter schema is unsafe opentelemetry-configuration#109
  • MetricReader allows invalid configurations opentelemetry-configuration#138
  • jaeger_remote needs clarity opentelemetry-configuration#238
  • PushMetricExporter when using console, properties missing opentelemetry-configuration#242
• opentelemetry-specifications
  • [file configuration] Clarify environment variable substitution is not recursive. opentelemetry-specification#3894
  • Clarify environment variable substitution is not recursive opentelemetry-specification#3913
  • [File configuration] Alternate proposal for config.yaml, including merges opentelemetry-specification#3920
• opentelemetry-cpp
  • [BUILD] Incorrect test on ENABLE_OTLP_GRPC_SSL_MTLS_PREVIEW #2545
  • [DOC] Guidelines for new software dependencies #2552
  • [API/SDK] Provider cleanup #2664
  • [SDK] ParentBasedSampler is missing parameters #3545
  • [SDK] MetricFilter needs a new AttributeProcessor to handle IncludeExclude #3546
  • [SDK] View should not have a unit #3547
  • [SDK] Implement resource detectors #3548
• cpp-build-tools
  • [RELEASE] Make a first release cpp-build-tools#7
• rapidyaml
  • Parser regression in 0.7.0 biojppm/rapidyaml#455
  • Request: Add version number in header files biojppm/rapidyaml#458
  • GIT TAG v0.7.1 is broken biojppm/rapidyaml#468
  • TODO: Bazel support
• c4core
  • TODO: Bazel support
• bazel-central-registry
  • Add module c4core@0.2.6 bazelbuild/bazel-central-registry#5624
  • Add module biojppm/rapidyaml@0.9.0 bazelbuild/bazel-central-registry#5738

Feature implementation, merged by parts:

• [CONFIGURATION] File configuration - trace model #3467
• [CONFIGURATION] File configuration - sampler model #3468
• [CONFIGURATION] File configuration - log model #3473
• [CONFIGURATION] File configuration - metric model #3474
• [CONFIGURATION] File configuration - metric aggregation model #3502
• [CONFIGURATION] File configuration - extension model #3503
• [CONFIGURATION] File configuration - misc model #3504
• [CONFIGURATION] File configuration - yaml parser #3519
• [CONFIGURATION] File configuration - configuration parser #3520
• [CONFIGURATION] File configuration - component registry #3537
• [CONFIGURATION] File configuration - sdk builder #3550
• [CONFIGURATION] File configuration - spec version 1.0.0-rc1 #3557
• [CONFIGURATION] File configuration - ostream exporter builders #3563
• [CONFIGURATION] File configuration - prometheus exporter builder #3564
• [CONFIGURATION] File configuration - zipkin exporter builder #3565
• [CONFIGURATION] File configuration - otlp exporter builders #3566
• [CONFIGURATION] File configuration - sdk resource #3567
• [CONFIGURATION] File configuration - configuration example #3573
• [CONFIGURATION] File configuration - functional tests #3606
• [CONFIGURATION] File configuration - semantic version #3629
• [CONFIGURATION] File configuration - bazel build #3654
• [CONFIGURATION] File configuration - cmake build #3655
• [CONFIGURATION] File configuration - cmake install #3668
• [CONFIGURATION] File configuration - parser location #3705
• [CONFIGURATION] File configuration - prometheus translation #3715
• [CONFIGURATION] File configuration - tls #3726
• [CONFIGURATION] File configuration - console metric exporter #3734
• TBD, more parts to merge

[github-actions]

This issue was marked as stale due to lack of activity.