Skip to content

Commit

Permalink
[EXPORTER] Do not use regex in CleanUpString because some implement…
Browse files Browse the repository at this point in the history
…ations of STL may crash. (#2464)
  • Loading branch information
owent authored Dec 23, 2023
1 parent 0dd5eed commit ddfafff
Showing 1 changed file with 91 additions and 0 deletions.
91 changes: 91 additions & 0 deletions exporters/prometheus/src/exporter_utils.cc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

#include <algorithm>
#include <limits>
#include <regex>
#include <sstream>
Expand All @@ -13,6 +14,7 @@
#include "prometheus/metric_family.h"
#include "prometheus/metric_type.h"

#include "opentelemetry/common/macros.h"
#include "opentelemetry/exporters/prometheus/exporter_utils.h"
#include "opentelemetry/sdk/metrics/export/metric_producer.h"
#include "opentelemetry/sdk/resource/resource.h"
Expand Down Expand Up @@ -280,11 +282,13 @@ std::string PrometheusExporterUtils::SanitizeNames(std::string name)
return name;
}

#if OPENTELEMETRY_HAVE_WORKING_REGEX
std::regex INVALID_CHARACTERS_PATTERN("[^a-zA-Z0-9]");
std::regex CHARACTERS_BETWEEN_BRACES_PATTERN("\\{(.*?)\\}");
std::regex SANITIZE_LEADING_UNDERSCORES("^_+");
std::regex SANITIZE_TRAILING_UNDERSCORES("_+$");
std::regex SANITIZE_CONSECUTIVE_UNDERSCORES("[_]{2,}");
#endif

std::string PrometheusExporterUtils::GetEquivalentPrometheusUnit(
const std::string &raw_metric_unit_name)
Expand Down Expand Up @@ -360,7 +364,32 @@ std::string PrometheusExporterUtils::GetPrometheusPerUnit(const std::string &per

std::string PrometheusExporterUtils::RemoveUnitPortionInBraces(const std::string &unit)
{
#if OPENTELEMETRY_HAVE_WORKING_REGEX
return std::regex_replace(unit, CHARACTERS_BETWEEN_BRACES_PATTERN, "");
#else
bool in_braces = false;
std::string cleaned_unit;
cleaned_unit.reserve(unit.size());
for (auto c : unit)
{
if (in_braces)
{
if (c == '}')
{
in_braces = false;
}
}
else if (c == '{')
{
in_braces = true;
}
else
{
cleaned_unit += c;
}
}
return cleaned_unit;
#endif
}

std::string PrometheusExporterUtils::ConvertRateExpressedToPrometheusUnit(
Expand Down Expand Up @@ -389,12 +418,74 @@ std::string PrometheusExporterUtils::ConvertRateExpressedToPrometheusUnit(

std::string PrometheusExporterUtils::CleanUpString(const std::string &str)
{
#if OPENTELEMETRY_HAVE_WORKING_REGEX
std::string cleaned_string = std::regex_replace(str, INVALID_CHARACTERS_PATTERN, "_");
cleaned_string = std::regex_replace(cleaned_string, SANITIZE_CONSECUTIVE_UNDERSCORES, "_");
cleaned_string = std::regex_replace(cleaned_string, SANITIZE_TRAILING_UNDERSCORES, "");
cleaned_string = std::regex_replace(cleaned_string, SANITIZE_LEADING_UNDERSCORES, "");
return cleaned_string;
#else
std::string cleaned_string = str;
if (cleaned_string.empty())
{
return cleaned_string;
}
std::transform(cleaned_string.begin(), cleaned_string.end(), cleaned_string.begin(),
[](const char c) {
if ((c >= '0' && c <= '9') || (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'))
{
return c;
}
return '_';
});

std::string::size_type trim_start = 0;
std::string::size_type trim_end = 0;
bool previous_underscore = false;
for (std::string::size_type i = 0; i < cleaned_string.size(); ++i)
{
if (cleaned_string[i] == '_')
{
if (previous_underscore)
{
continue;
}

previous_underscore = true;
}
else
{
previous_underscore = false;
}

if (trim_end != i)
{
cleaned_string[trim_end] = cleaned_string[i];
}
++trim_end;
}

while (trim_end > 0 && cleaned_string[trim_end - 1] == '_')
{
--trim_end;
}
while (trim_start < trim_end && cleaned_string[trim_start] == '_')
{
++trim_start;
}

// All characters are underscore
if (trim_start >= trim_end)
{
return "_";
}
if (0 != trim_start || cleaned_string.size() != trim_end)
{
return cleaned_string.substr(trim_start, trim_end - trim_start);
}

return cleaned_string;
#endif
}

std::string PrometheusExporterUtils::MapToPrometheusName(
Expand Down

1 comment on commit ddfafff

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'OpenTelemetry-cpp sdk Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: ddfafff Previous: 0dd5eed Ratio
BM_BaselineBuffer/1 9730093.479156494 ns/iter 2379779.815673828 ns/iter 4.09

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.