[Instrumentation.StackExchangeRedis] Metrics support #1982
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using System.Diagnostics.Metrics; | ||
| using System.Reflection; | ||
| using OpenTelemetry.Internal; | ||
|
|
||
| namespace OpenTelemetry.Instrumentation.StackExchangeRedis.Implementation; | ||
|
|
||
| internal class RedisMetrics : IDisposable | ||
| { | ||
| internal static readonly Assembly Assembly = typeof(StackExchangeRedisInstrumentation).Assembly; | ||
| internal static readonly AssemblyName AssemblyName = Assembly.GetName(); | ||
| internal static readonly string InstrumentationName = AssemblyName.Name!; | ||
| internal static readonly string InstrumentationVersion = Assembly.GetPackageVersion(); | ||
Kielek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private readonly Meter meter; | ||
|
|
||
| public RedisMetrics() | ||
| { | ||
| this.meter = new Meter(InstrumentationName, InstrumentationVersion); | ||
|
|
||
| this.DurationHistogram = this.meter.CreateHistogram<double>( | ||
| "db.client.operation.duration", | ||
| unit: "s", | ||
| description: "Duration of database client operations."); | ||
| } | ||
|
|
||
| public static RedisMetrics Instance { get; } = new RedisMetrics(); | ||
|
|
||
| public Histogram<double> DurationHistogram { get; } | ||
|
|
||
| public bool Enabled => this.DurationHistogram.Enabled; | ||
|
|
||
| public void Dispose() | ||
| { | ||
| this.meter.Dispose(); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,15 +7,18 @@ | |
| using System.Reflection.Emit; | ||
| using OpenTelemetry.Trace; | ||
| using StackExchange.Redis.Profiling; | ||
|
|
||
| #if NET | ||
| using System.Diagnostics.CodeAnalysis; | ||
| using System.Runtime.CompilerServices; | ||
|
|
||
| #endif | ||
| namespace OpenTelemetry.Instrumentation.StackExchangeRedis.Implementation; | ||
|
|
||
| internal static class RedisProfilerEntryInstrumenter | ||
| { | ||
| private const int DefaultPort = 6379; | ||
|
|
||
| private static readonly Lazy<Func<object, (string?, string?)>> MessageDataGetter = new(() => | ||
| { | ||
| var profiledCommandType = Type.GetType("StackExchange.Redis.Profiling.ProfiledCommand, StackExchange.Redis", throwOnError: true)!; | ||
|
|
@@ -68,7 +71,11 @@ static bool GetCommandAndKey( | |
| }); | ||
| }); | ||
|
|
||
| public static Activity? ProfilerCommandInstrument( | ||
| Activity? parentActivity, | ||
| IProfiledCommand command, | ||
| RedisMetrics metrics, | ||
| StackExchangeRedisInstrumentationOptions options) | ||
| { | ||
| var name = command.Command; // Example: SET; | ||
| if (string.IsNullOrEmpty(name)) | ||
|
|
@@ -83,30 +90,38 @@ static bool GetCommandAndKey( | |
| StackExchangeRedisConnectionInstrumentation.CreationTags, | ||
| startTime: command.CommandCreated); | ||
|
|
||
| if (activity is null && metrics.Enabled is false) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| activity?.SetEndTime(command.CommandCreated + command.ElapsedTime); | ||
| var meterTags = metrics.Enabled ? | ||
|
There was a problem hiding this comment.
Isn't this sufficient? There was a problem hiding this comment. I think the result of Here I would like to set a null object to be validated in every AddTag and so optimize the memory allocation |
||
| new TagList(StackExchangeRedisConnectionInstrumentation.CreationTags) : | ||
|
There was a problem hiding this comment. creationtags is no longer needed, as it is already covered via Meter Tags. There was a problem hiding this comment. since you suggest removing the meter tags #1982 (comment), I will keep it |
||
| default(IList<KeyValuePair<string, object?>>); | ||
|
|
||
|
There was a problem hiding this comment. I think it is worth to keep this functionality. Checks should be cheaper than adding couple of tags. |
||
| // see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md | ||
|
|
||
| // Timing example: | ||
| // command.CommandCreated; //2019-01-10 22:18:28Z | ||
|
|
||
| // command.CreationToEnqueued; // 00:00:32.4571995 | ||
| // command.EnqueuedToSending; // 00:00:00.0352838 | ||
| // command.SentToResponse; // 00:00:00.0060586 | ||
| // command.ResponseToCompletion; // 00:00:00.0002601 | ||
|
|
||
| // Total: | ||
| // command.ElapsedTime; // 00:00:32.4988020 | ||
|
|
||
| activity?.SetTag(SemanticConventions.AttributeDbRedisFlagsKeyName, command.Flags.ToString()); | ||
|
|
||
| if (command.Command != null) | ||
| { | ||
| meterTags?.Add(SemanticConventions.AttributeDbOperationName, command.Command); | ||
| } | ||
|
|
||
| if (activity != null) | ||
| { | ||
| if (options.SetVerboseDatabaseStatements) | ||
| { | ||
| var (commandAndKey, script) = MessageDataGetter.Value.Invoke(command); | ||
|
|
@@ -130,31 +145,59 @@ static bool GetCommandAndKey( | |
| // Example: "db.statement": SET; | ||
| activity.SetTag(SemanticConventions.AttributeDbStatement, command.Command); | ||
| } | ||
| } | ||
|
|
||
| if (command.EndPoint != null) | ||
| { | ||
| if (command.EndPoint is IPEndPoint ipEndPoint) | ||
| { | ||
| var ip = ipEndPoint.Address.ToString(); | ||
| var port = ipEndPoint.Port; | ||
|
|
||
| activity?.SetTag(SemanticConventions.AttributeNetPeerIp, ip); | ||
| activity?.SetTag(SemanticConventions.AttributeNetPeerPort, port); | ||
|
|
||
| meterTags?.Add(SemanticConventions.AttributeServerAddress, ip); | ||
| meterTags?.Add(SemanticConventions.AttributeNetworkPeerAddress, ip); | ||
| if (port != DefaultPort) | ||
| { | ||
| meterTags?.Add(SemanticConventions.AttributeServerPort, port); | ||
| meterTags?.Add(SemanticConventions.AttributeNetworkPeerPort, port); | ||
| } | ||
| } | ||
| else if (command.EndPoint is DnsEndPoint dnsEndPoint) | ||
| { | ||
| var host = dnsEndPoint.Host; | ||
| var port = dnsEndPoint.Port; | ||
|
|
||
| activity?.SetTag(SemanticConventions.AttributeNetPeerName, host); | ||
| activity?.SetTag(SemanticConventions.AttributeNetPeerPort, port); | ||
|
Comment on lines
+173
to
+174
There was a problem hiding this comment. Candidate for separate PR - update semantic convention to 1.27.0. At least for network tags. Note. |
||
|
|
||
| meterTags?.Add(SemanticConventions.AttributeServerAddress, host); | ||
| if (port != DefaultPort) | ||
| { | ||
| meterTags?.Add(SemanticConventions.AttributeServerPort, port); | ||
| } | ||
| } | ||
| else | ||
| { | ||
| var service = command.EndPoint.ToString(); | ||
|
|
||
| activity?.SetTag(SemanticConventions.AttributePeerService, service); | ||
| meterTags?.Add(SemanticConventions.AttributeServerAddress, service); | ||
| } | ||
| } | ||
|
|
||
| var db = command.Db; | ||
| activity?.SetTag(SemanticConventions.AttributeDbRedisDatabaseIndex, db); | ||
| meterTags?.Add(SemanticConventions.AttributeDbNamespace, db); | ||
|
|
||
| // TODO: deal with the re-transmission | ||
| // command.RetransmissionOf; | ||
| // command.RetransmissionReason; | ||
|
|
||
| if (activity?.IsAllDataRequested ?? false) | ||
| { | ||
| var enqueued = command.CommandCreated.Add(command.CreationToEnqueued); | ||
| var send = enqueued.Add(command.EnqueuedToSending); | ||
| var response = send.Add(command.SentToResponse); | ||
|
|
@@ -169,16 +212,25 @@ static bool GetCommandAndKey( | |
| options.Enrich?.Invoke(activity, command); | ||
| } | ||
|
|
||
| if (metrics.Enabled && meterTags is TagList meterTagList) | ||
| { | ||
| metrics.DurationHistogram.Record(command.ElapsedTime.TotalSeconds, meterTagList); | ||
| } | ||
|
|
||
| activity?.Stop(); | ||
|
|
||
| return activity; | ||
| } | ||
|
|
||
| public static void DrainSession( | ||
| Activity? parentActivity, | ||
| IEnumerable<IProfiledCommand> sessionCommands, | ||
| RedisMetrics redisMetrics, | ||
| StackExchangeRedisInstrumentationOptions options) | ||
| { | ||
| foreach (var command in sessionCommands) | ||
| { | ||
| ProfilerCommandInstrument(parentActivity, command, redisMetrics, options); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -224,4 +276,9 @@ public static void DrainSession(Activity? parentActivity, IEnumerable<IProfiledC | |
|
|
||
| return null; | ||
| } | ||
|
|
||
| private static void Add(this IList<KeyValuePair<string, object?>> tags, string ket, object? value) | ||
| { | ||
| tags?.Add(new KeyValuePair<string, object?>(ket, value)); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
As I see only
db.client.operation.durationis supported.