Add tracing instrumentation #80
Conversation
|
|
||
| internal const string SERVICE_NAME = "Aerospike"; | ||
|
|
||
| internal static readonly ActivitySource Source = new ActivitySource(SOURCE_NAME); |
There was a problem hiding this comment.
You can add the version of the assembly in the ActivitySource ctor
| // https://github.com/open-telemetry/opentelemetry-specification/blob/6ce62202e5407518e19c56c445c13682ef51a51d/specification/trace/semantic_conventions/span-general.md#general-remote-service-attributes | ||
| activity.SetTag("peer.service", Tracing.SERVICE_NAME); | ||
| // https://github.com/open-telemetry/opentelemetry-specification/blob/6ce62202e5407518e19c56c445c13682ef51a51d/specification/trace/semantic_conventions/database.md#connection-level-attributes | ||
| activity.SetTag("db.system", Tracing.SERVICE_NAME); |
There was a problem hiding this comment.
According to the spec, db.system should be lowercased (Aerospike -> aerospike). I've tried adding it to the spec but kind of got ignored open-telemetry/opentelemetry-specification#2090
| activity?.Dispose(); | ||
| activity = Tracing.Source.StartActivity(GetType().Name, ActivityKind.Client); | ||
| if (activity != null) | ||
| { |
There was a problem hiding this comment.
Would be great to have the following tags:
db.usersnetwork.peer.addressnetwork.peer.portdb.namedb.operation.db.statement
| if (activity != null) | ||
| { | ||
| // https://github.com/open-telemetry/opentelemetry-specification/blob/6ce62202e5407518e19c56c445c13682ef51a51d/specification/trace/semantic_conventions/span-general.md#general-remote-service-attributes | ||
| activity.SetTag("peer.service", Tracing.SERVICE_NAME); |
There was a problem hiding this comment.
The service name is one of the most important information. When the trace is displayed on a UI (Jaeger, Tempo), it will be the most visible info. I would avoid hardcoding it but either use the cluster name or a new user-provided string.
|
|
||
| // If we're retrying, stop the previous Activity before restarting a new one. | ||
| activity?.Dispose(); | ||
| activity = Tracing.Source.StartActivity(GetType().Name, ActivityKind.Client); |
There was a problem hiding this comment.
https://opentelemetry.io/docs/specs/semconv/database/database-spans/
According to the spec, we should try to make the span name look like <db.operation> <db.name>.<db.sql.table>. Also this string should probably be cached as we don't want such allocation in the very hot path.
| // If we're retrying, stop the previous Activity before restarting a new one. | ||
| activity?.Dispose(); | ||
| activity = Tracing.Source.StartActivity(GetType().Name, ActivityKind.Client); | ||
| if (activity != null) |
There was a problem hiding this comment.
activity.IsAllDataRequested should also be checked before setting tags.
| activity.SetTag("node.name", node.Name); | ||
| activity.SetTag("node.address", node.NodeAddress.ToString()); | ||
| } |
There was a problem hiding this comment.
Those don't seem to be standard tags, I would use network.peer* as mentioned below.
| activity.SetTag("peer.service", Tracing.SERVICE_NAME); | ||
| // https://github.com/open-telemetry/opentelemetry-specification/blob/6ce62202e5407518e19c56c445c13682ef51a51d/specification/trace/semantic_conventions/database.md#connection-level-attributes | ||
| activity.SetTag("db.system", Tracing.SERVICE_NAME); | ||
| activity.SetTag("iteration", iteration); |
There was a problem hiding this comment.
There doesn't seem to be a standard for retries tags. Though there is http.request.resend_count so maybe we could name it db.resend_count?
| { | ||
| if (activity != null && exception != null) | ||
| { | ||
| activity.SetStatus(ActivityStatusCode.Error, exception.ToString()); |
There was a problem hiding this comment.
I don't think the status description should contain the full exception. There are exception tags made for this https://opentelemetry.io/docs/specs/semconv/attributes-registry/exception. See how they do it in OpenTelemetry.Api: https://github.com/open-telemetry/opentelemetry-dotnet/blob/14ee5c456ee91ffc11e29b35333834b2e04f53d3/src/OpenTelemetry.Api/Trace/TelemetrySpan.cs#L266.
That would allow a UI to format the exception if the rights tags are present.
|
I could be interested to recreate the PR if @ogxd is doesn't have the time to work on it. |
No description provided.