Skip to content

SqlClient Instrumentation to leverage native Activity Status. #3751

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 11 commits into from
Oct 12, 2022
Merged

SqlClient Instrumentation to leverage native Activity Status. #3751

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e013e0f
initial commit
Yun-Ting Oct 11, 2022
c05cca5
changelog
Yun-Ting Oct 11, 2022
3bbd827
fix
Yun-Ting Oct 11, 2022
77768cb
Update src/OpenTelemetry.Instrumentation.SqlClient/CHANGELOG.md
Yun-Ting Oct 11, 2022
db64a2f
comment
Yun-Ting Oct 11, 2022
df963a7
Merge branch 'yunl/activityStatus' of https://github.com/Yun-Ting/ope…
Yun-Ting Oct 11, 2022
6474e65
comments
Yun-Ting Oct 11, 2022
e57006b
fix test
Yun-Ting Oct 11, 2022
55386f7
comment
Yun-Ting Oct 12, 2022
8780039
fix
Yun-Ting Oct 12, 2022
9021b98
Merge branch 'main' into yunl/activityStatus
cijothomas Oct 12, 2022
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
5 changes: 5 additions & 0 deletions src/OpenTelemetry.Instrumentation.SqlClient/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

## Unreleased

* Updated to use Activity native support from `System.Diagnostics.DiagnosticSource`
to set activity status.
([#3118](https://github.com/open-telemetry/opentelemetry-dotnet/issues/3118))
([#3751](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3751))

## 1.0.0-rc9.7

Released 2022-Sep-29
Expand Down
4 changes: 2 additions & 2 deletions src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlClientDiagnosticListener.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ public override void OnEventWritten(string name, object payload)
{
if (activity.IsAllDataRequested)
{
activity.SetStatus(Status.Unset);
activity.SetStatus(ActivityStatusCode.Unset);
}
}
finally
Expand Down Expand Up @@ -180,7 +180,7 @@ public override void OnEventWritten(string name, object payload)
{
if (this.exceptionFetcher.TryFetch(payload, out Exception exception) && exception != null)
{
activity.SetStatus(Status.Error.WithDescription(exception.Message));
activity.SetStatus(ActivityStatusCode.Error, exception.Message);

if (this.options.RecordException)
{
Expand Down
6 changes: 3 additions & 3 deletions src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlEventSourceListener.netfx.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,16 +183,16 @@ private void OnEndExecute(EventWrittenEventArgs eventData)
int compositeState = (int)eventData.Payload[1];
if ((compositeState & 0b001) == 0b001)
{
activity.SetStatus(Status.Unset);
activity.SetStatus(ActivityStatusCode.Unset);
Copy link
Member

@cijothomas cijothomas Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we dont need this either.

Copy link
Contributor Author

@Yun-Ting Yun-Ting Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed it, too; thanks!

Copy link
Member

@cijothomas cijothomas Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its still here.... :D

Copy link
Contributor Author

@Yun-Ting Yun-Ting Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, there's an update, please refer to this conversation:
https://github.com/open-telemetry/opentelemetry-dotnet/pull/3751/files/6474e650ac9214e2d26aaa09182d5a75c2d1b189#r992807846

}
else if ((compositeState & 0b010) == 0b010)
{
var errorText = $"SqlExceptionNumber {eventData.Payload[2]} thrown.";
activity.SetStatus(Status.Error.WithDescription(errorText));
activity.SetStatus(ActivityStatusCode.Error, errorText);
}
else
{
activity.SetStatus(Status.Error.WithDescription("Unknown Sql failure."));
activity.SetStatus(ActivityStatusCode.Error, "Unknown Sql failure.");
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,13 +326,13 @@ private static void VerifyActivityData(

if (!isFailure)
{
Assert.Equal(Status.Unset, activity.GetStatus());
Assert.Equal(ActivityStatusCode.Unset, activity.Status);
}
else
{
var status = activity.GetStatus();
Assert.Equal(Status.Error.StatusCode, status.StatusCode);
Assert.NotNull(status.Description);
Assert.Equal(ActivityStatusCode.Error, activity.Status);
Assert.NotNull(activity.StatusDescription);

if (recordException)
{
Expand Down
7 changes: 3 additions & 4 deletions test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlEventSourceTests.netfx.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,13 +276,12 @@ private static void VerifyActivityData(

if (!isFailure)
{
Assert.Equal(Status.Unset, activity.GetStatus());
Assert.Equal(ActivityStatusCode.Unset, activity.Status);
}
else
{
var status = activity.GetStatus();
Assert.Equal(Status.Error.StatusCode, status.StatusCode);
Assert.NotNull(status.Description);
Assert.Equal(ActivityStatusCode.Error, activity.Status);
Assert.NotNull(activity.StatusDescription);
}
}

Expand Down