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

[AzureMonitorExporter] Remove "sampleRate" tag from SamplingResult #37765

Merged
merged 5 commits into from
Jul 25, 2023
Merged

[AzureMonitorExporter] Remove "sampleRate" tag from SamplingResult #37765

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b34e86
remove sampling tag
TimothyMothra Jul 20, 2023
dcfe684
remove tag
TimothyMothra Jul 20, 2023
a65bd42
pr feedback: if != 100
TimothyMothra Jul 24, 2023
30ddc12
add extra check for SampleRate != 100f
TimothyMothra Jul 24, 2023
c9628ba
remove nullable from method paramaters. update tests.
TimothyMothra Jul 25, 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
8 changes: 5 additions & 3 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/AzureMonitorTraceExporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,17 @@ internal sealed class AzureMonitorTraceExporter : BaseExporter<Activity>
{
private readonly ITransmitter _transmitter;
private readonly string _instrumentationKey;
private readonly float _sampleRate; // This value is recorded on TelemetryItem.SampleRate.
private AzureMonitorResource? _resource;
private bool _disposed;

public AzureMonitorTraceExporter(AzureMonitorExporterOptions options) : this(TransmitterFactory.Instance.Get(options))
public AzureMonitorTraceExporter(AzureMonitorExporterOptions options) : this(options, TransmitterFactory.Instance.Get(options))
{
}

internal AzureMonitorTraceExporter(ITransmitter transmitter)
internal AzureMonitorTraceExporter(AzureMonitorExporterOptions options, ITransmitter transmitter)
{
_sampleRate = (float)Math.Round(options.SamplingRatio * 100);
_transmitter = transmitter;
_instrumentationKey = transmitter.InstrumentationKey;
}
Expand All @@ -40,7 +42,7 @@ public override ExportResult Export(in Batch<Activity> batch)

try
{
var telemetryItems = TraceHelper.OtelToAzureMonitorTrace(batch, TraceResource, _instrumentationKey);
var telemetryItems = TraceHelper.OtelToAzureMonitorTrace(batch, TraceResource, _instrumentationKey, _sampleRate);
TimothyMothra marked this conversation as resolved.
Show resolved Hide resolved
if (telemetryItems.Count > 0)
{
exportResult = _transmitter.TrackAsync(telemetryItems, TelemetryItemOrigin.AzureMonitorTraceExporter, false, CancellationToken.None).EnsureCompleted();
Expand Down
7 changes: 2 additions & 5 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/Models/TelemetryItem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace Azure.Monitor.OpenTelemetry.Exporter.Models
{
internal partial class TelemetryItem
{
public TelemetryItem(Activity activity, ref ActivityTagsProcessor activityTagsProcessor, AzureMonitorResource? resource, string instrumentationKey) :
public TelemetryItem(Activity activity, ref ActivityTagsProcessor activityTagsProcessor, AzureMonitorResource? resource, string instrumentationKey, float? sampleRate = null) :
TimothyMothra marked this conversation as resolved.
Show resolved Hide resolved
this(activity.GetTelemetryType() == TelemetryType.Request ? "Request" : "RemoteDependency", FormatUtcTimestamp(activity.StartTimeUtc))
{
if (activity.ParentSpanId != default)
Expand Down Expand Up @@ -60,10 +60,7 @@ public TelemetryItem(Activity activity, ref ActivityTagsProcessor activityTagsPr

SetAuthenticatedUserId(ref activityTagsProcessor);
SetResourceSdkVersionAndIkey(resource, instrumentationKey);
if (AzMonList.GetTagValue(ref activityTagsProcessor.MappedTags, "sampleRate") is float sampleRate)
{
SampleRate = sampleRate;
}
SampleRate = sampleRate;
TimothyMothra marked this conversation as resolved.
Show resolved Hide resolved
}

public TelemetryItem(string name, TelemetryItem telemetryItem, ActivitySpanId activitySpanId, ActivityKind kind, DateTimeOffset activityEventTimeStamp) :
Expand Down
1 change: 0 additions & 1 deletion sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/ActivityTagsProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ internal struct ActivityTagsProcessor
SemanticConventions.AttributeNetHostName,
SemanticConventions.AttributeComponent,
"otel.status_code",
"sampleRate",

SemanticConventions.AttributeRpcService,
// required - RPC
Expand Down
19 changes: 6 additions & 13 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/ApplicationInsightsSampler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Azure.Monitor.OpenTelemetry.Exporter.Internals;
internal sealed class ApplicationInsightsSampler : Sampler
{
private static readonly SamplingResult RecordOnlySamplingResult = new(SamplingDecision.RecordOnly);
private readonly SamplingResult recordAndSampleSamplingResult;
private static readonly SamplingResult RecordAndSampleSamplingResult = new(SamplingDecision.RecordAndSample);
private readonly float samplingRatio;

/// <summary>
Expand All @@ -34,13 +34,6 @@ public ApplicationInsightsSampler(float samplingRatio)

this.samplingRatio = samplingRatio;
Description = "ApplicationInsightsSampler{" + samplingRatio + "}";
var sampleRate = (float)Math.Round(samplingRatio * 100);
recordAndSampleSamplingResult = new SamplingResult(
SamplingDecision.RecordAndSample,
new Dictionary<string, object>
{
{ "sampleRate", sampleRate },
});
}

/// <summary>
Expand All @@ -51,21 +44,21 @@ public ApplicationInsightsSampler(float samplingRatio)
/// <returns>Returns whether or not we should sample telemetry in the form of a <see cref="SamplingResult"/> class.</returns>
public override SamplingResult ShouldSample(in SamplingParameters samplingParameters)
{
if (samplingRatio == 0)
if (samplingRatio == 1)
{
return RecordOnlySamplingResult;
return RecordAndSampleSamplingResult;
}

if (samplingRatio == 1)
if (samplingRatio == 0)
{
return recordAndSampleSamplingResult;
return RecordOnlySamplingResult;
TimothyMothra marked this conversation as resolved.
Show resolved Hide resolved
}

double sampleScore = DJB2SampleScore(samplingParameters.TraceId.ToHexString().ToUpperInvariant());

if (sampleScore < samplingRatio)
{
return recordAndSampleSamplingResult;
return RecordAndSampleSamplingResult;
}
else
{
Expand Down
4 changes: 2 additions & 2 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/TraceHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ internal static class TraceHelper
private const int Version = 2;
private const int MaxlinksAllowed = 100;

internal static List<TelemetryItem> OtelToAzureMonitorTrace(Batch<Activity> batchActivity, AzureMonitorResource? azureMonitorResource, string instrumentationKey)
internal static List<TelemetryItem> OtelToAzureMonitorTrace(Batch<Activity> batchActivity, AzureMonitorResource? azureMonitorResource, string instrumentationKey, float? sampleRate = null)
{
List<TelemetryItem> telemetryItems = new List<TelemetryItem>();
TelemetryItem telemetryItem;
Expand All @@ -34,7 +34,7 @@ internal static List<TelemetryItem> OtelToAzureMonitorTrace(Batch<Activity> batc
try
{
var activityTagsProcessor = EnumerateActivityTags(activity);
telemetryItem = new TelemetryItem(activity, ref activityTagsProcessor, azureMonitorResource, instrumentationKey);
telemetryItem = new TelemetryItem(activity, ref activityTagsProcessor, azureMonitorResource, instrumentationKey, sampleRate);

// Check for Exceptions events
if (activity.Events.Any())
Expand Down
10 changes: 8 additions & 2 deletions ...or.OpenTelemetry.Exporter.Tests/CommonTestFramework/AzureMonitorExporterTestExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using Azure.Monitor.OpenTelemetry.Exporter.Internals;
using Azure.Monitor.OpenTelemetry.Exporter.Models;
using OpenTelemetry;
using OpenTelemetry.Logs;
Expand Down Expand Up @@ -69,7 +70,7 @@ internal static MeterProviderBuilder AddAzureMonitorMetricExporterForTest(this M
/// <summary>
/// Extension methods to simplify registering of <see cref="AzureMonitorTraceExporter"/> with <see cref="MockTransmitter"/> for unit tests.
/// </summary>
internal static TracerProviderBuilder AddAzureMonitorTraceExporterForTest(this TracerProviderBuilder builder, out List<TelemetryItem> telemetryItems)
internal static TracerProviderBuilder AddAzureMonitorTraceExporterForTest(this TracerProviderBuilder builder, out List<TelemetryItem> telemetryItems, Action<AzureMonitorExporterOptions>? configure = null)
{
if (builder == null)
{
Expand All @@ -78,7 +79,12 @@ internal static TracerProviderBuilder AddAzureMonitorTraceExporterForTest(this T

telemetryItems = new List<TelemetryItem>();

return builder.AddProcessor(new SimpleActivityExportProcessor(new AzureMonitorTraceExporter(new MockTransmitter(telemetryItems))));
var options = new AzureMonitorExporterOptions();
configure?.Invoke(options);

builder.SetSampler(new ApplicationInsightsSampler(options.SamplingRatio));

return builder.AddProcessor(new SimpleActivityExportProcessor(new AzureMonitorTraceExporter(options, new MockTransmitter(telemetryItems))));
}
}
}
45 changes: 10 additions & 35 deletions ...penTelemetry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/SampleRateTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,65 +35,42 @@ static SampleRateTests()

[Theory]
[InlineData(50.0F)]
[InlineData("somestring")]
[InlineData(null)]
[InlineData("")]
public void ValidateSampleRateForEventException(object SampleRate)
public void ValidateSampleRateForEventException(float? sampleRate)
{
using ActivitySource activitySource = new ActivitySource(ActivitySourceName);

// Valid SampleRate.
using var activity = activitySource.StartActivity(
ActivityName,
ActivityKind.Client,
parentContext: default,
startTime: DateTime.UtcNow,
tags: new Dictionary<string, object?>() { ["sampleRate"] = SampleRate });
startTime: DateTime.UtcNow);

Assert.NotNull(activity);
var activityTagsProcessor = TraceHelper.EnumerateActivityTags(activity);
var telemetryItem = new TelemetryItem(activity, ref activityTagsProcessor, null, "00000000-0000-0000-0000-000000000000");
var telemetryItem = new TelemetryItem(activity, ref activityTagsProcessor, null, "00000000-0000-0000-0000-000000000000", sampleRate);
var expTelemetryItem = new TelemetryItem("Exception", telemetryItem, default, default, default);

if (SampleRate is float)
{
Assert.Equal(SampleRate, expTelemetryItem.SampleRate);
}
else
{
Assert.Null(expTelemetryItem.SampleRate);
}
Assert.Equal(sampleRate, expTelemetryItem.SampleRate);
}

[Theory]
[InlineData(50.0F)]
[InlineData("somestring")]
[InlineData(null)]
[InlineData("")]
public void ValidateSampleRateInTelemetry(object SampleRate)
public void ValidateSampleRateInTelemetry(float? sampleRate)
{
using ActivitySource activitySource = new ActivitySource(ActivitySourceName);

// Valid SampleRate.
using var activity = activitySource.StartActivity(
ActivityName,
ActivityKind.Client,
parentContext: default,
startTime: DateTime.UtcNow,
tags: new Dictionary<string, object?>() { ["sampleRate"] = SampleRate });
startTime: DateTime.UtcNow);

Assert.NotNull(activity);
var activityTagsProcessor = TraceHelper.EnumerateActivityTags(activity);
var telemetryItem = new TelemetryItem(activity, ref activityTagsProcessor, null, "00000000-0000-0000-0000-000000000000");
var telemetryItem = new TelemetryItem(activity, ref activityTagsProcessor, null, "00000000-0000-0000-0000-000000000000", sampleRate);

if (SampleRate is float)
{
Assert.Equal(SampleRate, telemetryItem.SampleRate);
}
else
{
Assert.Null(telemetryItem.SampleRate);
}
Assert.Equal(sampleRate, telemetryItem.SampleRate);
}

[Fact]
Expand All @@ -102,8 +79,7 @@ public void SampleRateE2ETest()
using var activitySource = new ActivitySource(ActivitySourceName);
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddSource(ActivitySourceName)
.SetSampler(new ApplicationInsightsSampler(samplingRatio: 1.0F))
.AddAzureMonitorTraceExporterForTest(out List<TelemetryItem> telemetryItems)
.AddAzureMonitorTraceExporterForTest(out List<TelemetryItem> telemetryItems, options => options.SamplingRatio = 1.0F)
.Build();

using (var activity = activitySource.StartActivity("SayHello"))
Expand All @@ -122,8 +98,7 @@ public void NoTelemetryCreatedOnZeroSampleRate()
using var activitySource = new ActivitySource(ActivitySourceName);
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddSource(ActivitySourceName)
.SetSampler(new ApplicationInsightsSampler(samplingRatio: 0.0F))
.AddAzureMonitorTraceExporterForTest(out List<TelemetryItem> telemetryItems)
.AddAzureMonitorTraceExporterForTest(out List<TelemetryItem> telemetryItems, options => options.SamplingRatio = 0.0F)
.Build();

using (var activity = activitySource.StartActivity("SayHello"))
Expand Down
12 changes: 6 additions & 6 deletions ...elemetry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/StandardMetricTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public void ValidateRequestDurationMetric()
.SetResourceBuilder(ResourceBuilder.CreateDefault().AddAttributes(resourceAttributes))
.AddSource(nameof(StandardMetricTests.ValidateRequestDurationMetric))
.AddProcessor(standardMetricCustomProcessor)
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new MockTransmitter(traceTelemetryItems))))
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new AzureMonitorExporterOptions(), new MockTransmitter(traceTelemetryItems))))
.Build();

using (var activity = activitySource.StartActivity("Test", ActivityKind.Server))
Expand Down Expand Up @@ -85,7 +85,7 @@ public void ValidateRequestDurationMetricNew()
.SetResourceBuilder(ResourceBuilder.CreateDefault().AddAttributes(resourceAttributes))
.AddSource(nameof(StandardMetricTests.ValidateRequestDurationMetric))
.AddProcessor(standardMetricCustomProcessor)
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new MockTransmitter(traceTelemetryItems))))
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new AzureMonitorExporterOptions(), new MockTransmitter(traceTelemetryItems))))
.Build();

using (var activity = activitySource.StartActivity("Test", ActivityKind.Server))
Expand Down Expand Up @@ -134,7 +134,7 @@ public void ValidateDependencyDurationMetric()
.SetResourceBuilder(ResourceBuilder.CreateDefault().AddAttributes(resourceAttributes))
.AddSource(nameof(StandardMetricTests.ValidateDependencyDurationMetric))
.AddProcessor(standardMetricCustomProcessor)
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new MockTransmitter(traceTelemetryItems))))
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new AzureMonitorExporterOptions(), new MockTransmitter(traceTelemetryItems))))
.Build();

using (var activity = activitySource.StartActivity("Test", ActivityKind.Client))
Expand Down Expand Up @@ -189,7 +189,7 @@ public void ValidateDependencyDurationMetricNew()
.SetResourceBuilder(ResourceBuilder.CreateDefault().AddAttributes(resourceAttributes))
.AddSource(nameof(StandardMetricTests.ValidateDependencyDurationMetric))
.AddProcessor(standardMetricCustomProcessor)
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new MockTransmitter(traceTelemetryItems))))
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new AzureMonitorExporterOptions(), new MockTransmitter(traceTelemetryItems))))
.Build();

using (var activity = activitySource.StartActivity("Test", ActivityKind.Client))
Expand Down Expand Up @@ -242,7 +242,7 @@ public void ValidateNullStatusCode(ActivityKind kind)
.SetSampler(new AlwaysOnSampler())
.AddSource(nameof(StandardMetricTests.ValidateNullStatusCode))
.AddProcessor(standardMetricCustomProcessor)
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new MockTransmitter(traceTelemetryItems))))
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new AzureMonitorExporterOptions(), new MockTransmitter(traceTelemetryItems))))
.Build();

using (var activity = activitySource.StartActivity("Test", kind))
Expand Down Expand Up @@ -290,7 +290,7 @@ public void ValidateNullStatusCodeNew(ActivityKind kind)
.SetSampler(new AlwaysOnSampler())
.AddSource(nameof(StandardMetricTests.ValidateNullStatusCode))
.AddProcessor(standardMetricCustomProcessor)
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new MockTransmitter(traceTelemetryItems))))
.AddProcessor(new BatchActivityExportProcessor(new AzureMonitorTraceExporter(new AzureMonitorExporterOptions(), new MockTransmitter(traceTelemetryItems))))
.Build();

using (var activity = activitySource.StartActivity("Test", kind))
Expand Down