[SDK] Increase metric name maximum length from 63 to 255 characters (#…

…2284)
open-telemetry · Aug 31, 2023 · f52ec6c · f52ec6c · github-actions · Aug 31, 2023
1 parent 7196ec3
commit f52ec6c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 17 deletions.
diff --git a/sdk/include/opentelemetry/sdk/metrics/meter.h b/sdk/include/opentelemetry/sdk/metrics/meter.h
@@ -130,7 +130,6 @@ class Meter final : public opentelemetry::metrics::Meter
   std::unique_ptr<AsyncWritableMetricStorage> RegisterAsyncMetricStorage(
       InstrumentDescriptor &instrument_descriptor);
   opentelemetry::common::SpinLockMutex storage_lock_;
-  const InstrumentMetaDataValidator instrument_metadata_validator;
 
   static nostd::shared_ptr<opentelemetry::metrics::ObservableInstrument>
   GetNoopObservableInsrument()

diff --git a/sdk/src/metrics/instrument_metadata_validator.cc b/sdk/src/metrics/instrument_metadata_validator.cc
@@ -17,8 +17,8 @@ namespace sdk
 {
 namespace metrics
 {
-// instrument-name = ALPHA 0*62 ("_" / "." / "-" / ALPHA / DIGIT)
-const std::string kInstrumentNamePattern = "[a-zA-Z][-_.a-zA-Z0-9]{0,62}";
+// instrument-name = ALPHA 0*254 ("_" / "." / "-" / ALPHA / DIGIT)
+const std::string kInstrumentNamePattern = "[a-zA-Z][-_.a-zA-Z0-9]{0,254}";
 //
 const std::string kInstrumentUnitPattern = "[\x01-\x7F]{0,63}";
 // instrument-unit = It can have a maximum length of 63 ASCII chars
@@ -38,8 +38,8 @@ bool InstrumentMetaDataValidator::ValidateName(nostd::string_view name) const
 #if OPENTELEMETRY_HAVE_WORKING_REGEX
   return std::regex_match(name.data(), name_reg_key_);
 #else
-  const size_t kMaxSize = 63;
-  // size atmost 63 chars
+  const size_t kMaxSize = 255;
+  // size atmost 255 chars
   if (name.size() > kMaxSize)
   {
     return false;

diff --git a/sdk/test/metrics/instrument_metadata_validator_test.cc b/sdk/test/metrics/instrument_metadata_validator_test.cc
@@ -19,25 +19,28 @@ TEST(InstrumentMetadataValidator, TestName)
 {
   opentelemetry::sdk::metrics::InstrumentMetaDataValidator validator;
   std::vector<std::string> invalid_names = {
-      "",                                      // empty string
-      "1sdf",                                  // string starting with number
-      "123€AAA€BBB",                           // unicode characters
-      "/\\sdsd",                               // string starting with special character
-      "***sSSs",                               // string starting with special character
-      CreateVeryLargeString(5) + "ABCERTYGJ",  // total 64 charactes
-      CreateVeryLargeString(7),                // string much bigger than 63 chars
+      "",                               // empty string
+      "1sdf",                           // string starting with number
+      "123€AAA€BBB",                    // unicode characters
+      "/\\sdsd",                        // string starting with special character
+      "***sSSs",                        // string starting with special character
+      CreateVeryLargeString(25) + "X",  // total 256 characters
+      CreateVeryLargeString(26),        // string much bigger than 255 characters
   };
   for (auto const &str : invalid_names)
   {
     EXPECT_FALSE(validator.ValidateName(str));
   }
 
   std::vector<std::string> valid_names = {
-      "T",                                    // single char string
-      "s123",                                 // starting with char, followed by numbers
-      "dsdsdsd_-.",                           // string , and valid nonalphanumeric
-      "d1234_-sDSDs.sdsd344",                 // combination of all valid characters
-      CreateVeryLargeString(5) + "ABCERTYG",  // total 63 charactes
+      "T",                                      // single char string
+      "s123",                                   // starting with char, followed by numbers
+      "dsdsdsd_-.",                             // string , and valid nonalphanumeric
+      "d1234_-sDSDs.sdsd344",                   // combination of all valid characters
+      CreateVeryLargeString(5) + "ABCERTYG",    // total 63 characters
+      CreateVeryLargeString(5) + "ABCERTYGJ",   // total 64 characters
+      CreateVeryLargeString(24) + "ABCDEFGHI",  // total 254 characters
+      CreateVeryLargeString(25),                // total 255 characters
   };
   for (auto const &str : valid_names)
   {
Benchmark suite	Current: `f52ec6c`	Previous: `7196ec3`	Ratio
`BM_BaselineBuffer/2`	`10700979.232788086` ns/iter	`3273980.8559417725` ns/iter	`3.27`
`BM_LockFreeBuffer/2`	`4130812.9017798817` ns/iter	`1335993.0515289307` ns/iter	`3.09`