Add FreeRedis Diagnostics #547
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
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,108 @@ | ||
| using System; | ||
|
There was a problem hiding this comment. All code files need to add the SkyAPM copyright header. Please refer to https://github.com/SkyAPM/SkyAPM-dotnet/blob/main/src/SkyApm.Abstractions/ITracingDiagnosticProcessor.cs#L1 There was a problem hiding this comment.
ok |
||
| using System.Collections.Generic; | ||
| using System.Text; | ||
|
|
||
| namespace SkyApm.Diagnostics.FreeRedis | ||
| { | ||
| internal static class FreeRedisPluginConfig | ||
| { | ||
| internal static HashSet<String> OPERATION_MAPPING_WRITE = new HashSet<string>() { | ||
| "GETSET", | ||
| "SET", | ||
| "SETBIT", | ||
| "SETEX ", | ||
| "SETNX ", | ||
| "SETRANGE", | ||
| "STRLEN ", | ||
| "MSET", | ||
| "MSETNX ", | ||
| "PSETEX", | ||
| "INCR ", | ||
| "INCRBY ", | ||
| "INCRBYFLOAT", | ||
| "DECR ", | ||
| "DECRBY ", | ||
| "APPEND ", | ||
| "HMSET", | ||
| "HSET", | ||
| "HSETNX ", | ||
| "HINCRBY", | ||
| "HINCRBYFLOAT", | ||
| "HDEL", | ||
| "RPOPLPUSH", | ||
| "RPUSH", | ||
| "RPUSHX", | ||
| "LPUSH", | ||
| "LPUSHX", | ||
| "LREM", | ||
| "LTRIM", | ||
| "LSET", | ||
| "BRPOPLPUSH", | ||
| "LINSERT", | ||
| "SADD", | ||
| "SDIFF", | ||
| "SDIFFSTORE", | ||
| "SINTERSTORE", | ||
| "SISMEMBER", | ||
| "SREM", | ||
| "SUNION", | ||
| "SUNIONSTORE", | ||
| "SINTER", | ||
| "ZADD", | ||
| "ZINCRBY", | ||
| "ZINTERSTORE", | ||
| "ZRANGE", | ||
| "ZRANGEBYLEX", | ||
| "ZRANGEBYSCORE", | ||
| "ZRANK", | ||
| "ZREM", | ||
| "ZREMRANGEBYLEX", | ||
| "ZREMRANGEBYRANK", | ||
| "ZREMRANGEBYSCORE", | ||
| "ZREVRANGE", | ||
| "ZREVRANGEBYSCORE", | ||
| "ZREVRANK", | ||
| "ZUNIONSTORE", | ||
| "XADD", | ||
| "XDEL", | ||
| "DEL", | ||
| "XTRIM" | ||
| }; | ||
| internal static HashSet<String> OPERATION_MAPPING_READ = new HashSet<string>(){ | ||
| "GET", | ||
| "GETRANGE", | ||
| "GETBIT ", | ||
| "MGET", | ||
| "HVALS", | ||
| "HKEYS", | ||
| "HLEN", | ||
| "HEXISTS", | ||
| "HGET", | ||
| "HGETALL", | ||
| "HMGET", | ||
| "BLPOP", | ||
| "BRPOP", | ||
| "LINDEX", | ||
| "LLEN", | ||
| "LPOP", | ||
| "LRANGE", | ||
| "RPOP", | ||
| "SCARD", | ||
| "SRANDMEMBER", | ||
| "SPOP", | ||
| "SSCAN", | ||
| "SMOVE", | ||
| "ZLEXCOUNT", | ||
| "ZSCORE", | ||
| "ZSCAN", | ||
| "ZCARD", | ||
| "ZCOUNT", | ||
| "XGET", | ||
| "GET", | ||
| "XREAD", | ||
| "XLEN", | ||
| "XRANGE", | ||
| "XREVRANGE" | ||
| }; | ||
| } | ||
| } | ||
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,123 @@ | ||
| using FreeRedis; | ||
| using SkyApm; | ||
| using SkyApm.Common; | ||
| using SkyApm.Config; | ||
| using SkyApm.Diagnostics; | ||
| using SkyApm.Tracing; | ||
| using SkyApm.Tracing.Segments; | ||
| using System; | ||
| using System.Linq; | ||
| using System.Text; | ||
|
|
||
| namespace SkyApm.Diagnostics.FreeRedis | ||
| { | ||
|
|
||
|
|
||
| /// <summary> | ||
| /// FreeRedisTracingDiagnosticProcessor | ||
| /// </summary> | ||
| public class FreeRedisTracingDiagnosticProcessor : ITracingDiagnosticProcessor | ||
| { | ||
|
|
||
| #region Const | ||
|
|
||
| public const string ComponentName = "FreeRedis"; | ||
|
|
||
| public const string FreeRedis_Notice = "FreeRedis.Notice"; | ||
|
|
||
| #endregion | ||
|
|
||
| public string ListenerName => "FreeRedisDiagnosticListener"; | ||
|
|
||
| private readonly ITracingContext _tracingContext; | ||
| private readonly ILocalSegmentContextAccessor _localSegmentContextAccessor; | ||
| private readonly TracingConfig _tracingConfig; | ||
| public FreeRedisTracingDiagnosticProcessor(ITracingContext tracingContext, | ||
| ILocalSegmentContextAccessor localSegmentContextAccessor, IConfigAccessor configAccessor) | ||
| { | ||
| _tracingContext = tracingContext; | ||
| _localSegmentContextAccessor = localSegmentContextAccessor; | ||
| _tracingConfig = configAccessor.Get<TracingConfig>(); | ||
| } | ||
|
|
||
| private SegmentContext CreateFreeRedisLocalSegmentContext(string operation) | ||
| { | ||
| var context = _tracingContext.CreateLocalSegmentContext(operation); | ||
|
There was a problem hiding this comment. Redis calls should use exit segment There was a problem hiding this comment.
I don't understand what you mean. |
||
| context.Span.SpanLayer = SpanLayer.CACHE; | ||
| context.Span.Component = Components.Free_Redis; | ||
| context.Span.AddTag(Tags.CACHE_TYPE, "FreeRedis"); | ||
| return context; | ||
| } | ||
|
|
||
| #region Notice | ||
| [DiagnosticName(FreeRedis_Notice)] | ||
| public void Notice([Object] NoticeEventArgs eventData) | ||
| { | ||
| var context = CreateFreeRedisLocalSegmentContext(eventData.NoticeType.ToString()); | ||
| context.Span.Peer = AnalysisDomain(eventData.Log); | ||
| string cmd = AnalysisCmd(eventData.Log); | ||
| context.Span.AddTag(Tags.CACHE_OP, parseOperation(cmd)); | ||
| context.Span.AddTag(Tags.CACHE_CMD, eventData.Log); | ||
| if (eventData?.Exception != null) | ||
| context.Span.ErrorOccurred(eventData.Exception, _tracingConfig); | ||
| _tracingContext.Release(context); | ||
| } | ||
| #endregion | ||
| /// <summary> | ||
| /// 解析读写 | ||
|
|
||
| /// </summary> | ||
| /// <param name="cmd"></param> | ||
| /// <returns></returns> | ||
| private static String parseOperation(String cmd) | ||
| { | ||
| if (FreeRedisPluginConfig.OPERATION_MAPPING_READ.Contains(cmd)) | ||
| { | ||
| return "read"; | ||
| } | ||
| if (FreeRedisPluginConfig.OPERATION_MAPPING_WRITE.Contains(cmd)) | ||
| { | ||
| return "write"; | ||
| } | ||
| return string.Empty; | ||
| } | ||
| /// <summary> | ||
| /// 解析命令 | ||
| /// </summary> | ||
| /// <param name="cmd"></param> | ||
| /// <returns></returns> | ||
| private static string AnalysisCmd(string cmd) | ||
| { | ||
| if (cmd == null) return string.Empty; | ||
| cmd.Replace("\r\n", " "); | ||
| char[] cmds = cmd.ToArray(); | ||
| StringBuilder stringBuilder = new StringBuilder(); | ||
| bool beginAn = false; | ||
| for (var i = 0; i < cmds.Length; i++) | ||
| { | ||
| if (cmds[i] == '>') | ||
| { | ||
| beginAn = true; | ||
| } | ||
| else if (beginAn && ((cmds[i] >= 'a' && cmds[i] <= 'z') || (cmds[i] >= 'A' && cmds[i] <= 'Z'))) | ||
| { | ||
| stringBuilder.Append(cmds[i]); | ||
| } | ||
| else if (stringBuilder.Length > 0) | ||
| { | ||
| return stringBuilder.ToString(); | ||
| } | ||
| } | ||
| return string.Empty; | ||
| } | ||
| /// <summary> | ||
| /// 解析地址 | ||
| /// </summary> | ||
| /// <param name="cmd"></param> | ||
| /// <returns></returns> | ||
| private static string AnalysisDomain(string cmd) | ||
| { | ||
| if (cmd == null || !cmd.Contains(">")) return string.Empty; | ||
| return cmd.Substring(0, cmd.IndexOf(">")).Trim(); | ||
| } | ||
| } | ||
| } | ||
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,21 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <Import Project="..\..\build\common.props" /> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks> | ||
| <AssemblyName>$(PackagePrefix).Diagnostics.FreeRedis</AssemblyName> | ||
| <PackageId>$(PackagePrefix).Diagnostics.FreeRedis</PackageId> | ||
| <PackageTags>SkyWalking;APM;Diagnostics;FreeRedis</PackageTags> | ||
| <Description>SkyApm.Diagnostics.FreeRedis notifies of FreeRedis requests.</Description> | ||
| <RootNamespace>SkyApm.Diagnostics.FreeRedis</RootNamespace> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="FreeRedis" Version="1.0.1" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\SkyApm.Utilities.DependencyInjection\SkyApm.Utilities.DependencyInjection.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
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,41 @@ | ||
| using FreeRedis; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using SkyApm; | ||
| using SkyApm.Utilities.DependencyInjection; | ||
| using System; | ||
| using System.Diagnostics; | ||
|
|
||
| namespace SkyApm.Diagnostics.FreeRedis | ||
| { | ||
|
|
||
| public static class SkyWalkingBuilderExtensions | ||
| { | ||
| public static readonly DiagnosticListener dl = new DiagnosticListener("FreeRedisDiagnosticListener"); | ||
|
|
||
| public static SkyApmExtensions AddFreeRedis(this SkyApmExtensions extensions, RedisClient redisClient, bool includeAuth = false) | ||
| { | ||
| if (extensions == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(extensions)); | ||
| } | ||
| extensions.Services.AddSingleton<ITracingDiagnosticProcessor, FreeRedisTracingDiagnosticProcessor>(); | ||
| if (redisClient != null) | ||
| { | ||
| ConfigAop(redisClient, includeAuth); | ||
| } | ||
| return extensions; | ||
| } | ||
|
|
||
|
|
||
| public static void ConfigAop(RedisClient redisClient, bool includeAuth = false) | ||
| { | ||
| redisClient.Notice += (s, e) => | ||
| { | ||
| if (!string.IsNullOrWhiteSpace(e.Log) && (includeAuth || (!e.Log.Contains("> AUTH ")))) | ||
| { | ||
| dl.Write(FreeRedisTracingDiagnosticProcessor.FreeRedis_Notice, e); | ||
| } | ||
| }; | ||
| } | ||
| } | ||
| } |
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.
@guochen2 Please register 3018 ID in the main repository.