Add Prometheus option to disable otel_scope attributes

open-telemetry · Dec 13, 2023 · faa1e7b · faa1e7b
1 parent 96e5078
commit faa1e7b
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 6 deletions.
diff --git a/exporters/prometheus/include/opentelemetry/exporters/prometheus/collector.h b/exporters/prometheus/include/opentelemetry/exporters/prometheus/collector.h
@@ -31,7 +31,9 @@ class PrometheusCollector : public prometheus_client::Collectable
    * This constructor initializes the collection for metrics to export
    * in this class with default capacity
    */
-  explicit PrometheusCollector(sdk::metrics::MetricReader *reader, bool populate_target_info);
+  explicit PrometheusCollector(sdk::metrics::MetricReader *reader,
+                               bool populate_target_info,
+                               bool populate_otel_scope);
 
   /**
    * Collects all metrics data from metricsToCollect collection.
@@ -43,6 +45,7 @@ class PrometheusCollector : public prometheus_client::Collectable
 private:
   sdk::metrics::MetricReader *reader_;
   bool populate_target_info_;
+  bool populate_otel_scope_;
 
   /*
    * Lock when operating the metricsToCollect collection

diff --git a/exporters/prometheus/include/opentelemetry/exporters/prometheus/exporter_options.h b/exporters/prometheus/include/opentelemetry/exporters/prometheus/exporter_options.h
@@ -25,6 +25,9 @@ struct PrometheusExporterOptions
 
   // Populating target_info
   bool populate_target_info = true;
+
+  // Populating otel_scope_name/otel_scope_labels attributes
+  bool populate_otel_scope = true;
 };
 
 }  // namespace metrics

diff --git a/exporters/prometheus/src/collector.cc b/exporters/prometheus/src/collector.cc
@@ -18,8 +18,11 @@ namespace metrics
  * in this class with default capacity
  */
 PrometheusCollector::PrometheusCollector(sdk::metrics::MetricReader *reader,
-                                         bool populate_target_info)
-    : reader_(reader), populate_target_info_(populate_target_info)
+                                         bool populate_target_info,
+                                         bool populate_otel_scope)
+    : reader_(reader),
+      populate_target_info_(populate_target_info),
+      populate_otel_scope_(populate_otel_scope)
 {}
 
 /**

diff --git a/exporters/prometheus/src/exporter.cc b/exporters/prometheus/src/exporter.cc
@@ -31,7 +31,7 @@ PrometheusExporter::PrometheusExporter(const PrometheusExporterOptions &options)
     return;
   }
   collector_ = std::shared_ptr<PrometheusCollector>(
-      new PrometheusCollector(this, options_.populate_target_info));
+      new PrometheusCollector(this, options_.populate_target_info, options_.populate_otel_scope));
 
   exposer_->RegisterCollectable(collector_);
 }

diff --git a/exporters/prometheus/src/exporter_options.cc b/exporters/prometheus/src/exporter_options.cc
@@ -25,7 +25,20 @@ inline const std::string GetPrometheusDefaultHttpEndpoint()
   return exists ? endpoint : kPrometheusEndpointDefault;
 }
 
-PrometheusExporterOptions::PrometheusExporterOptions() : url(GetPrometheusDefaultHttpEndpoint()) {}
+inline bool GetPrometheusPopulateOtelScope()
+{
+  constexpr char kPrometheusPopulateOtelScope[] = "PROMETHEUS_EXPORTER_POPULATE_OTEL_SCOPE";
+
+  bool setting;
+  auto exists =
+      opentelemetry::sdk::common::GetBoolEnvironmentVariable(kPrometheusPopulateOtelScope, setting);
+
+  return exists ? setting : true;
+}
+
+PrometheusExporterOptions::PrometheusExporterOptions()
+    : url(GetPrometheusDefaultHttpEndpoint()), populate_otel_scope(GetPrometheusPopulateOtelScope())
+{}
 
 }  // namespace metrics
 }  // namespace exporter

diff --git a/exporters/prometheus/test/collector_test.cc b/exporters/prometheus/test/collector_test.cc
@@ -73,7 +73,7 @@ TEST(PrometheusCollector, BasicTests)
   MockMetricReader *reader     = new MockMetricReader();
   MockMetricProducer *producer = new MockMetricProducer();
   reader->SetMetricProducer(producer);
-  PrometheusCollector collector(reader, true);
+  PrometheusCollector collector(reader, true, true);
   auto data = collector.Collect();
 
   // Collection size should be the same as the size