-
Notifications
You must be signed in to change notification settings - Fork 294
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.
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
fix(EntityFrameworkCore): server.address field to follow otel conventions #2439
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
using System.Diagnostics; | ||
using OpenTelemetry.Trace; | ||
using Xunit; | ||
|
||
namespace OpenTelemetry.Instrumentation.EntityFrameworkCore.Tests; | ||
|
||
public class EntityFrameworkInstrumentationTests | ||
{ | ||
[Fact] | ||
public void ServerAddressWithoutProtocolPrefix() | ||
{ | ||
var activity = new Activity("TestActivity"); | ||
activity.Start(); | ||
|
||
var connection = new | ||
{ | ||
Host = "my.domain.example", | ||
DataSource = "tcp:my.domain.example", | ||
Port = "5432" | ||
}; | ||
|
||
var hostFetcher = new PropertyFetcher<string>("Host"); | ||
var dataSourceFetcher = new PropertyFetcher<string>("DataSource"); | ||
var portFetcher = new PropertyFetcher<string>("Port"); | ||
|
||
var host = hostFetcher.Fetch(connection); | ||
if (!string.IsNullOrEmpty(host)) | ||
{ | ||
activity.AddTag("server.address", host); | ||
} | ||
else | ||
{ | ||
var dataSource = dataSourceFetcher.Fetch(connection); | ||
if (!string.IsNullOrEmpty(dataSource)) | ||
{ | ||
activity.AddTag("server.address", dataSource); | ||
} | ||
} | ||
|
||
var port = portFetcher.Fetch(connection); | ||
if (!string.IsNullOrEmpty(port)) | ||
{ | ||
activity.AddTag("server.port", port); | ||
} | ||
|
||
activity.Stop(); | ||
|
||
Assert.Equal("my.domain.example", activity.Tags.FirstOrDefault(t => t.Key == "server.address").Value); | ||
Assert.Equal("5432", activity.Tags.FirstOrDefault(t => t.Key == "server.port").Value); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,9 @@ | |
|
||
## Unreleased | ||
|
||
* Fixed the `server.address` field in EntityFrameworkCore spans to populate with the server domain name without the `tcp` prefix. | ||
Check failure on line 5 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/CHANGELOG.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
([#IssueNumber](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/issues/IssueNumber)) | ||
|
||
## 1.10.0-beta.1 | ||
|
||
Released 2024-Dec-09 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,4 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
using System.Data; | ||
Check warning on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / lint-dotnet-format / run-dotnet-format
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (windows-latest, net462)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (windows-latest, net462)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (windows-latest, net8.0)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (windows-latest, net8.0)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (windows-latest, net9.0)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (windows-latest, net9.0)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (ubuntu-22.04, net8.0)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (ubuntu-22.04, net8.0)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (ubuntu-22.04, net9.0)
Check failure on line 1 in src/OpenTelemetry.Instrumentation.EntityFrameworkCore/Implementation/EntityFrameworkDiagnosticListener.cs GitHub Actions / build-test-instrumentation-entityframeworkcore / build-test (ubuntu-22.04, net9.0)
|
||
using System.Diagnostics; | ||
using System.Reflection; | ||
using OpenTelemetry.Internal; | ||
|
@@ -40,6 +37,8 @@ | |
private readonly PropertyFetcher<CommandType> commandTypeFetcher = new("CommandType"); | ||
private readonly PropertyFetcher<string> commandTextFetcher = new("CommandText"); | ||
private readonly PropertyFetcher<Exception> exceptionFetcher = new("Exception"); | ||
private readonly PropertyFetcher<string> hostFetcher = new("Host"); | ||
private readonly PropertyFetcher<string> portFetcher = new("Port"); | ||
|
||
private readonly EntityFrameworkInstrumentationOptions options; | ||
|
||
|
@@ -140,10 +139,24 @@ | |
break; | ||
} | ||
|
||
var dataSource = (string)this.dataSourceFetcher.Fetch(connection); | ||
if (!string.IsNullOrEmpty(dataSource)) | ||
var host = (string)this.hostFetcher.Fetch(connection); | ||
if (!string.IsNullOrEmpty(host)) | ||
{ | ||
activity.AddTag(AttributeServerAddress, host); | ||
} | ||
else | ||
{ | ||
var dataSource = (string)this.dataSourceFetcher.Fetch(connection); | ||
if (!string.IsNullOrEmpty(dataSource)) | ||
{ | ||
activity.AddTag(AttributeServerAddress, dataSource); | ||
} | ||
} | ||
|
||
var port = (string)this.portFetcher.Fetch(connection); | ||
if (!string.IsNullOrEmpty(port)) | ||
{ | ||
activity.AddTag(AttributeServerAddress, dataSource); | ||
activity.AddTag(AttributeServerAddress, port); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are you sure about attribute name here? |
||
} | ||
|
||
if (this.options.EmitOldAttributes) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is mandatory.