[CONFIGURATION] File configuration - spec version 1.0.0-rc1 (open-telemetry#3557)

marcalff · web-flow · commit dbd06801eb76 · 2025-07-24T21:10:19.000+02:00
diff --git a/sdk/include/opentelemetry/sdk/configuration/extension_metric_producer_configuration.h b/sdk/include/opentelemetry/sdk/configuration/extension_metric_producer_configuration.h
@@ -0,0 +1,34 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <memory>
+#include <string>
+
+#include "opentelemetry/sdk/configuration/document_node.h"
+#include "opentelemetry/sdk/configuration/metric_producer_configuration.h"
+#include "opentelemetry/sdk/configuration/metric_producer_configuration_visitor.h"
+#include "opentelemetry/version.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace sdk
+{
+namespace configuration
+{
+
+class ExtensionMetricProducerConfiguration : public MetricProducerConfiguration
+{
+public:
+  void Accept(MetricProducerConfigurationVisitor *visitor) const override
+  {
+    visitor->VisitExtension(this);
+  }
+
+  std::string name;
+  std::unique_ptr<DocumentNode> node;
+};
+
+}  // namespace configuration
+}  // namespace sdk
+OPENTELEMETRY_END_NAMESPACE
diff --git a/sdk/include/opentelemetry/sdk/configuration/metric_producer_configuration_visitor.h b/sdk/include/opentelemetry/sdk/configuration/metric_producer_configuration_visitor.h
@@ -0,0 +1,34 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "opentelemetry/version.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace sdk
+{
+namespace configuration
+{
+
+class OpenCensusMetricProducerConfiguration;
+class ExtensionMetricProducerConfiguration;
+
+class MetricProducerConfigurationVisitor
+{
+public:
+  MetricProducerConfigurationVisitor()                                                 = default;
+  MetricProducerConfigurationVisitor(MetricProducerConfigurationVisitor &&)            = default;
+  MetricProducerConfigurationVisitor(const MetricProducerConfigurationVisitor &)       = default;
+  MetricProducerConfigurationVisitor &operator=(MetricProducerConfigurationVisitor &&) = default;
+  MetricProducerConfigurationVisitor &operator=(const MetricProducerConfigurationVisitor &other) =
+      default;
+  virtual ~MetricProducerConfigurationVisitor() = default;
+
+  virtual void VisitOpenCensus(const OpenCensusMetricProducerConfiguration *model) = 0;
+  virtual void VisitExtension(const ExtensionMetricProducerConfiguration *model)   = 0;
+};
+
+}  // namespace configuration
+}  // namespace sdk
+OPENTELEMETRY_END_NAMESPACE
diff --git a/sdk/include/opentelemetry/sdk/configuration/open_census_metric_producer_configuration.h b/sdk/include/opentelemetry/sdk/configuration/open_census_metric_producer_configuration.h
@@ -0,0 +1,31 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <string>
+
+#include "opentelemetry/sdk/configuration/metric_producer_configuration.h"
+#include "opentelemetry/sdk/configuration/metric_producer_configuration_visitor.h"
+#include "opentelemetry/version.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace sdk
+{
+namespace configuration
+{
+
+// YAML-SCHEMA: schema/meter_provider.json
+// YAML-NODE: OpenCensusMetricProducer
+class OpenCensusMetricProducerConfiguration : public MetricProducerConfiguration
+{
+public:
+  void Accept(MetricProducerConfigurationVisitor *visitor) const override
+  {
+    visitor->VisitOpenCensus(this);
+  }
+};
+
+}  // namespace configuration
+}  // namespace sdk
+OPENTELEMETRY_END_NAMESPACE
diff --git a/sdk/include/opentelemetry/sdk/configuration/propagator_configuration.h b/sdk/include/opentelemetry/sdk/configuration/propagator_configuration.h
@@ -20,6 +20,7 @@ class PropagatorConfiguration
 {
 public:
   std::vector<std::string> composite;
+  std::string composite_list;
 };
 
 }  // namespace configuration
diff --git a/sdk/src/configuration/configuration_parser.cc b/sdk/src/configuration/configuration_parser.cc
@@ -37,6 +37,7 @@
 #include "opentelemetry/sdk/configuration/explicit_bucket_histogram_aggregation_configuration.h"
 #include "opentelemetry/sdk/configuration/extension_log_record_exporter_configuration.h"
 #include "opentelemetry/sdk/configuration/extension_log_record_processor_configuration.h"
+#include "opentelemetry/sdk/configuration/extension_metric_producer_configuration.h"
 #include "opentelemetry/sdk/configuration/extension_pull_metric_exporter_configuration.h"
 #include "opentelemetry/sdk/configuration/extension_push_metric_exporter_configuration.h"
 #include "opentelemetry/sdk/configuration/extension_sampler_configuration.h"
@@ -55,7 +56,9 @@
 #include "opentelemetry/sdk/configuration/log_record_processor_configuration.h"
 #include "opentelemetry/sdk/configuration/logger_provider_configuration.h"
 #include "opentelemetry/sdk/configuration/meter_provider_configuration.h"
+#include "opentelemetry/sdk/configuration/metric_producer_configuration.h"
 #include "opentelemetry/sdk/configuration/metric_reader_configuration.h"
+#include "opentelemetry/sdk/configuration/open_census_metric_producer_configuration.h"
 #include "opentelemetry/sdk/configuration/otlp_file_log_record_exporter_configuration.h"
 #include "opentelemetry/sdk/configuration/otlp_file_push_metric_exporter_configuration.h"
 #include "opentelemetry/sdk/configuration/otlp_file_span_exporter_configuration.h"
@@ -691,7 +694,7 @@ static std::unique_ptr<PullMetricExporterConfiguration> ParsePullMetricExporterC
     throw InvalidSchemaException(message);
   }
 
-  if (name == "prometheus")
+  if (name == "prometheus/development")
   {
     model = ParsePrometheusPullMetricExporterConfiguration(child);
   }
@@ -703,6 +706,61 @@ static std::unique_ptr<PullMetricExporterConfiguration> ParsePullMetricExporterC
   return model;
 }
 
+static std::unique_ptr<OpenCensusMetricProducerConfiguration>
+ParseOpenCensusMetricProducerConfiguration(const std::unique_ptr<DocumentNode> & /* node */)
+{
+  auto model = std::make_unique<OpenCensusMetricProducerConfiguration>();
+
+  return model;
+}
+
+static std::unique_ptr<ExtensionMetricProducerConfiguration>
+ParseExtensionMetricProducerConfiguration(const std::string &name,
+                                          std::unique_ptr<DocumentNode> node)
+{
+  auto model = std::make_unique<ExtensionMetricProducerConfiguration>();
+
+  model->name = name;
+  model->node = std::move(node);
+
+  return model;
+}
+
+static std::unique_ptr<MetricProducerConfiguration> ParseMetricProducerConfiguration(
+    const std::unique_ptr<DocumentNode> &node)
+{
+  std::unique_ptr<MetricProducerConfiguration> model;
+
+  std::string name;
+  std::unique_ptr<DocumentNode> child;
+  size_t count = 0;
+
+  for (auto it = node->begin_properties(); it != node->end_properties(); ++it)
+  {
+    name  = it.Name();
+    child = it.Value();
+    count++;
+  }
+
+  if (count != 1)
+  {
+    std::string message("Illegal metric producer, properties count: ");
+    message.append(std::to_string(count));
+    throw InvalidSchemaException(message);
+  }
+
+  if (name == "opencensus")
+  {
+    model = ParseOpenCensusMetricProducerConfiguration(child);
+  }
+  else
+  {
+    model = ParseExtensionMetricProducerConfiguration(name, std::move(child));
+  }
+
+  return model;
+}
+
 static std::unique_ptr<PeriodicMetricReaderConfiguration> ParsePeriodicMetricReaderConfiguration(
     const std::unique_ptr<DocumentNode> &node)
 {
@@ -715,6 +773,16 @@ static std::unique_ptr<PeriodicMetricReaderConfiguration> ParsePeriodicMetricRea
   child           = node->GetRequiredChildNode("exporter");
   model->exporter = ParsePushMetricExporterConfiguration(child);
 
+  child = node->GetChildNode("producers");
+
+  if (child)
+  {
+    for (auto it = child->begin(); it != child->end(); ++it)
+    {
+      model->producers.push_back(ParseMetricProducerConfiguration(*it));
+    }
+  }
+
   return model;
 }
 
@@ -727,6 +795,16 @@ static std::unique_ptr<PullMetricReaderConfiguration> ParsePullMetricReaderConfi
   child           = node->GetRequiredChildNode("exporter");
   model->exporter = ParsePullMetricExporterConfiguration(child);
 
+  child = node->GetChildNode("producers");
+
+  if (child)
+  {
+    for (auto it = child->begin(); it != child->end(); ++it)
+    {
+      model->producers.push_back(ParseMetricProducerConfiguration(*it));
+    }
+  }
+
   return model;
 }
 
@@ -1031,17 +1109,41 @@ static std::unique_ptr<PropagatorConfiguration> ParsePropagatorConfiguration(
   auto model = std::make_unique<PropagatorConfiguration>();
 
   std::unique_ptr<DocumentNode> child;
-  child = node->GetRequiredChildNode("composite");
+  child = node->GetChildNode("composite");
+  std::string name;
+  int num_child = 0;
 
-  for (auto it = child->begin(); it != child->end(); ++it)
+  if (child)
   {
-    std::unique_ptr<DocumentNode> element(*it);
-
-    std::string name = element->AsString();
-
-    model->composite.push_back(name);
+    for (auto it = child->begin(); it != child->end(); ++it)
+    {
+      // This is an entry in the composite array
+      std::unique_ptr<DocumentNode> element(*it);
+      num_child++;
+      int count = 0;
+
+      // Find out its name, we expect an object with a unique property.
+      for (auto it2 = element->begin_properties(); it2 != element->end_properties(); ++it2)
+      {
+        name = it2.Name();
+        count++;
+      }
+
+      if (count != 1)
+      {
+        std::string message("Illegal composite child ");
+        message.append(std::to_string(num_child));
+        message.append(", properties count: ");
+        message.append(std::to_string(count));
+        throw InvalidSchemaException(message);
+      }
+
+      model->composite.push_back(name);
+    }
   }
 
+  model->composite_list = node->GetString("composite_list", "");
+
   return model;
 }
 
diff --git a/sdk/src/configuration/sdk_builder.cc b/sdk/src/configuration/sdk_builder.cc
@@ -1061,21 +1061,87 @@ SdkBuilder::CreateTextMapPropagator(const std::string &name) const
   throw UnsupportedException(die);
 }
 
+static bool IsDuplicate(const std::vector<std::string> &propagator_seen, const std::string &name)
+{
+  bool duplicate = false;
+  for (const auto &seen : propagator_seen)
+  {
+    if (name == seen)
+    {
+      duplicate = true;
+    }
+  }
+
+  return duplicate;
+}
+
 std::unique_ptr<opentelemetry::context::propagation::TextMapPropagator>
 SdkBuilder::CreatePropagator(
     const std::unique_ptr<opentelemetry::sdk::configuration::PropagatorConfiguration> &model) const
 {
+  std::unique_ptr<opentelemetry::context::propagation::CompositePropagator> sdk;
   std::vector<std::unique_ptr<opentelemetry::context::propagation::TextMapPropagator>> propagators;
   std::unique_ptr<opentelemetry::context::propagation::TextMapPropagator> propagator;
+  std::vector<std::string> propagator_seen;
+  bool duplicate = false;
+
+  /*
+   * Note that the spec only requires to check duplicates between
+   * composite and composite_list.
+   * Here we check for duplicates globally, for ease of use.
+   */
 
   for (const auto &name : model->composite)
   {
-    propagator = CreateTextMapPropagator(name);
-    propagators.push_back(std::move(propagator));
+    duplicate = IsDuplicate(propagator_seen, name);
+
+    if (!duplicate)
+    {
+      propagator = CreateTextMapPropagator(name);
+      propagators.push_back(std::move(propagator));
+      propagator_seen.push_back(name);
+    }
   }
 
-  auto sdk = std::make_unique<opentelemetry::context::propagation::CompositePropagator>(
-      std::move(propagators));
+  if (model->composite_list.size() > 0)
+  {
+    std::string str_list = model->composite_list;
+    size_t start_pos     = 0;
+    size_t end_pos       = 0;
+    char separator       = ',';
+    std::string name;
+
+    while ((end_pos = str_list.find(separator, start_pos)) != std::string::npos)
+    {
+      name = str_list.substr(start_pos, end_pos - start_pos);
+
+      duplicate = IsDuplicate(propagator_seen, name);
+
+      if (!duplicate)
+      {
+        propagator = CreateTextMapPropagator(name);
+        propagators.push_back(std::move(propagator));
+        propagator_seen.push_back(name);
+      }
+      start_pos = end_pos + 1;
+    }
+
+    name = str_list.substr(start_pos);
+
+    duplicate = IsDuplicate(propagator_seen, name);
+
+    if (!duplicate)
+    {
+      propagator = CreateTextMapPropagator(name);
+      propagators.push_back(std::move(propagator));
+    }
+  }
+
+  if (propagators.size() > 0)
+  {
+    sdk = std::make_unique<opentelemetry::context::propagation::CompositePropagator>(
+        std::move(propagators));
+  }
 
   return sdk;
 }
@@ -1293,6 +1359,11 @@ std::unique_ptr<opentelemetry::sdk::metrics::MetricReader> SdkBuilder::CreatePer
 
   auto exporter_sdk = CreatePushMetricExporter(model->exporter);
 
+  if (model->producers.size() > 0)
+  {
+    OTEL_INTERNAL_LOG_WARN("metric producer not supported, ignoring");
+  }
+
   sdk = opentelemetry::sdk::metrics::PeriodicExportingMetricReaderFactory::Create(
       std::move(exporter_sdk), options);
 
@@ -1306,6 +1377,11 @@ std::unique_ptr<opentelemetry::sdk::metrics::MetricReader> SdkBuilder::CreatePul
 
   sdk = CreatePullMetricExporter(model->exporter);
 
+  if (model->producers.size() > 0)
+  {
+    OTEL_INTERNAL_LOG_WARN("metric producer not supported, ignoring");
+  }
+
   return sdk;
 }
 
diff --git a/sdk/test/configuration/yaml_metrics_test.cc b/sdk/test/configuration/yaml_metrics_test.cc
diff --git a/sdk/test/configuration/yaml_propagator_test.cc b/sdk/test/configuration/yaml_propagator_test.cc

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ class PropagatorConfiguration`
`20`	`20`	`{`
`21`	`21`	`public:`
`22`	`22`	`std::vector<std::string> composite;`
	`23`	`+ std::string composite_list;`
`23`	`24`	`};`
`24`	`25`
`25`	`26`	`} // namespace configuration`