|
| 1 | +using System.Collections.Generic; |
| 2 | +using System.Diagnostics; |
| 3 | +using System.Linq; |
| 4 | +using System.Threading; |
| 5 | +using Cassandra.OpenTelemetry; |
| 6 | +using Cassandra.Tests; |
| 7 | +using NUnit.Framework; |
| 8 | +using OpenTelemetry; |
| 9 | +using OpenTelemetry.Trace; |
| 10 | + |
| 11 | +namespace Cassandra.IntegrationTests.OpenTelemetry |
| 12 | +{ |
| 13 | + [Category(TestCategory.Short)] |
| 14 | + public class OpenTelemetryTests : SharedClusterTest |
| 15 | + { |
| 16 | + private const string OpenTelemetrySourceName = "Cassandra.OpenTelemetry"; |
| 17 | + |
| 18 | + private readonly List<Activity> _exportedActivities = new List<Activity>(); |
| 19 | + |
| 20 | + public OpenTelemetryTests() |
| 21 | + { |
| 22 | + Sdk.CreateTracerProviderBuilder() |
| 23 | + .AddSource(OpenTelemetrySourceName) |
| 24 | + .AddInMemoryExporter(_exportedActivities) |
| 25 | + .Build(); |
| 26 | + } |
| 27 | + |
| 28 | + [TearDown] |
| 29 | + public void Teardown() |
| 30 | + { |
| 31 | + _exportedActivities.Clear(); |
| 32 | + } |
| 33 | + |
| 34 | + [Category(TestCategory.RealClusterLong)] |
| 35 | + [Test] |
| 36 | + public void AddOpenTelemetry_WithKeyspaceAvailable_DbOperationAndDbNameAreIncluded() |
| 37 | + { |
| 38 | + var keyspace = "system"; |
| 39 | + var expectedActivityName = $"ExecuteAsync {keyspace}"; |
| 40 | + var expectedDbNameAttribute = keyspace; |
| 41 | + var cluster = GetNewTemporaryCluster(b => b.AddOpenTelemetryInstrumentation()); |
| 42 | + var session = cluster.Connect(); |
| 43 | + |
| 44 | + var statement = new SimpleStatement("SELECT key FROM system.local"); |
| 45 | + statement.SetKeyspace(keyspace); |
| 46 | + session.ExecuteAsync(statement); |
| 47 | + |
| 48 | + var activity = GetActivity(); |
| 49 | + |
| 50 | + ValidateCommonAttributes(activity); |
| 51 | + |
| 52 | + Assert.AreEqual(expectedActivityName, activity.DisplayName); |
| 53 | + Assert.AreEqual(expectedDbNameAttribute, activity.Tags.First(kvp => kvp.Key == "db.name").Value); |
| 54 | + } |
| 55 | + |
| 56 | + [Category(TestCategory.RealClusterLong)] |
| 57 | + [Test] |
| 58 | + public void AddOpenTelemetry_WithoutKeyspace_DbNameIsNotIncluded() |
| 59 | + { |
| 60 | + var keyspace = "system"; |
| 61 | + var expectedActivityName = $"ExecuteAsync"; |
| 62 | + var expectedDbNameAttribute = keyspace; |
| 63 | + var cluster = GetNewTemporaryCluster(b => b.AddOpenTelemetryInstrumentation()); |
| 64 | + var session = cluster.Connect(); |
| 65 | + |
| 66 | + var statement = new SimpleStatement("SELECT key FROM system.local"); |
| 67 | + session.ExecuteAsync(statement); |
| 68 | + |
| 69 | + var activity = GetActivity(); |
| 70 | + |
| 71 | + ValidateCommonAttributes(activity); |
| 72 | + |
| 73 | + Assert.AreEqual(expectedActivityName, activity.DisplayName); |
| 74 | + Assert.IsNull(activity.Tags.FirstOrDefault(kvp => kvp.Key == "db.name").Value); |
| 75 | + } |
| 76 | + |
| 77 | + [Category(TestCategory.RealClusterLong)] |
| 78 | + [Test] |
| 79 | + public void AddOpenTelemetry_WithDefaultOptions_DbStatementIsNotIncludedAsAttribute() |
| 80 | + { |
| 81 | + var cluster = GetNewTemporaryCluster(b => b.AddOpenTelemetryInstrumentation()); |
| 82 | + var session = cluster.Connect(); |
| 83 | + |
| 84 | + var statement = new SimpleStatement("SELECT key FROM system.local"); |
| 85 | + session.ExecuteAsync(statement); |
| 86 | + |
| 87 | + var activity = GetActivity(); |
| 88 | + |
| 89 | + ValidateCommonAttributes(activity); |
| 90 | + |
| 91 | + Assert.IsNull(activity.Tags.FirstOrDefault(kvp => kvp.Key == "db.statement").Value); |
| 92 | + } |
| 93 | + |
| 94 | + [Category(TestCategory.RealClusterLong)] |
| 95 | + [Test] |
| 96 | + public void AddOpenTelemetry_WithIncludeDatabaseStatementOption_DbStatementIsIncludedAsAttribute() |
| 97 | + { |
| 98 | + var expectedDbStatement = "SELECT key FROM system.local"; |
| 99 | + |
| 100 | + var cluster = GetNewTemporaryCluster(b => b.AddOpenTelemetryInstrumentation(options => options.IncludeDatabaseStatement = true)); |
| 101 | + var session = cluster.Connect(); |
| 102 | + |
| 103 | + var statement = new SimpleStatement("SELECT key FROM system.local"); |
| 104 | + session.ExecuteAsync(statement); |
| 105 | + |
| 106 | + var activity = GetActivity(); |
| 107 | + |
| 108 | + ValidateCommonAttributes(activity); |
| 109 | + |
| 110 | + Assert.AreEqual(expectedDbStatement, activity.Tags.First(kvp => kvp.Key == "db.statement").Value); |
| 111 | + } |
| 112 | + |
| 113 | + private Activity GetActivity() |
| 114 | + { |
| 115 | + var count = 0; |
| 116 | + |
| 117 | + while(count < 5) |
| 118 | + { |
| 119 | + if(_exportedActivities.FirstOrDefault() != null) |
| 120 | + { |
| 121 | + return _exportedActivities.FirstOrDefault(); |
| 122 | + } |
| 123 | + |
| 124 | + count++; |
| 125 | + Thread.Sleep(1000); |
| 126 | + } |
| 127 | + |
| 128 | + return _exportedActivities.FirstOrDefault(); |
| 129 | + } |
| 130 | + |
| 131 | + private static void ValidateCommonAttributes(Activity activity) |
| 132 | + { |
| 133 | + var expectedActivityKind = ActivityKind.Client; |
| 134 | + var expectedTags = new Dictionary<string, string>() |
| 135 | + { |
| 136 | + {"db.system", "cassandra" }, |
| 137 | + {"db.operation", "ExecuteAsync" }, |
| 138 | + }; |
| 139 | + |
| 140 | + Assert.AreEqual(activity.Kind, expectedActivityKind); |
| 141 | + |
| 142 | + var tags = activity.Tags; |
| 143 | + |
| 144 | + foreach (var pair in expectedTags) |
| 145 | + { |
| 146 | + Assert.AreEqual(tags.FirstOrDefault(x => x.Key == pair.Key).Value, expectedTags[pair.Key]); |
| 147 | + } |
| 148 | + } |
| 149 | + } |
| 150 | +} |
0 commit comments