forked from Azure/diagnostics-eventflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixes issue Azure#364 Includes re-organization of the README file to make navigation easier
- Loading branch information
Showing
23 changed files
with
1,607 additions
and
89 deletions.
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
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
260 changes: 260 additions & 0 deletions
260
src/Microsoft.Diagnostics.EventFlow.Inputs.ActivitySource/ActivitySourceInput.cs
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,260 @@ | ||
| // ------------------------------------------------------------ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License (MIT). See License.txt in the repo root for license information. | ||
| // ------------------------------------------------------------ | ||
|
|
||
| using System; | ||
| using System.Collections.Concurrent; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.Linq; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Newtonsoft.Json; | ||
| using Validation; | ||
|
|
||
| using Microsoft.Diagnostics.EventFlow.Configuration; | ||
|
|
||
| namespace Microsoft.Diagnostics.EventFlow.Inputs.ActivitySource | ||
| { | ||
| public class ActivitySourceInput : IObservable<EventData>, IDisposable | ||
| { | ||
| private const int SamplingDecisionCacheFlushThreshold = 1024; | ||
|
|
||
| // Using a static dictionary like this is faster than doing Enum.GetName() | ||
| private static readonly IDictionary<ActivityKind, string> ActivityKindNames = | ||
| Enum.GetValues(typeof(ActivityKind)).Cast<ActivityKind>().ToDictionary(k => k, k => k.ToString()); | ||
|
|
||
| private EventFlowSubject<EventData> subject_; | ||
| private ActivityListener activityListener_; | ||
| private ActivitySourceInputConfiguration configuration_; | ||
| private ConcurrentDictionary<string, (ActivitySamplingResult CapturedData, CapturedActivityEvents CapturedEvents)> activitySampling_; | ||
| private bool hasUnrestrictedSources_; | ||
| private IHealthReporter healthReporter_; | ||
|
|
||
| public ActivitySourceInput(IConfiguration configuration, IHealthReporter healthReporter) | ||
| { | ||
| Requires.NotNull(configuration, nameof(configuration)); | ||
| Requires.NotNull(healthReporter, nameof(healthReporter)); | ||
|
|
||
| var inputConfiguration = new ActivitySourceInputConfiguration(); | ||
| try | ||
| { | ||
| configuration.Bind(inputConfiguration); | ||
| } | ||
| catch | ||
| { | ||
| healthReporter.ReportProblem( | ||
| $"Invalid {nameof(ActivitySourceInput)} configuration encountered: '{configuration.ToString()}'", | ||
| EventFlowContextIdentifiers.Configuration); | ||
| throw; | ||
| } | ||
|
|
||
| Initialize(inputConfiguration, healthReporter); | ||
| } | ||
|
|
||
| public ActivitySourceInput(ActivitySourceInputConfiguration configuration, IHealthReporter healthReporter) | ||
| { | ||
| Requires.NotNull(configuration, nameof(configuration)); | ||
| Requires.NotNull(healthReporter, nameof(healthReporter)); | ||
|
|
||
| Initialize(configuration, healthReporter); | ||
| } | ||
|
|
||
| public JsonSerializerSettings SerializerSettings { get; set; } | ||
| public ActivitySourceInputConfiguration Configuration => configuration_; | ||
|
|
||
| public void Dispose() | ||
| { | ||
| activityListener_.Dispose(); | ||
| subject_.Dispose(); | ||
| } | ||
|
|
||
| public IDisposable Subscribe(IObserver<EventData> observer) | ||
| { | ||
| return subject_.Subscribe(observer); | ||
| } | ||
|
|
||
| private void Initialize(ActivitySourceInputConfiguration configuration, IHealthReporter healthReporter) | ||
| { | ||
| healthReporter_ = healthReporter; | ||
| configuration_ = configuration.DeepClone(); | ||
| subject_ = new EventFlowSubject<EventData>(); | ||
| activitySampling_ = new ConcurrentDictionary<string, (ActivitySamplingResult CapturedData, CapturedActivityEvents CapturedEvents)>(); | ||
| activityListener_ = new ActivityListener(); | ||
| SerializerSettings = EventFlowJsonUtilities.GetDefaultSerializerSettings(); | ||
|
|
||
| if (configuration_.Sources.Count == 0) | ||
| { | ||
| healthReporter.ReportWarning( | ||
| $"{nameof(ActivitySourceInput)}: configuration has no data sources. No activity data will be captured.", | ||
| EventFlowContextIdentifiers.Configuration); | ||
| } | ||
|
|
||
| var removed = configuration_.Sources.RemoveAll(s => s.CapturedData == ActivitySamplingResult.None); | ||
| if (removed > 0) | ||
| { | ||
| healthReporter.ReportWarning( | ||
| $"{nameof(ActivitySourceInput)}: configuration has sources with CapturedData = None. These sources will be ignored.", | ||
| EventFlowContextIdentifiers.Configuration); | ||
| } | ||
|
|
||
| hasUnrestrictedSources_ = configuration_.Sources.Any(s => string.IsNullOrWhiteSpace(s.ActivitySourceName)); | ||
|
|
||
| activityListener_.Sample = (ref ActivityCreationOptions<ActivityContext> activityOptions) | ||
| => DetermineActivitySampling(activityOptions.Source.Name, activityOptions.Name).CapturedData; | ||
| activityListener_.SampleUsingParentId = (ref ActivityCreationOptions<string> activityOptions) | ||
| => DetermineActivitySampling(activityOptions.Source.Name, activityOptions.Name).CapturedData; | ||
| activityListener_.ShouldListenTo = ShouldListenTo; | ||
| activityListener_.ActivityStarted = OnActivityStarted; | ||
| activityListener_.ActivityStopped = OnActivityStopped; | ||
|
|
||
| System.Diagnostics.ActivitySource.AddActivityListener(activityListener_); | ||
| } | ||
|
|
||
| private (ActivitySamplingResult CapturedData, CapturedActivityEvents CapturedEvents) DetermineActivitySampling(string activitySourceName, string activityName) | ||
| { | ||
| string activityKey = activitySourceName + ":" + activityName; | ||
|
|
||
| if (activitySampling_.TryGetValue(activityKey, out var samplingSpec)) | ||
| { | ||
| return samplingSpec; | ||
| } | ||
|
|
||
| foreach(var sc in configuration_.Sources) | ||
| { | ||
| bool sourceMatches = string.IsNullOrWhiteSpace(sc.ActivitySourceName) || StringComparer.OrdinalIgnoreCase.Equals(activitySourceName, sc.ActivitySourceName); | ||
| bool nameMatches = string.IsNullOrWhiteSpace(sc.ActivityName) || StringComparer.OrdinalIgnoreCase.Equals(activityName, sc.ActivityName); | ||
|
|
||
| if (sourceMatches && nameMatches) | ||
| { | ||
| FlushSamplingInfoCacheIfNeeded(); | ||
|
|
||
| activitySampling_.AddOrUpdate(activityKey, (sc.CapturedData, sc.CapturedEvents), (_, _) => (sc.CapturedData, sc.CapturedEvents)); | ||
|
|
||
| return (sc.CapturedData, sc.CapturedEvents); | ||
| } | ||
| } | ||
|
|
||
| return (ActivitySamplingResult.None, CapturedActivityEvents.None); | ||
| } | ||
|
|
||
| private bool ShouldListenTo(System.Diagnostics.ActivitySource activitySource) | ||
| { | ||
| if (hasUnrestrictedSources_) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| bool found = configuration_.Sources.Any(s => | ||
| StringComparer.OrdinalIgnoreCase.Equals(activitySource.Name, s.ActivitySourceName) && | ||
| s.CapturedEvents != CapturedActivityEvents.None); | ||
| return found; | ||
| } | ||
|
|
||
| private void OnActivityStarted(Activity activity) | ||
| { | ||
| (var capturedData, var capturedEvents) = DetermineActivitySampling(activity.Source.Name, activity.DisplayName); | ||
| if ( | ||
| capturedData == ActivitySamplingResult.None || | ||
| capturedEvents == CapturedActivityEvents.None || | ||
| (capturedEvents & CapturedActivityEvents.Start) == 0) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| EventData e = ToEventData(activity, capturedData); | ||
| subject_.OnNext(e); | ||
| } | ||
|
|
||
| private void OnActivityStopped(Activity activity) | ||
| { | ||
| (var capturedData, var capturedEvents) = DetermineActivitySampling(activity.Source.Name, activity.DisplayName); | ||
| if ( | ||
| capturedData == ActivitySamplingResult.None || | ||
| capturedEvents == CapturedActivityEvents.None || | ||
| (capturedEvents & CapturedActivityEvents.Stop) == 0) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| EventData e = ToEventData(activity, capturedData); | ||
| subject_.OnNext(e); | ||
| } | ||
|
|
||
| private EventData ToEventData(Activity activity, ActivitySamplingResult capturedData) | ||
| { | ||
| EventData e = new EventData | ||
| { | ||
| ProviderName = nameof(ActivitySourceInput), | ||
| Timestamp = activity.StartTimeUtc, | ||
| Level = LogLevel.Informational, | ||
| Keywords = (long) activity.ActivityTraceFlags | ||
| }; | ||
|
|
||
| // Property names following OpenTelemetry conventions https://github.com/open-telemetry/opentelemetry-specification | ||
| e.Payload["Name"] = activity.DisplayName; | ||
| e.Payload["SpanId"] = activity.Id; | ||
| e.Payload["ParentSpanId"] = activity.ParentSpanId.ToHexString(); | ||
| e.Payload["StartTime"] = e.Timestamp; | ||
| if (activity.Duration != TimeSpan.Zero) | ||
| { | ||
| e.Payload["EndTime"] = activity.StartTimeUtc + activity.Duration; | ||
| } | ||
| e.Payload["TraceId"] = activity.TraceId.ToHexString(); | ||
| if (ActivityKindNames.TryGetValue(activity.Kind, out string activityKindName)) | ||
| { | ||
| e.Payload["SpanKind"] = activityKindName; | ||
| } | ||
| e.Payload["IsRecording"] = activity.Recorded; | ||
|
|
||
| // The following property additions may cause name conflicts, so using AddPayloadProperty() to handle them. | ||
| foreach(var el in activity.Baggage) | ||
| { | ||
| AddPayloadProperty(e, el.Key, el.Value); | ||
| } | ||
|
|
||
| AddPayloadProperty(e, "ActivitySourceName", activity.Source.Name); | ||
|
|
||
| if (capturedData == ActivitySamplingResult.AllData || capturedData == ActivitySamplingResult.AllDataAndRecorded) | ||
| { | ||
| // Activity.Tags is a subset of Activity.TagObjects that have string value, | ||
| // so it is sufficient to just iterate over Activity.TagObjects to capture all activity tags. | ||
| foreach(var tagObject in activity.TagObjects) | ||
| { | ||
| AddPayloadProperty(e, tagObject.Key, tagObject.Value); | ||
| } | ||
|
|
||
| if (activity.Events.Any()) | ||
| { | ||
| AddPayloadProperty(e, "Events", activity.Events); | ||
| } | ||
|
|
||
| if (activity.Links.Any()) | ||
| { | ||
| AddPayloadProperty(e, "Links", activity.Links); | ||
| } | ||
| } | ||
|
|
||
| return e; | ||
| } | ||
|
|
||
| private void AddPayloadProperty(EventData e, string propertyName, object propertyValue) | ||
| { | ||
| e.AddPayloadProperty(propertyName, propertyValue, healthReporter_, nameof(ActivitySourceInput)); | ||
| } | ||
|
|
||
| private void FlushSamplingInfoCacheIfNeeded() | ||
| { | ||
| if (activitySampling_.Count > SamplingDecisionCacheFlushThreshold) | ||
| { | ||
| lock(activitySampling_) | ||
| { | ||
| if (activitySampling_.Count > SamplingDecisionCacheFlushThreshold) | ||
| { | ||
| activitySampling_.Clear(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
17 changes: 17 additions & 0 deletions
17
src/Microsoft.Diagnostics.EventFlow.Inputs.ActivitySource/ActivitySourceInputFactory.cs
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,17 @@ | ||
| // ------------------------------------------------------------ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License (MIT). See License.txt in the repo root for license information. | ||
| // ------------------------------------------------------------ | ||
|
|
||
| using Microsoft.Extensions.Configuration; | ||
|
|
||
| namespace Microsoft.Diagnostics.EventFlow.Inputs.ActivitySource | ||
| { | ||
| public class ActivitySourceInputFactory : IPipelineItemFactory<ActivitySourceInput> | ||
| { | ||
| public ActivitySourceInput CreateItem(IConfiguration configuration, IHealthReporter healthReporter) | ||
| { | ||
| return new ActivitySourceInput(configuration, healthReporter); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.