[Geneva] Add prepopulated dimension names to Geneva Metrics Exporter (#…

…399)
open-telemetry · Mar 18, 2024 · 09f638f · 09f638f
1 parent 8bf5ebe
commit 09f638f
Show file tree

Hide file tree

Showing 4 changed files with 245 additions and 132 deletions.
diff --git a/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/exporter_options.h b/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/exporter_options.h
@@ -3,9 +3,10 @@
 
 #pragma once
 
-#include "opentelemetry/version.h"
 #include <string>
 
+#include "opentelemetry/version.h"
+
 OPENTELEMETRY_BEGIN_NAMESPACE
 namespace exporter {
 namespace geneva {
@@ -22,6 +23,7 @@ struct ExporterOptions {
   */
 // clang-format off
   std::string connection_string;
+  const std::map<std::string, std::string> prepopulated_dimensions;
 };
 } // namespace metrics
 } // namespace geneva

diff --git a/exporters/geneva/src/exporter.cc b/exporters/geneva/src/exporter.cc
@@ -210,6 +210,18 @@ size_t Exporter::SerializeNonHistogramMetrics(
   SerializeString(buffer_, bufferIndex, metric_name);
 
   uint16_t attributes_size = 0;
+
+  // serialize prepopulated names
+  for (const auto &kv : options_.prepopulated_dimensions) {
+    if (kv.first.size() > kMaxDimensionNameSize) {
+      LOG_WARN("Dimension name limit overflow: %s Limit: %zd", kv.first.c_str(),
+               kMaxDimensionNameSize);
+      continue;
+    }
+    attributes_size++;
+    SerializeString(buffer_, bufferIndex, kv.first);
+  }
+
   for (const auto &kv : attributes) {
     if (kv.first.size() > kMaxDimensionNameSize) {
       LOG_WARN("Dimension name limit overflow: %s Limit: %d", kv.first.c_str(),
@@ -225,6 +237,16 @@ size_t Exporter::SerializeNonHistogramMetrics(
     attributes_size++;
     SerializeString(buffer_, bufferIndex, kv.first);
   }
+
+  // serialize prepopulated values
+  for (const auto &kv : options_.prepopulated_dimensions) {
+    if (kv.second.size() > kMaxDimensionNameSize) {
+      // warning is already logged earlier, no logging again
+      continue;
+    }
+    SerializeString(buffer_, bufferIndex, kv.second);
+  }
+
   for (const auto &kv : attributes) {
     if (kv.first.size() > kMaxDimensionNameSize) {
       LOG_WARN("Dimension name limit overflow: %s Limit: %d", kv.first.c_str(),
@@ -326,6 +348,18 @@ size_t Exporter::SerializeHistogramMetrics(
   SerializeString(buffer_, bufferIndex, metric_name);
 
   uint16_t attributes_size = 0;
+
+  // dimensions - prepopulated names
+  for (const auto &kv : options_.prepopulated_dimensions) {
+    if (kv.first.size() > kMaxDimensionNameSize) {
+      LOG_WARN("Dimension name limit overflow: %s Limit: %zd", kv.first.c_str(),
+               kMaxDimensionNameSize);
+      continue;
+    }
+    attributes_size++;
+    SerializeString(buffer_, bufferIndex, kv.first);
+  }
+
   // dimentions - name
   for (const auto &kv : attributes) {
     if (kv.first.size() > kMaxDimensionNameSize) {
@@ -343,6 +377,16 @@ size_t Exporter::SerializeHistogramMetrics(
     SerializeString(buffer_, bufferIndex, kv.first);
   }
 
+
+  // dimensions - prepopulated values
+  for (const auto &kv : options_.prepopulated_dimensions) {
+    if (kv.second.size() > kMaxDimensionNameSize) {
+      // warning is already logged earlier, no logging again
+      continue;
+    }
+    SerializeString(buffer_, bufferIndex, kv.second);
+  }
+
   // dimentions - value
   for (const auto &kv : attributes) {
     if (kv.first.size() > kMaxDimensionNameSize) {

diff --git a/exporters/geneva/test/common/generate_metrics.h b/exporters/geneva/test/common/generate_metrics.h
@@ -27,6 +27,10 @@ const std::string kCounterDoubleAttributeKey2 = "counter_double_key2";
 const std::string kCounterDoubleAttributeValue2 = "counter_double_value2";
 const std::string kCounterDoubleAttributeKey3 = "counter_double_key3";
 const std::string kCounterDoubleAttributeValue3 = "counter_double_value3";
+const std::string kPrepopulatedDimensionKey1 = "prepopulated_key1";
+const std::string kPrepopulatedDimensionValue1 = "prepopulated_value1";
+const std::string kPrepopulatedDimensionKey2 = "prepopulated_key2";
+const std::string kPrepopulatedDimensionValue2 = "prepopulated_value2";
 const uint16_t kCounterDoubleCountDimensions = 1;
 const uint16_t kCounterDoubleEventId = 55;