open-telemetry
/
opentelemetry-dotnet
mirror of https://github.com/open-telemetry/opentelemetry-dotnet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add unit as metric name suffix in PrometheusExporter (#2578)

This commit is contained in:
Reiley Yang 2021-11-09 16:38:16 -08:00 committed by GitHub
parent 0ed4ed64f0
commit 27b63614e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
src/OpenTelemetry.Exporter.Prometheus/Implementation/PrometheusSerializer.cs
View File

@ -178,7 +178,7 @@ namespace OpenTelemetry.Exporter.Prometheus
(ordinal >= (ushort)'a' && ordinal <= (ushort)'z') ||
(ordinal >= (ushort)'0' && ordinal <= (ushort)'9'))
{
cursor = WriteUnicodeNoEscape(buffer, cursor, ordinal);
buffer[cursor++] = unchecked((byte)ordinal);
}
else
{
@ -235,7 +235,7 @@ namespace OpenTelemetry.Exporter.Prometheus
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int WriteMetricName(byte[] buffer, int cursor, string metricName)
public static int WriteMetricName(byte[] buffer, int cursor, string metricName, string metricUnit = null)
{
Debug.Assert(!string.IsNullOrEmpty(metricName), $"{nameof(metricName)} should not be null or empty.");
@ -249,21 +249,42 @@ namespace OpenTelemetry.Exporter.Prometheus
buffer[cursor++] = unchecked((byte)'_');
break;
default:
cursor = WriteUnicodeNoEscape(buffer, cursor, ordinal);
buffer[cursor++] = unchecked((byte)ordinal);
break;
}
}
if (!string.IsNullOrEmpty(metricUnit))
{
buffer[cursor++] = unchecked((byte)'_');
for (int i = 0; i < metricUnit.Length; i++)
{
var ordinal = (ushort)metricUnit[i];
if ((ordinal >= (ushort)'A' && ordinal <= (ushort)'Z') ||
(ordinal >= (ushort)'a' && ordinal <= (ushort)'z') ||
(ordinal >= (ushort)'0' && ordinal <= (ushort)'9'))
{
buffer[cursor++] = unchecked((byte)ordinal);
}
else
{
buffer[cursor++] = unchecked((byte)'_');
}
}
}
return cursor;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int WriteHelpText(byte[] buffer, int cursor, string metricName, string metricDescription = null)
public static int WriteHelpText(byte[] buffer, int cursor, string metricName, string metricUnit = null, string metricDescription = null)
{
cursor = WriteAsciiStringNoEscape(buffer, cursor, "# HELP ");
cursor = WriteMetricName(buffer, cursor, metricName);
cursor = WriteMetricName(buffer, cursor, metricName, metricUnit);
if (metricDescription != null)
if (!string.IsNullOrEmpty(metricDescription))
{
buffer[cursor++] = unchecked((byte)' ');
cursor = WriteUnicodeString(buffer, cursor, metricDescription);
@ -275,12 +296,12 @@ namespace OpenTelemetry.Exporter.Prometheus
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int WriteTypeInfo(byte[] buffer, int cursor, string metricName, string metricType)
public static int WriteTypeInfo(byte[] buffer, int cursor, string metricName, string metricUnit, string metricType)
{
Debug.Assert(!string.IsNullOrEmpty(metricType), $"{nameof(metricType)} should not be null or empty.");
cursor = WriteAsciiStringNoEscape(buffer, cursor, "# TYPE ");
cursor = WriteMetricName(buffer, cursor, metricName);
cursor = WriteMetricName(buffer, cursor, metricName, metricUnit);
buffer[cursor++] = unchecked((byte)' ');
cursor = WriteAsciiStringNoEscape(buffer, cursor, metricType);

12
src/OpenTelemetry.Exporter.Prometheus/Implementation/PrometheusSerializerExt.cs
View File

@ -50,11 +50,11 @@ namespace OpenTelemetry.Exporter.Prometheus
{
if (metric.Description != null)
{
cursor = WriteHelpText(buffer, cursor, metric.Name, metric.Description);
cursor = WriteHelpText(buffer, cursor, metric.Name, metric.Unit, metric.Description);
}
int metricType = (int)metric.MetricType >> 4;
cursor = WriteTypeInfo(buffer, cursor, metric.Name, MetricTypes[metricType]);
cursor = WriteTypeInfo(buffer, cursor, metric.Name, metric.Unit, MetricTypes[metricType]);
if (metric.MetricType != MetricType.Histogram)
{
@ -65,7 +65,7 @@ namespace OpenTelemetry.Exporter.Prometheus
var timestamp = metricPoint.EndTime.ToUnixTimeMilliseconds();
// Counter and Gauge
cursor = WriteMetricName(buffer, cursor, metric.Name);
cursor = WriteMetricName(buffer, cursor, metric.Name, metric.Unit);
buffer[cursor++] = unchecked((byte)'{');
for (var i = 0; i < keys.Length; i++)
@ -113,7 +113,7 @@ namespace OpenTelemetry.Exporter.Prometheus
{
totalCount += bucketCounts[idxBound];
cursor = WriteMetricName(buffer, cursor, metric.Name);
cursor = WriteMetricName(buffer, cursor, metric.Name, metric.Unit);
cursor = WriteAsciiStringNoEscape(buffer, cursor, "_bucket{");
for (var i = 0; i < keys.Length; i++)
@ -144,7 +144,7 @@ namespace OpenTelemetry.Exporter.Prometheus
}
// Histogram sum
cursor = WriteMetricName(buffer, cursor, metric.Name);
cursor = WriteMetricName(buffer, cursor, metric.Name, metric.Unit);
cursor = WriteAsciiStringNoEscape(buffer, cursor, "_sum{");
for (var i = 0; i < keys.Length; i++)
@ -168,7 +168,7 @@ namespace OpenTelemetry.Exporter.Prometheus
buffer[cursor++] = ASCII_LINEFEED;
// Histogram count
cursor = WriteMetricName(buffer, cursor, metric.Name);
cursor = WriteMetricName(buffer, cursor, metric.Name, metric.Unit);
cursor = WriteAsciiStringNoEscape(buffer, cursor, "_count{");
for (var i = 0; i < keys.Length; i++)