diff --git a/sdk/include/opentelemetry/sdk/configuration/extension_metric_producer_configuration.h b/sdk/include/opentelemetry/sdk/configuration/extension_metric_producer_configuration.h new file mode 100644 index 0000000000..f715e12f06 --- /dev/null +++ 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 +#include + +#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 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 new file mode 100644 index 0000000000..73340f3166 --- /dev/null +++ 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 new file mode 100644 index 0000000000..b8b7eb6b66 --- /dev/null +++ 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 + +#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 index cd1f7693d0..b2f6e476ae 100644 --- 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 composite; + std::string composite_list; }; } // namespace configuration diff --git a/sdk/src/configuration/configuration_parser.cc b/sdk/src/configuration/configuration_parser.cc index 000b935662..7b0abcbca7 100644 --- 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 ParsePullMetricExporterC throw InvalidSchemaException(message); } - if (name == "prometheus") + if (name == "prometheus/development") { model = ParsePrometheusPullMetricExporterConfiguration(child); } @@ -703,6 +706,61 @@ static std::unique_ptr ParsePullMetricExporterC return model; } +static std::unique_ptr +ParseOpenCensusMetricProducerConfiguration(const std::unique_ptr & /* node */) +{ + auto model = std::make_unique(); + + return model; +} + +static std::unique_ptr +ParseExtensionMetricProducerConfiguration(const std::string &name, + std::unique_ptr node) +{ + auto model = std::make_unique(); + + model->name = name; + model->node = std::move(node); + + return model; +} + +static std::unique_ptr ParseMetricProducerConfiguration( + const std::unique_ptr &node) +{ + std::unique_ptr model; + + std::string name; + std::unique_ptr 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 ParsePeriodicMetricReaderConfiguration( const std::unique_ptr &node) { @@ -715,6 +773,16 @@ static std::unique_ptr 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 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 ParsePropagatorConfiguration( auto model = std::make_unique(); std::unique_ptr 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 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 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 index 593fb46ebb..c084ef930c 100644 --- 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 &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 SdkBuilder::CreatePropagator( const std::unique_ptr &model) const { + std::unique_ptr sdk; std::vector> propagators; std::unique_ptr propagator; + std::vector 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( - 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( + std::move(propagators)); + } return sdk; } @@ -1293,6 +1359,11 @@ std::unique_ptr 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 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 index 8f963f293e..4b202c2cf1 100644 --- a/sdk/test/configuration/yaml_metrics_test.cc +++ b/sdk/test/configuration/yaml_metrics_test.cc @@ -144,7 +144,7 @@ file_format: xx.yy readers: - pull: exporter: - prometheus: + prometheus/development: )"; auto config = DoParse(yaml); @@ -519,7 +519,7 @@ file_format: xx.yy readers: - pull: exporter: - prometheus: + prometheus/development: )"; auto config = DoParse(yaml); @@ -550,7 +550,7 @@ file_format: xx.yy readers: - pull: exporter: - prometheus: + prometheus/development: host: "prometheus" port: 1234 without_units: true diff --git a/sdk/test/configuration/yaml_propagator_test.cc b/sdk/test/configuration/yaml_propagator_test.cc new file mode 100644 index 0000000000..cba8bde4da --- /dev/null +++ b/sdk/test/configuration/yaml_propagator_test.cc @@ -0,0 +1,172 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 + +#include +#include +#include +#include + +#include "opentelemetry/sdk/configuration/configuration.h" +#include "opentelemetry/sdk/configuration/propagator_configuration.h" +#include "opentelemetry/sdk/configuration/yaml_configuration_parser.h" + +static std::unique_ptr DoParse( + const std::string &yaml) +{ + static const std::string source("test"); + return opentelemetry::sdk::configuration::YamlConfigurationParser::ParseString(source, yaml); +} + +TEST(YamlPropagator, empty_propagator) +{ + std::string yaml = R"( +file_format: xx.yy +propagator: +)"; + + auto config = DoParse(yaml); + ASSERT_NE(config, nullptr); + ASSERT_NE(config->propagator, nullptr); + ASSERT_EQ(config->propagator->composite.size(), 0); + ASSERT_EQ(config->propagator->composite_list, ""); +} + +TEST(YamlPropagator, empty_composite) +{ + std::string yaml = R"( +file_format: xx.yy +propagator: + composite: +)"; + + auto config = DoParse(yaml); + ASSERT_NE(config, nullptr); + ASSERT_NE(config->propagator, nullptr); + ASSERT_EQ(config->propagator->composite.size(), 0); + ASSERT_EQ(config->propagator->composite_list, ""); +} + +TEST(YamlPropagator, old_propagator_1) +{ + // This is the old format, must fail + std::string yaml = R"( +file_format: xx.yy +propagator: + composite: + - foo + - bar +)"; + + auto config = DoParse(yaml); + ASSERT_EQ(config, nullptr); +} + +TEST(YamlPropagator, old_propagator_2) +{ + // This is the old format, must fail + std::string yaml = R"( +file_format: xx.yy +propagator: + composite: [foo, bar] +)"; + + auto config = DoParse(yaml); + ASSERT_EQ(config, nullptr); +} + +TEST(YamlPropagator, propagator_array_ok) +{ + std::string yaml = R"( +file_format: xx.yy +propagator: + composite: + - foo: + - bar: + - baz: +)"; + + auto config = DoParse(yaml); + ASSERT_NE(config, nullptr); + ASSERT_NE(config->propagator, nullptr); + ASSERT_EQ(config->propagator->composite.size(), 3); + ASSERT_EQ(config->propagator->composite[0], "foo"); + ASSERT_EQ(config->propagator->composite[1], "bar"); + ASSERT_EQ(config->propagator->composite[2], "baz"); + ASSERT_EQ(config->propagator->composite_list, ""); +} + +TEST(YamlPropagator, propagator_array_broken) +{ + std::string yaml = R"( +file_format: xx.yy +propagator: + composite: + - foo: + - bar: + baz: +)"; + + auto config = DoParse(yaml); + ASSERT_EQ(config, nullptr); +} + +TEST(YamlPropagator, propagator_composite_list) +{ + std::string yaml = R"( +file_format: xx.yy +propagator: + composite_list: "foo,bar,baz" +)"; + + auto config = DoParse(yaml); + ASSERT_NE(config, nullptr); + ASSERT_NE(config->propagator, nullptr); + ASSERT_EQ(config->propagator->composite.size(), 0); + ASSERT_EQ(config->propagator->composite_list, "foo,bar,baz"); +} + +TEST(YamlPropagator, propagator_both) +{ + std::string yaml = R"( +file_format: xx.yy +propagator: + composite: + - aaa: + - bbb: + - ccc: + composite_list: "ddd,eee,fff" +)"; + + auto config = DoParse(yaml); + ASSERT_NE(config, nullptr); + ASSERT_NE(config->propagator, nullptr); + ASSERT_EQ(config->propagator->composite.size(), 3); + ASSERT_EQ(config->propagator->composite[0], "aaa"); + ASSERT_EQ(config->propagator->composite[1], "bbb"); + ASSERT_EQ(config->propagator->composite[2], "ccc"); + ASSERT_EQ(config->propagator->composite_list, "ddd,eee,fff"); +} + +TEST(YamlPropagator, propagator_duplicates) +{ + std::string yaml = R"( +file_format: xx.yy +propagator: + composite: + - aaa: + - bbb: + - bbb: + - ccc: + composite_list: "aaa,eee,eee,fff,ccc" +)"; + + auto config = DoParse(yaml); + ASSERT_NE(config, nullptr); + ASSERT_NE(config->propagator, nullptr); + ASSERT_EQ(config->propagator->composite.size(), 4); + ASSERT_EQ(config->propagator->composite[0], "aaa"); + ASSERT_EQ(config->propagator->composite[1], "bbb"); + ASSERT_EQ(config->propagator->composite[2], "bbb"); + ASSERT_EQ(config->propagator->composite[3], "ccc"); + ASSERT_EQ(config->propagator->composite_list, "aaa,eee,eee,fff,ccc"); +}