mered from upstream

malkia · malkia · commit f995f2087f23 · 2025-10-28T15:16:02.000-07:00
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -60,7 +60,7 @@ jobs:
           egress-policy: audit
 
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-      - uses: actions/download-artifact@4a24838f3d5601fd639834081e118c2995d51e1c # main March 2025
+      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # main March 2025
         with:
           name: benchmark_results
           path: benchmarks
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -37,10 +37,10 @@ jobs:
       run: |
         sudo -E ./ci/setup_ci_environment.sh
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@16140ae1a102900babc80a33c44059580f687047 # v4.30.9
+      uses: github/codeql-action/init@4e94bd11f71e507f7f87df81788dff88d1dacbfb # v4.31.0
       with:
        languages: cpp
     - name: Autobuild
-      uses: github/codeql-action/autobuild@16140ae1a102900babc80a33c44059580f687047 # v4.30.9
+      uses: github/codeql-action/autobuild@4e94bd11f71e507f7f87df81788dff88d1dacbfb # v4.31.0
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@16140ae1a102900babc80a33c44059580f687047 # v4.30.9
+      uses: github/codeql-action/analyze@4e94bd11f71e507f7f87df81788dff88d1dacbfb # v4.31.0
diff --git a/.github/workflows/ossf-scorecard.yml b/.github/workflows/ossf-scorecard.yml
@@ -47,6 +47,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@16140ae1a102900babc80a33c44059580f687047 # v4.30.9
+        uses: github/codeql-action/upload-sarif@4e94bd11f71e507f7f87df81788dff88d1dacbfb # v4.31.0
         with:
           sarif_file: results.sarif
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,6 +26,9 @@ Increment the:
 * [CI] Upgrade tools/vcpkg to 2025.09.17
   [#3701](https://github.com/open-telemetry/opentelemetry-cpp/pull/3701)
 
+* [CONFIGURATION] File configuration - prometheus translation
+  [#3715](https://github.com/open-telemetry/opentelemetry-cpp/pull/3715)
+
 ## [1.23 2025-09-25]
 
 * [CodeHealth] Fix clang-tidy warnings part 6
diff --git a/exporters/prometheus/src/prometheus_pull_builder.cc b/exporters/prometheus/src/prometheus_pull_builder.cc
@@ -8,9 +8,11 @@
 #include "opentelemetry/exporters/prometheus/exporter_factory.h"
 #include "opentelemetry/exporters/prometheus/exporter_options.h"
 #include "opentelemetry/exporters/prometheus/prometheus_pull_builder.h"
+#include "opentelemetry/sdk/common/global_log_handler.h"
 #include "opentelemetry/sdk/configuration/prometheus_pull_metric_exporter_builder.h"
 #include "opentelemetry/sdk/configuration/prometheus_pull_metric_exporter_configuration.h"
 #include "opentelemetry/sdk/configuration/registry.h"
+#include "opentelemetry/sdk/configuration/translation_strategy.h"
 #include "opentelemetry/sdk/metrics/metric_reader.h"
 #include "opentelemetry/version.h"
 
@@ -38,8 +40,36 @@ std::unique_ptr<opentelemetry::sdk::metrics::MetricReader> PrometheusPullBuilder
   options.url                  = url;
   options.populate_target_info = true;
   options.without_otel_scope   = model->without_scope_info;
-  options.without_units        = model->without_units;
-  options.without_type_suffix  = model->without_type_suffix;
+
+  switch (model->translation_strategy)
+  {
+    case sdk::configuration::TranslationStrategy::UnderscoreEscapingWithSuffixes:
+      options.without_units       = false;
+      options.without_type_suffix = false;
+      break;
+    case sdk::configuration::TranslationStrategy::UnderscoreEscapingWithoutSuffixes:
+      options.without_units       = true;
+      options.without_type_suffix = true;
+      break;
+    case sdk::configuration::TranslationStrategy::NoUTF8EscapingWithSuffixes:
+      // FIXME: no flag to disable UnderscoreEscaping
+      OTEL_INTERNAL_LOG_WARN("[Prometheus Exporter] NoUTF8EscapingWithSuffixes not supported");
+      options.without_units       = false;
+      options.without_type_suffix = false;
+      break;
+    case sdk::configuration::TranslationStrategy::NoTranslation:
+      // FIXME: no flag to disable UnderscoreEscaping
+      OTEL_INTERNAL_LOG_WARN("[Prometheus Exporter] NoTranslation not supported");
+      options.without_units       = true;
+      options.without_type_suffix = true;
+      break;
+  }
+
+  if (model->with_resource_constant_labels != nullptr)
+  {
+    // FIXME: with_resource_constant_labels
+    OTEL_INTERNAL_LOG_WARN("[Prometheus Exporter] with_resource_constant_labels not supported");
+  }
 
   return PrometheusExporterFactory::Create(options);
 }
diff --git a/functional/configuration/shelltests/kitchen-sink.test b/functional/configuration/shelltests/kitchen-sink.test
@@ -6,6 +6,7 @@ $ example_yaml --test --yaml shelltests/kitchen-sink.yaml | egrep -v "(observed_
 MODEL PARSED
 [WARNING] attribute_limits not supported, ignoring
 [WARNING] IncludeExclude attribute processor not supported, ignoring
+[WARNING] [Prometheus Exporter] with_resource_constant_labels not supported
 [WARNING] metric producer not supported, ignoring
 [WARNING] metric producer not supported, ignoring
 [WARNING] [Periodic Exporting Metric Reader] Invalid configuration: export_timeout_millis_ should be less than export_interval_millis_, using default values
diff --git a/functional/configuration/shelltests/prometheus_translation_broken.test b/functional/configuration/shelltests/prometheus_translation_broken.test
@@ -0,0 +1,8 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+$ example_yaml --test --yaml shelltests/prometheus_translation_broken.yaml
+>
+[ERROR] <shelltests/prometheus_translation_broken.yaml>:9[10](164): Illegal TranslationStrategy: broken
+FAILED TO PARSE MODEL
+>= 1
diff --git a/functional/configuration/shelltests/prometheus_translation_broken.yaml b/functional/configuration/shelltests/prometheus_translation_broken.yaml
@@ -0,0 +1,15 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+file_format: "1.0"
+
+meter_provider:
+  readers:
+    - pull:
+        exporter:
+          prometheus/development:
+            host: localhost
+            port: 9464
+            without_scope_info: false
+            # Must fail, invalid
+            translation_strategy: broken
diff --git a/functional/configuration/shelltests/prometheus_translation_no.test b/functional/configuration/shelltests/prometheus_translation_no.test
@@ -0,0 +1,10 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+$ example_yaml --test --yaml shelltests/prometheus_translation_no.yaml
+>
+MODEL PARSED
+[WARNING] [Prometheus Exporter] NoTranslation not supported
+[WARNING] [Prometheus Exporter] with_resource_constant_labels not supported
+SDK CREATED
+>= 0
diff --git a/functional/configuration/shelltests/prometheus_translation_no.yaml b/functional/configuration/shelltests/prometheus_translation_no.yaml
@@ -0,0 +1,17 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+file_format: "1.0"
+
+meter_provider:
+  readers:
+    - pull:
+        exporter:
+          prometheus/development:
+            host: localhost
+            port: 9464
+            without_scope_info: false
+            translation_strategy: NoTranslation
+            with_resource_constant_labels:
+              included:
+                - "not supported"
diff --git a/functional/configuration/shelltests/prometheus_translation_no_utf8.test b/functional/configuration/shelltests/prometheus_translation_no_utf8.test
@@ -0,0 +1,9 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+$ example_yaml --test --yaml shelltests/prometheus_translation_no_utf8.yaml
+>
+MODEL PARSED
+[WARNING] [Prometheus Exporter] NoUTF8EscapingWithSuffixes not supported
+SDK CREATED
+>= 0
diff --git a/functional/configuration/shelltests/prometheus_translation_no_utf8.yaml b/functional/configuration/shelltests/prometheus_translation_no_utf8.yaml
@@ -0,0 +1,14 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+file_format: "1.0"
+
+meter_provider:
+  readers:
+    - pull:
+        exporter:
+          prometheus/development:
+            host: localhost
+            port: 9464
+            without_scope_info: false
+            translation_strategy: NoUTF8EscapingWithSuffixes
diff --git a/functional/configuration/shelltests/prometheus_translation_with_suffixes.test b/functional/configuration/shelltests/prometheus_translation_with_suffixes.test
@@ -0,0 +1,8 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+$ example_yaml --test --yaml shelltests/prometheus_translation_with_suffixes.yaml
+>
+MODEL PARSED
+SDK CREATED
+>= 0
diff --git a/functional/configuration/shelltests/prometheus_translation_with_suffixes.yaml b/functional/configuration/shelltests/prometheus_translation_with_suffixes.yaml
@@ -0,0 +1,14 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+file_format: "1.0"
+
+meter_provider:
+  readers:
+    - pull:
+        exporter:
+          prometheus/development:
+            host: localhost
+            port: 9464
+            without_scope_info: false
+            translation_strategy: UnderscoreEscapingWithSuffixes
diff --git a/functional/configuration/shelltests/prometheus_translation_without_suffixes.test b/functional/configuration/shelltests/prometheus_translation_without_suffixes.test
@@ -0,0 +1,8 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+$ example_yaml --test --yaml shelltests/prometheus_translation_without_suffixes.yaml
+>
+MODEL PARSED
+SDK CREATED
+>= 0
diff --git a/functional/configuration/shelltests/prometheus_translation_without_suffixes.yaml b/functional/configuration/shelltests/prometheus_translation_without_suffixes.yaml
@@ -0,0 +1,14 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+file_format: "1.0"
+
+meter_provider:
+  readers:
+    - pull:
+        exporter:
+          prometheus/development:
+            host: localhost
+            port: 9464
+            without_scope_info: false
+            translation_strategy: UnderscoreEscapingWithoutSuffixes
diff --git a/install/test/src/test_exporters_prometheus_builder.cc b/install/test/src/test_exporters_prometheus_builder.cc
@@ -11,11 +11,9 @@ TEST(ExportersPrometheusBuilderInstall, PrometheusPullBuilder)
   ASSERT_TRUE(builder != nullptr);
 
   opentelemetry::sdk::configuration::PrometheusPullMetricExporterConfiguration model;
-  model.host                = "localhost";
-  model.port                = 1234;
-  model.without_scope_info  = false;
-  model.without_units       = false;
-  model.without_type_suffix = false;
+  model.host               = "localhost";
+  model.port               = 1234;
+  model.without_scope_info = false;
 
   auto exporter = builder->Build(&model);
   ASSERT_TRUE(exporter != nullptr);
diff --git a/sdk/include/opentelemetry/sdk/common/attribute_utils.h b/sdk/include/opentelemetry/sdk/common/attribute_utils.h
@@ -83,7 +83,7 @@ struct AttributeConverter
   {
     return OwnedAttributeValue(std::string(v));
   }
-  OwnedAttributeValue operator()(std::string v) { return OwnedAttributeValue(v); }
+  OwnedAttributeValue operator()(std::string v) { return OwnedAttributeValue(std::move(v)); }
   OwnedAttributeValue operator()(const char *v) { return OwnedAttributeValue(std::string(v)); }
   OwnedAttributeValue operator()(nostd::span<const uint8_t> v) { return convertSpan<uint8_t>(v); }
   OwnedAttributeValue operator()(nostd::span<const bool> v) { return convertSpan<bool>(v); }
@@ -100,8 +100,7 @@ struct AttributeConverter
   template <typename T, typename U = T>
   OwnedAttributeValue convertSpan(nostd::span<const U> vals)
   {
-    const std::vector<T> copy(vals.begin(), vals.end());
-    return OwnedAttributeValue(std::move(copy));
+    return OwnedAttributeValue(std::vector<T>(vals.begin(), vals.end()));
   }
 };
 
@@ -171,23 +170,15 @@ class AttributeMap : public std::unordered_map<std::string, OwnedAttributeValue>
   // Construct attribute map and populate with attributes
   AttributeMap(const opentelemetry::common::KeyValueIterable &attributes) : AttributeMap()
   {
-    attributes.ForEachKeyValue(
-        [&](nostd::string_view key, opentelemetry::common::AttributeValue value) noexcept {
-          SetAttribute(key, value);
-          return true;
-        });
+    ConstructFrom(attributes);
   }
 
   // Construct attribute map and populate with optional attributes
   AttributeMap(const opentelemetry::common::KeyValueIterable *attributes) : AttributeMap()
   {
     if (attributes != nullptr)
     {
-      attributes->ForEachKeyValue(
-          [&](nostd::string_view key, opentelemetry::common::AttributeValue value) noexcept {
-            SetAttribute(key, value);
-            return true;
-          });
+      ConstructFrom(*attributes);
     }
   }
 
@@ -203,6 +194,15 @@ class AttributeMap : public std::unordered_map<std::string, OwnedAttributeValue>
     }
   }
 
+  void ConstructFrom(const opentelemetry::common::KeyValueIterable &attributes)
+  {
+    attributes.ForEachKeyValue(
+        [&](nostd::string_view key, const opentelemetry::common::AttributeValue &value) noexcept {
+          SetAttribute(key, value);
+          return true;
+        });
+  }
+
   // Returns a reference to this map
   const std::unordered_map<std::string, OwnedAttributeValue> &GetAttributes() const noexcept
   {
@@ -213,7 +213,7 @@ class AttributeMap : public std::unordered_map<std::string, OwnedAttributeValue>
   void SetAttribute(nostd::string_view key,
                     const opentelemetry::common::AttributeValue &value) noexcept
   {
-    (*this)[std::string(key)] = nostd::visit(converter_, value);
+    (*this)[std::string(key)] = nostd::visit(AttributeConverter(), value);
   }
 
   // Compare the attributes of this map with another KeyValueIterable
@@ -235,18 +235,14 @@ class AttributeMap : public std::unordered_map<std::string, OwnedAttributeValue>
             {
               // Order of arguments is important here. OwnedAttributeValue is first then
               // AttributeValue AttributeEqualToVisitor does not support the reverse order
-              return nostd::visit(equal_to_visitor_, kv.second, value);
+              return nostd::visit(AttributeEqualToVisitor(), kv.second, value);
             }
           }
           return false;
         });
 
     return is_equal;
   }
-
-private:
-  AttributeConverter converter_;
-  AttributeEqualToVisitor equal_to_visitor_;
 };
 
 /**
@@ -291,11 +287,8 @@ class OrderedAttributeMap : public std::map<std::string, OwnedAttributeValue>
   void SetAttribute(nostd::string_view key,
                     const opentelemetry::common::AttributeValue &value) noexcept
   {
-    (*this)[std::string(key)] = nostd::visit(converter_, value);
+    (*this)[std::string(key)] = nostd::visit(AttributeConverter(), value);
   }
-
-private:
-  AttributeConverter converter_;
 };
 
 }  // namespace common
diff --git a/sdk/include/opentelemetry/sdk/configuration/configuration_parser.h b/sdk/include/opentelemetry/sdk/configuration/configuration_parser.h
@@ -85,6 +85,7 @@
 #include "opentelemetry/sdk/configuration/temporality_preference.h"
 #include "opentelemetry/sdk/configuration/trace_id_ratio_based_sampler_configuration.h"
 #include "opentelemetry/sdk/configuration/tracer_provider_configuration.h"
+#include "opentelemetry/sdk/configuration/translation_strategy.h"
 #include "opentelemetry/sdk/configuration/view_configuration.h"
 #include "opentelemetry/sdk/configuration/view_selector_configuration.h"
 #include "opentelemetry/sdk/configuration/view_stream_configuration.h"
@@ -172,6 +173,9 @@ class OPENTELEMETRY_EXPORT_TYPE ConfigurationParser
   std::unique_ptr<ConsolePushMetricExporterConfiguration>
   ParseConsolePushMetricExporterConfiguration(const std::unique_ptr<DocumentNode> &node) const;
 
+  TranslationStrategy ParseTranslationStrategy(const std::unique_ptr<DocumentNode> &node,
+                                               const std::string &name) const;
+
   std::unique_ptr<PrometheusPullMetricExporterConfiguration>
   ParsePrometheusPullMetricExporterConfiguration(const std::unique_ptr<DocumentNode> &node) const;
 
diff --git a/sdk/include/opentelemetry/sdk/configuration/prometheus_pull_metric_exporter_configuration.h b/sdk/include/opentelemetry/sdk/configuration/prometheus_pull_metric_exporter_configuration.h
@@ -7,8 +7,10 @@
 
 #include "opentelemetry/version.h"
 #include "opentelemetry/sdk/configuration/headers_configuration.h"
+#include "opentelemetry/sdk/configuration/include_exclude_configuration.h"
 #include "opentelemetry/sdk/configuration/pull_metric_exporter_configuration.h"
 #include "opentelemetry/sdk/configuration/pull_metric_exporter_configuration_visitor.h"
+#include "opentelemetry/sdk/configuration/translation_strategy.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
 namespace sdk
@@ -28,10 +30,9 @@ class PrometheusPullMetricExporterConfiguration : public PullMetricExporterConfi
 
   std::string host;
   std::size_t port{0};
-  bool without_units{false};
-  bool without_type_suffix{false};
   bool without_scope_info{false};
-  // FIXME: with_resource_constant_labels;
+  std::unique_ptr<IncludeExcludeConfiguration> with_resource_constant_labels;
+  TranslationStrategy translation_strategy;
 };
 
 }  // namespace configuration
diff --git a/sdk/include/opentelemetry/sdk/configuration/translation_strategy.h b/sdk/include/opentelemetry/sdk/configuration/translation_strategy.h
diff --git a/sdk/src/configuration/configuration_parser.cc b/sdk/src/configuration/configuration_parser.cc
diff --git a/sdk/test/configuration/yaml_metrics_test.cc b/sdk/test/configuration/yaml_metrics_test.cc
