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

[Tracer] Elasticsearch Refactor Part 1 (AIT-8764) #4767

Merged
merged 4 commits into from
Nov 1, 2023
Merged

[Tracer] Elasticsearch Refactor Part 1 (AIT-8764) #4767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c153345
Add snapshot tests for Elasticsearch integration tests
zacharycmontoya Oct 26, 2023
1c73b75
Remove path as a fallback source for the Elasticsearch resource name,…
zacharycmontoya Oct 26, 2023
c62924d
Fix Elasticsearch7 snapshot issue, potentially
zacharycmontoya Oct 30, 2023
5c045df
After .NET 8 rebase, update snapshots with SourceLink tags
zacharycmontoya Oct 31, 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
9 changes: 4 additions & 5 deletions ...src/Datadog.Trace/ClrProfiler/AutoInstrumentation/Elasticsearch/ElasticsearchNetCommon.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,16 @@ public static Scope CreateScope<T>(Tracer tracer, IntegrationId integrationId, R
return null;
}

var pathAndQuery = requestData.Path;
string method = requestData.Method;
string method = requestData.Method.ToString();
var url = requestData.Uri?.ToString();

var scope = CreateScope(tracer, integrationId, pathAndQuery, method, pipeline.RequestParameters, out var tags);
var scope = CreateScope(tracer, integrationId, method, pipeline.RequestParameters, out var tags);
tags.Url = url;
tags.Host = HttpRequestUtils.GetNormalizedHost(requestData.Uri?.Host);
return scope;
}

public static Scope CreateScope(Tracer tracer, IntegrationId integrationId, string path, string method, object requestParameters, out ElasticsearchTags tags)
public static Scope CreateScope(Tracer tracer, IntegrationId integrationId, string method, object requestParameters, out ElasticsearchTags tags)
{
if (!tracer.Settings.IsIntegrationEnabled(integrationId))
{
Expand All @@ -61,7 +60,7 @@ public static Scope CreateScope(Tracer tracer, IntegrationId integrationId, stri
{
scope = tracer.StartActiveInternal(operationName, serviceName: serviceName, tags: tags);
var span = scope.Span;
span.ResourceName = requestName ?? path ?? string.Empty;
span.ResourceName = requestName ?? string.Empty;
span.Type = DatabaseType;
tags.Action = requestName;
tags.Method = method;
Expand Down
7 changes: 1 addition & 6 deletions tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/Elasticsearch/IRequestData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@ namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.Elasticsearch
/// </summary>
internal interface IRequestData
{
/// <summary>
/// Gets the path of the request
/// </summary>
string Path { get; }

/// <summary>
/// Gets the URI of the request
/// </summary>
Expand All @@ -25,6 +20,6 @@ internal interface IRequestData
/// <summary>
/// Gets the HTTP method of the request
/// </summary>
string Method { get; }
HttpMethod Method { get; }
}
}
37 changes: 0 additions & 37 deletions tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/Elasticsearch/V5/RequestDataV5.cs
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion ...utoInstrumentation/Elasticsearch/V5/RequestPipeline_CallElasticsearchAsync_Integration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ public class RequestPipeline_CallElasticsearchAsync_Integration
/// <param name="cancellationToken">The cancellation token</param>
/// <returns>Calltarget state value</returns>
internal static CallTargetState OnMethodBegin<TTarget, TRequestData>(TTarget instance, TRequestData requestData, CancellationToken cancellationToken)
where TRequestData : IRequestData
{
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV5Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), new RequestDataV5(requestData));
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV5Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), requestData);

return new CallTargetState(scope);
}
Expand Down
3 changes: 2 additions & 1 deletion ...ler/AutoInstrumentation/Elasticsearch/V5/RequestPipeline_CallElasticsearch_Integration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ public class RequestPipeline_CallElasticsearch_Integration
/// <param name="requestData">The request data</param>
/// <returns>Calltarget state value</returns>
internal static CallTargetState OnMethodBegin<TTarget, TRequestData>(TTarget instance, TRequestData requestData)
where TRequestData : IRequestData
{
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV5Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), new RequestDataV5(requestData));
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV5Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), requestData);

return new CallTargetState(scope);
}
Expand Down
37 changes: 0 additions & 37 deletions tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/Elasticsearch/V6/RequestDataV6.cs
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion ...utoInstrumentation/Elasticsearch/V6/RequestPipeline_CallElasticsearchAsync_Integration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ public class RequestPipeline_CallElasticsearchAsync_Integration
/// <param name="cancellationToken">The cancellation token</param>
/// <returns>Calltarget state value</returns>
internal static CallTargetState OnMethodBegin<TTarget, TRequestData>(TTarget instance, TRequestData requestData, CancellationToken cancellationToken)
where TRequestData : IRequestData
{
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV6Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), new RequestDataV6(requestData));
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV6Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), requestData);

return new CallTargetState(scope);
}
Expand Down
3 changes: 2 additions & 1 deletion ...ler/AutoInstrumentation/Elasticsearch/V6/RequestPipeline_CallElasticsearch_Integration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ public class RequestPipeline_CallElasticsearch_Integration
/// <param name="requestData">The request data</param>
/// <returns>Calltarget state value</returns>
internal static CallTargetState OnMethodBegin<TTarget, TRequestData>(TTarget instance, TRequestData requestData)
where TRequestData : IRequestData
{
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV6Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), new RequestDataV6(requestData));
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV6Constants.IntegrationId, instance.DuckCast<RequestPipelineStruct>(), requestData);

return new CallTargetState(scope);
}
Expand Down
2 changes: 1 addition & 1 deletion ...ce/ClrProfiler/AutoInstrumentation/Elasticsearch/V7/Transport_RequestAsync_Integration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public class Transport_RequestAsync_Integration
/// <returns>Calltarget state value</returns>
internal static CallTargetState OnMethodBegin<TTarget, THttpMethod, TPostData, TRequestParameters>(TTarget instance, THttpMethod method, string path, CancellationToken cancellationToken, TPostData postData, TRequestParameters requestParameters)
{
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV7Constants.IntegrationId, path, method.ToString(), requestParameters, out var tags);
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV7Constants.IntegrationId, method.ToString(), requestParameters, out var tags);

return new CallTargetState(scope, tags);
}
Expand Down
2 changes: 1 addition & 1 deletion ...g.Trace/ClrProfiler/AutoInstrumentation/Elasticsearch/V7/Transport_Request_Integration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public class Transport_Request_Integration
/// <returns>Calltarget state value</returns>
internal static CallTargetState OnMethodBegin<TTarget, THttpMethod, TPostData, TRequestParameters>(TTarget instance, THttpMethod method, string path, TPostData postData, TRequestParameters requestParameters)
{
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV7Constants.IntegrationId, path, method.ToString(), requestParameters, out var tags);
var scope = ElasticsearchNetCommon.CreateScope(Tracer.Instance, ElasticsearchV7Constants.IntegrationId, method.ToString(), requestParameters, out var tags);

return new CallTargetState(scope, tags);
}
Expand Down
30 changes: 28 additions & 2 deletions tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests/Elasticsearch5Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,29 @@
// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
// </copyright>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Datadog.Trace.Configuration;
using Datadog.Trace.ExtensionMethods;
using Datadog.Trace.TestHelpers;
using VerifyXunit;
using Xunit;
using Xunit.Abstractions;

namespace Datadog.Trace.ClrProfiler.IntegrationTests
{
[Trait("RequiresDockerDependency", "true")]
[UsesVerify]
public class Elasticsearch5Tests : TracingIntegrationTest
{
private const string ServiceName = "Samples.Elasticsearch";

public Elasticsearch5Tests(ITestOutputHelper output)
: base("Elasticsearch.V5", output)
{
SetServiceName(ServiceName);
SetServiceVersion("1.0.0");
}

Expand All @@ -33,11 +40,11 @@ public static IEnumerable<object[]> GetEnabledConfig()
[MemberData(nameof(GetEnabledConfig))]
[Trait("Category", "EndToEnd")]
[Trait("Category", "ArmUnsupported")]
public void SubmitsTraces(string packageVersion, string metadataSchemaVersion)
public async Task SubmitsTraces(string packageVersion, string metadataSchemaVersion)
{
SetEnvironmentVariable("DD_TRACE_SPAN_ATTRIBUTE_SCHEMA", metadataSchemaVersion);
var isExternalSpan = metadataSchemaVersion == "v0";
var clientSpanServiceName = isExternalSpan ? $"{EnvironmentHelper.FullSampleName}-elasticsearch" : EnvironmentHelper.FullSampleName;
var clientSpanServiceName = isExternalSpan ? $"{ServiceName}-elasticsearch" : ServiceName;

using var telemetry = this.ConfigureTelemetry();
using (var agent = EnvironmentHelper.GetMockAgent())
Expand Down Expand Up @@ -142,6 +149,25 @@ public void SubmitsTraces(string packageVersion, string metadataSchemaVersion)
.OrderBy(s => s.Start)
.ToList();

var host = Environment.GetEnvironmentVariable("ELASTICSEARCH5_HOST");

var settings = VerifyHelper.GetSpanVerifierSettings();
// normalise between running directly against localhost and against elasticsearch containers
settings.AddSimpleScrubber("out.host: localhost", "out.host: elasticsearch");
settings.AddSimpleScrubber("out.host: elasticsearch5", "out.host: elasticsearch");
settings.AddSimpleScrubber("out.host: elasticsearch7_arm64", "out.host: elasticsearch");
settings.AddSimpleScrubber("peer.service: localhost", "peer.service: elasticsearch");
settings.AddSimpleScrubber("peer.service: elasticsearch5", "peer.service: elasticsearch");
settings.AddSimpleScrubber("peer.service: elasticsearch7_arm64", "peer.service: elasticsearch");
if (!string.IsNullOrWhiteSpace(host))
{
settings.AddSimpleScrubber(host, "localhost:00000");
}

await VerifyHelper.VerifySpans(spans, settings)
.UseTextForParameters($"Schema{metadataSchemaVersion.ToUpper()}")
.DisableRequireUniquePrefix();

ValidateIntegrationSpans(spans, metadataSchemaVersion, expectedServiceName: clientSpanServiceName, isExternalSpan);
ValidateSpans(spans, (span) => span.Resource, expected);
telemetry.AssertIntegrationEnabled(IntegrationId.ElasticsearchNet);
Expand Down
41 changes: 38 additions & 3 deletions tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests/Elasticsearch6Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,26 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Datadog.Trace.Configuration;
using Datadog.Trace.ExtensionMethods;
using Datadog.Trace.TestHelpers;
using VerifyXunit;
using Xunit;
using Xunit.Abstractions;

namespace Datadog.Trace.ClrProfiler.IntegrationTests
{
[Trait("RequiresDockerDependency", "true")]
[UsesVerify]
public class Elasticsearch6Tests : TracingIntegrationTest
{
private const string ServiceName = "Samples.Elasticsearch";

public Elasticsearch6Tests(ITestOutputHelper output)
: base("Elasticsearch", output)
{
SetServiceName(ServiceName);
SetServiceVersion("1.0.0");
}

Expand All @@ -34,17 +40,18 @@ public static IEnumerable<object[]> GetEnabledConfig()
[MemberData(nameof(GetEnabledConfig))]
[Trait("Category", "EndToEnd")]
[Trait("Category", "ArmUnsupported")]
public void SubmitsTraces(string packageVersion, string metadataSchemaVersion)
public async Task SubmitsTraces(string packageVersion, string metadataSchemaVersion)
{
SetEnvironmentVariable("DD_TRACE_SPAN_ATTRIBUTE_SCHEMA", metadataSchemaVersion);
var isExternalSpan = metadataSchemaVersion == "v0";
var clientSpanServiceName = isExternalSpan ? $"{EnvironmentHelper.FullSampleName}-elasticsearch" : EnvironmentHelper.FullSampleName;
var clientSpanServiceName = isExternalSpan ? $"{ServiceName}-elasticsearch" : ServiceName;

using var telemetry = this.ConfigureTelemetry();
using (var agent = EnvironmentHelper.GetMockAgent())
using (RunSampleAndWaitForExit(agent, packageVersion: packageVersion))
{
var expected = new List<string>();
var version = string.IsNullOrEmpty(packageVersion) ? null : new Version(packageVersion);

// commands with sync and async
for (var i = 0; i < 2; i++)
Expand Down Expand Up @@ -137,7 +144,9 @@ public void SubmitsTraces(string packageVersion, string metadataSchemaVersion)
"DeleteUser",
});

if (string.IsNullOrEmpty(packageVersion) || string.Compare(packageVersion, "6.1.0", StringComparison.Ordinal) < 0)
// Remove spans that are only generated on 6.1+
// The default version is 6.1.0, so we do not remove spans when the version number is null
if (version is not null && version < new Version(6, 1, 0))
{
expected.Remove("SplitIndex");
expected.Remove("GetOverallBuckets");
Expand All @@ -150,6 +159,32 @@ public void SubmitsTraces(string packageVersion, string metadataSchemaVersion)
.OrderBy(s => s.Start)
.ToList();

var snapshotSuffix = version switch
{
null => "6_1", // default is version 6.1.0
{ Major: 6, Minor: >= 1 } => "6_1",
_ => "6_0"
};

var host = Environment.GetEnvironmentVariable("ELASTICSEARCH6_HOST");

var settings = VerifyHelper.GetSpanVerifierSettings();
// normalise between running directly against localhost and against elasticsearch containers
settings.AddSimpleScrubber("out.host: localhost", "out.host: elasticsearch");
settings.AddSimpleScrubber("out.host: elasticsearch6", "out.host: elasticsearch");
settings.AddSimpleScrubber("out.host: elasticsearch7_arm64", "out.host: elasticsearch");
settings.AddSimpleScrubber("peer.service: localhost", "peer.service: elasticsearch");
settings.AddSimpleScrubber("peer.service: elasticsearch6", "peer.service: elasticsearch");
settings.AddSimpleScrubber("peer.service: elasticsearch7_arm64", "peer.service: elasticsearch");
if (!string.IsNullOrWhiteSpace(host))
{
settings.AddSimpleScrubber(host, "localhost:00000");
}

await VerifyHelper.VerifySpans(spans, settings)
.UseTextForParameters($"packageVersion={snapshotSuffix}.Schema{metadataSchemaVersion.ToUpper()}")
.DisableRequireUniquePrefix();

ValidateIntegrationSpans(spans, metadataSchemaVersion, expectedServiceName: clientSpanServiceName, isExternalSpan);
ValidateSpans(spans, (span) => span.Resource, expected);
telemetry.AssertIntegrationEnabled(IntegrationId.ElasticsearchNet);
Expand Down
Loading