Skip to content

Enable UpDownCounter For Dotnet-Monitor #4310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 9, 2023
Merged

Enable UpDownCounter For Dotnet-Monitor #4310

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1fc0fe
Adding support for UpDownCounter reporting a value instead of a rate
kkeirstead Apr 17, 2023
08044cf
Update MetricsFormattingTests.cs
kkeirstead Jun 9, 2023
cff20bb
Update MetricsFormattingTests.cs
kkeirstead Jun 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Microsoft.Diagnostics.Monitoring.WebApi/Metrics/MetricsStore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ private static string GetMetricType(EventType eventType)
{
// In Prometheus, rates are treated as gauges due to their non-monotonic nature
case EventType.Rate:
case EventType.UpDownCounter:
case EventType.Gauge:
return "gauge";
case EventType.Histogram:
Expand Down
23 changes: 17 additions & 6 deletions src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTests/MetricsFormattingTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@ public async Task HistogramFormat_Test()
using MemoryStream stream = await GetMetrics(payload);
List<string> lines = ReadStream(stream);

// Question - this is manually recreating what PrometheusDataModel.GetPrometheusNormalizedName does to get the metric name;
// should we call this method, or should this also be implicitly testing its behavior by having this hard-coded?
string metricName = $"{MeterName.ToLowerInvariant()}_{payload[0].Name}";

const string quantile_50 = "{quantile=\"0.5\"}";
Expand All @@ -74,8 +72,6 @@ public async Task GaugeFormat_Test()

List<string> lines = ReadStream(stream);

// Question - this is manually recreating what PrometheusDataModel.GetPrometheusNormalizedName does to get the metric name;
// should we call this method, or should this also be implicitly testing its behavior by having this hard-coded?
string metricName = $"{MeterName.ToLowerInvariant()}_{payload.Name}";

Assert.Equal(3, lines.Count);
Expand All @@ -93,8 +89,6 @@ public async Task CounterFormat_Test()

List<string> lines = ReadStream(stream);

// Question - this is manually recreating what PrometheusDataModel.GetPrometheusNormalizedName does to get the metric name;
// should we call this method, or should this also be implicitly testing its behavior by having this hard-coded?
string metricName = $"{MeterName.ToLowerInvariant()}_{payload.Name}";

Assert.Equal(3, lines.Count);
Expand All @@ -103,6 +97,23 @@ public async Task CounterFormat_Test()
Assert.Equal($"{metricName} {payload.Value} {new DateTimeOffset(payload.Timestamp).ToUnixTimeMilliseconds()}", lines[2]);
}

[Fact]
public async Task UpDownCounterFormat_Test()
{
ICounterPayload payload = new UpDownCounterPayload(MeterName, InstrumentName, "DisplayName", "", null, Value1, Timestamp);

MemoryStream stream = await GetMetrics(new() { payload });

List<string> lines = ReadStream(stream);

string metricName = $"{MeterName.ToLowerInvariant()}_{payload.Name}";

Assert.Equal(3, lines.Count);
Assert.Equal(FormattableString.Invariant($"# HELP {metricName}{payload.Unit} {payload.DisplayName}"), lines[0]);
Assert.Equal(FormattableString.Invariant($"# TYPE {metricName} gauge"), lines[1]);
Assert.Equal(FormattableString.Invariant($"{metricName} {payload.Value} {new DateTimeOffset(payload.Timestamp).ToUnixTimeMilliseconds()}"), lines[2]);
}

private async Task<MemoryStream> GetMetrics(List<ICounterPayload> payloads)
{
IMetricsStore metricsStore = new MetricsStore(_logger, MetricCount);
Expand Down