Skip to content
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

[sdk-metrics] Remove ExemplarFilter classes #5408

Merged
merged 6 commits into from
Mar 5, 2024
Merged

[sdk-metrics] Remove ExemplarFilter classes #5408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a6e5a38
Remove ExemplarFilter classes.
CodeBlanch Mar 4, 2024
19271f5
Tweak.
CodeBlanch Mar 4, 2024
cd9ab09
Merge branch 'main' into sdk-metrics-removefilterclasses
CodeBlanch Mar 4, 2024
8f9d5f0
Code review.
CodeBlanch Mar 4, 2024
cc00c52
Merge branch 'sdk-metrics-removefilterclasses' of https://github.com/…
CodeBlanch Mar 4, 2024
08a51f8
Tweaks.
CodeBlanch Mar 4, 2024
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
246 changes: 101 additions & 145 deletions src/OpenTelemetry/Metrics/AggregatorStore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ internal sealed class AggregatorStore
internal readonly Func<ExemplarReservoir?>? ExemplarReservoirFactory;
internal long DroppedMeasurements = 0;

private const ExemplarFilterType DefaultExemplarFilter = ExemplarFilterType.AlwaysOff;
private static readonly string MetricPointCapHitFixMessage = "Consider opting in for the experimental SDK feature to emit all the throttled metrics under the overflow attribute by setting env variable OTEL_DOTNET_EXPERIMENTAL_METRICS_EMIT_OVERFLOW_ATTRIBUTE = true. You could also modify instrumentation to reduce the number of unique key/value pair combinations. Or use Views to drop unwanted tags. Or use MeterProviderBuilder.SetMaxMetricPointsPerMetricStream to set higher limit.";
private static readonly Comparison<KeyValuePair<string, object?>> DimensionComparisonDelegate = (x, y) => x.Key.CompareTo(y.Key);
private static readonly ExemplarFilter DefaultExemplarFilter = new AlwaysOffExemplarFilter();

private readonly object lockZeroTags = new();
private readonly object lockOverflowTag = new();
Expand All @@ -44,7 +44,7 @@ internal sealed class AggregatorStore
private readonly int exponentialHistogramMaxScale;
private readonly UpdateLongDelegate updateLongCallback;
private readonly UpdateDoubleDelegate updateDoubleCallback;
private readonly ExemplarFilter exemplarFilter;
private readonly ExemplarFilterType exemplarFilter;
private readonly Func<KeyValuePair<string, object?>[], int, int> lookupAggregatorStore;

private int metricPointIndex = 0;
Expand All @@ -60,7 +60,7 @@ internal AggregatorStore(
int cardinalityLimit,
bool emitOverflowAttribute,
bool shouldReclaimUnusedMetricPoints,
ExemplarFilter? exemplarFilter = null,
ExemplarFilterType? exemplarFilter = null,
Func<ExemplarReservoir?>? exemplarReservoirFactory = null)
{
this.name = metricStreamIdentity.InstrumentName;
Expand All @@ -75,7 +75,6 @@ internal AggregatorStore(
this.exponentialHistogramMaxSize = metricStreamIdentity.ExponentialHistogramMaxSize;
this.exponentialHistogramMaxScale = metricStreamIdentity.ExponentialHistogramMaxScale;
this.StartTimeExclusive = DateTimeOffset.UtcNow;
this.exemplarFilter = exemplarFilter ?? DefaultExemplarFilter;
this.ExemplarReservoirFactory = exemplarReservoirFactory;
if (metricStreamIdentity.TagKeys == null)
{
Expand All @@ -93,6 +92,13 @@ internal AggregatorStore(

this.EmitOverflowAttribute = emitOverflowAttribute;

this.exemplarFilter = exemplarFilter ?? DefaultExemplarFilter;
Debug.Assert(
this.exemplarFilter == ExemplarFilterType.AlwaysOff
|| this.exemplarFilter == ExemplarFilterType.AlwaysOn
|| this.exemplarFilter == ExemplarFilterType.TraceBased,
"this.exemplarFilter had an unexpected value");

var reservedMetricPointsCount = 1;

if (emitOverflowAttribute)
Expand Down Expand Up @@ -144,17 +150,33 @@ internal bool IsExemplarEnabled()
{
// Using this filter to indicate On/Off
// instead of another separate flag.
return this.exemplarFilter is not AlwaysOffExemplarFilter;
return this.exemplarFilter != ExemplarFilterType.AlwaysOff;
}

internal void Update(long value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
this.updateLongCallback(value, tags);
try
{
this.updateLongCallback(value, tags);
}
catch (Exception)
{
Interlocked.Increment(ref this.DroppedMeasurements);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, "SDK internal error occurred.", "Contact SDK owners.");
}
}

internal void Update(double value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
this.updateDoubleCallback(value, tags);
try
{
this.updateDoubleCallback(value, tags);
}
catch (Exception)
{
Interlocked.Increment(ref this.DroppedMeasurements);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, "SDK internal error occurred.", "Contact SDK owners.");
}
}

internal int Snapshot()
Expand Down Expand Up @@ -924,177 +946,111 @@ private int RemoveStaleEntriesAndGetAvailableMetricPointRare(LookupData lookupDa

private void UpdateLong(long value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
try
{
var index = this.FindMetricAggregatorsDefault(tags);
if (index < 0)
{
Interlocked.Increment(ref this.DroppedMeasurements);

if (this.EmitOverflowAttribute)
{
this.InitializeOverflowTagPointIfNotInitialized();
this.metricPoints[1].Update(value);
return;
}
else
{
if (Interlocked.CompareExchange(ref this.metricCapHitMessageLogged, 1, 0) == 0)
{
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, this.metricPointCapHitMessage, MetricPointCapHitFixMessage);
}

return;
}
}
var index = this.FindMetricAggregatorsDefault(tags);

// TODO: can special case built-in filters to be bit faster.
if (this.IsExemplarEnabled())
{
var shouldSample = this.exemplarFilter.ShouldSample(value, tags);
this.metricPoints[index].UpdateWithExemplar(value, tags: default, shouldSample);
}
else
{
this.metricPoints[index].Update(value);
}
}
catch (Exception)
{
Interlocked.Increment(ref this.DroppedMeasurements);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, "SDK internal error occurred.", "Contact SDK owners.");
}
this.UpdateLongMetricPoint(index, value, tags: default);
}

private void UpdateLongCustomTags(long value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
try
{
var index = this.FindMetricAggregatorsCustomTag(tags);
if (index < 0)
{
Interlocked.Increment(ref this.DroppedMeasurements);
var index = this.FindMetricAggregatorsCustomTag(tags);

if (this.EmitOverflowAttribute)
{
this.InitializeOverflowTagPointIfNotInitialized();
this.metricPoints[1].Update(value);
return;
}
else
{
if (Interlocked.CompareExchange(ref this.metricCapHitMessageLogged, 1, 0) == 0)
{
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, this.metricPointCapHitMessage, MetricPointCapHitFixMessage);
}
this.UpdateLongMetricPoint(index, value, tags);
}

return;
}
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private void UpdateLongMetricPoint(int metricPointIndex, long value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
if (metricPointIndex < 0)
{
Interlocked.Increment(ref this.DroppedMeasurements);

// TODO: can special case built-in filters to be bit faster.
if (this.IsExemplarEnabled())
if (this.EmitOverflowAttribute)
{
var shouldSample = this.exemplarFilter.ShouldSample(value, tags);
this.metricPoints[index].UpdateWithExemplar(value, tags, shouldSample);
this.InitializeOverflowTagPointIfNotInitialized();
this.metricPoints[1].Update(value);
}
else
else if (Interlocked.CompareExchange(ref this.metricCapHitMessageLogged, 1, 0) == 0)
{
this.metricPoints[index].Update(value);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, this.metricPointCapHitMessage, MetricPointCapHitFixMessage);
}

return;
}
catch (Exception)

var exemplarFilterType = this.exemplarFilter;
if (exemplarFilterType == ExemplarFilterType.AlwaysOff)
{
Interlocked.Increment(ref this.DroppedMeasurements);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, "SDK internal error occurred.", "Contact SDK owners.");
this.metricPoints[metricPointIndex].Update(value);
}
else if (exemplarFilterType == ExemplarFilterType.AlwaysOn)
{
this.metricPoints[metricPointIndex].UpdateWithExemplar(
value,
tags,
isSampled: true);
}
else
{
this.metricPoints[metricPointIndex].UpdateWithExemplar(
value,
tags,
isSampled: Activity.Current?.Recorded ?? false);
}
}

private void UpdateDouble(double value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
try
{
var index = this.FindMetricAggregatorsDefault(tags);
if (index < 0)
{
Interlocked.Increment(ref this.DroppedMeasurements);
var index = this.FindMetricAggregatorsDefault(tags);

if (this.EmitOverflowAttribute)
{
this.InitializeOverflowTagPointIfNotInitialized();
this.metricPoints[1].Update(value);
return;
}
else
{
if (Interlocked.CompareExchange(ref this.metricCapHitMessageLogged, 1, 0) == 0)
{
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, this.metricPointCapHitMessage, MetricPointCapHitFixMessage);
}

return;
}
}

// TODO: can special case built-in filters to be bit faster.
if (this.IsExemplarEnabled())
{
var shouldSample = this.exemplarFilter.ShouldSample(value, tags);
this.metricPoints[index].UpdateWithExemplar(value, tags: default, shouldSample);
}
else
{
this.metricPoints[index].Update(value);
}
}
catch (Exception)
{
Interlocked.Increment(ref this.DroppedMeasurements);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, "SDK internal error occurred.", "Contact SDK owners.");
}
this.UpdateDoubleMetricPoint(index, value, tags: default);
}

private void UpdateDoubleCustomTags(double value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
try
{
var index = this.FindMetricAggregatorsCustomTag(tags);
if (index < 0)
{
Interlocked.Increment(ref this.DroppedMeasurements);
var index = this.FindMetricAggregatorsCustomTag(tags);

if (this.EmitOverflowAttribute)
{
this.InitializeOverflowTagPointIfNotInitialized();
this.metricPoints[1].Update(value);
return;
}
else
{
if (Interlocked.CompareExchange(ref this.metricCapHitMessageLogged, 1, 0) == 0)
{
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, this.metricPointCapHitMessage, MetricPointCapHitFixMessage);
}
this.UpdateDoubleMetricPoint(index, value, tags);
}

return;
}
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private void UpdateDoubleMetricPoint(int metricPointIndex, double value, ReadOnlySpan<KeyValuePair<string, object?>> tags)
{
if (metricPointIndex < 0)
{
Interlocked.Increment(ref this.DroppedMeasurements);

// TODO: can special case built-in filters to be bit faster.
if (this.IsExemplarEnabled())
if (this.EmitOverflowAttribute)
{
var shouldSample = this.exemplarFilter.ShouldSample(value, tags);
this.metricPoints[index].UpdateWithExemplar(value, tags, shouldSample);
this.InitializeOverflowTagPointIfNotInitialized();
this.metricPoints[1].Update(value);
}
else
else if (Interlocked.CompareExchange(ref this.metricCapHitMessageLogged, 1, 0) == 0)
{
this.metricPoints[index].Update(value);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, this.metricPointCapHitMessage, MetricPointCapHitFixMessage);
}

return;
}
catch (Exception)

var exemplarFilterType = this.exemplarFilter;
if (exemplarFilterType == ExemplarFilterType.AlwaysOff)
{
Interlocked.Increment(ref this.DroppedMeasurements);
OpenTelemetrySdkEventSource.Log.MeasurementDropped(this.name, "SDK internal error occurred.", "Contact SDK owners.");
this.metricPoints[metricPointIndex].Update(value);
}
else if (exemplarFilterType == ExemplarFilterType.AlwaysOn)
{
this.metricPoints[metricPointIndex].UpdateWithExemplar(
value,
tags,
isSampled: true);
}
else
{
this.metricPoints[metricPointIndex].UpdateWithExemplar(
value,
tags,
isSampled: Activity.Current?.Recorded ?? false);
}
}

Expand Down
6 changes: 1 addition & 5 deletions src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,13 +356,9 @@ static MeterProviderBuilder SetExemplarFilter(
switch (exemplarFilter)
{
case ExemplarFilterType.AlwaysOn:
CodeBlanch marked this conversation as resolved.
Show resolved Hide resolved
meterProviderBuilderSdk.SetExemplarFilter(new AlwaysOnExemplarFilter());
break;
case ExemplarFilterType.AlwaysOff:
meterProviderBuilderSdk.SetExemplarFilter(new AlwaysOffExemplarFilter());
break;
case ExemplarFilterType.TraceBased:
meterProviderBuilderSdk.SetExemplarFilter(new TraceBasedExemplarFilter());
meterProviderBuilderSdk.SetExemplarFilter(exemplarFilter);
break;
default:
throw new NotSupportedException($"SdkExemplarFilter '{exemplarFilter}' is not supported.");
Expand Down
6 changes: 2 additions & 4 deletions src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderSdk.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public MeterProviderBuilderSdk(IServiceProvider serviceProvider)

public ResourceBuilder? ResourceBuilder { get; private set; }

public ExemplarFilter? ExemplarFilter { get; private set; }
public ExemplarFilterType? ExemplarFilter { get; private set; }

public MeterProvider? Provider => this.meterProvider;

Expand Down Expand Up @@ -145,10 +145,8 @@ public MeterProviderBuilder SetResourceBuilder(ResourceBuilder resourceBuilder)
return this;
}

public MeterProviderBuilder SetExemplarFilter(ExemplarFilter exemplarFilter)
public MeterProviderBuilder SetExemplarFilter(ExemplarFilterType exemplarFilter)
{
Debug.Assert(exemplarFilter != null, "exemplarFilter was null");

this.ExemplarFilter = exemplarFilter;

return this;
Expand Down
Loading