-
Notifications
You must be signed in to change notification settings - Fork 773
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
3,299 additions
and
3,296 deletions.
There are no files selected for viewing
318 changes: 159 additions & 159 deletions
318
src/Microsoft.AspNet.TelemetryCorrelation/ActivityExtensions.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 |
|---|---|---|
| @@ -1,159 +1,159 @@ | ||
| // <copyright file="ActivityExtensions.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System; | ||
| using System.Collections.Specialized; | ||
| using System.ComponentModel; | ||
| using System.Diagnostics; | ||
|
|
||
| namespace Microsoft.AspNet.TelemetryCorrelation | ||
| { | ||
| /// <summary> | ||
| /// Extensions of Activity class. | ||
| /// </summary> | ||
| [EditorBrowsable(EditorBrowsableState.Never)] | ||
| public static class ActivityExtensions | ||
| { | ||
| /// <summary> | ||
| /// Http header name to carry the Request Id: https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. | ||
| /// </summary> | ||
| internal const string RequestIdHeaderName = "Request-Id"; | ||
|
|
||
| /// <summary> | ||
| /// Http header name to carry the traceparent: https://www.w3.org/TR/trace-context/. | ||
| /// </summary> | ||
| internal const string TraceparentHeaderName = "traceparent"; | ||
|
|
||
| /// <summary> | ||
| /// Http header name to carry the tracestate: https://www.w3.org/TR/trace-context/. | ||
| /// </summary> | ||
| internal const string TracestateHeaderName = "tracestate"; | ||
|
|
||
| /// <summary> | ||
| /// Http header name to carry the correlation context. | ||
| /// </summary> | ||
| internal const string CorrelationContextHeaderName = "Correlation-Context"; | ||
|
|
||
| /// <summary> | ||
| /// Maximum length of Correlation-Context header value. | ||
| /// </summary> | ||
| internal const int MaxCorrelationContextLength = 1024; | ||
|
|
||
| /// <summary> | ||
| /// Reads Request-Id and Correlation-Context headers and sets ParentId and Baggage on Activity. | ||
| /// </summary> | ||
| /// <param name="activity">Instance of activity that has not been started yet.</param> | ||
| /// <param name="requestHeaders">Request headers collection.</param> | ||
| /// <returns>true if request was parsed successfully, false - otherwise.</returns> | ||
| public static bool Extract(this Activity activity, NameValueCollection requestHeaders) | ||
| { | ||
| if (activity == null) | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("activity is null"); | ||
| return false; | ||
| } | ||
|
|
||
| if (activity.ParentId != null) | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("ParentId is already set on activity"); | ||
| return false; | ||
| } | ||
|
|
||
| if (activity.Id != null) | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("Activity is already started"); | ||
| return false; | ||
| } | ||
|
|
||
| var parents = requestHeaders.GetValues(TraceparentHeaderName); | ||
| if (parents == null || parents.Length == 0) | ||
| { | ||
| parents = requestHeaders.GetValues(RequestIdHeaderName); | ||
| } | ||
|
|
||
| if (parents != null && parents.Length > 0 && !string.IsNullOrEmpty(parents[0])) | ||
| { | ||
| // there may be several Request-Id or traceparent headers, but we only read the first one | ||
| activity.SetParentId(parents[0]); | ||
|
|
||
| var tracestates = requestHeaders.GetValues(TracestateHeaderName); | ||
| if (tracestates != null && tracestates.Length > 0) | ||
| { | ||
| if (tracestates.Length == 1 && !string.IsNullOrEmpty(tracestates[0])) | ||
| { | ||
| activity.TraceStateString = tracestates[0]; | ||
| } | ||
| else | ||
| { | ||
| activity.TraceStateString = string.Join(",", tracestates); | ||
| } | ||
| } | ||
|
|
||
| // Header format - Correlation-Context: key1=value1, key2=value2 | ||
| var baggages = requestHeaders.GetValues(CorrelationContextHeaderName); | ||
| if (baggages != null) | ||
| { | ||
| int correlationContextLength = -1; | ||
|
|
||
| // there may be several Correlation-Context header | ||
| foreach (var item in baggages) | ||
| { | ||
| if (correlationContextLength >= MaxCorrelationContextLength) | ||
| { | ||
| break; | ||
| } | ||
|
|
||
| foreach (var pair in item.Split(',')) | ||
| { | ||
| correlationContextLength += pair.Length + 1; // pair and comma | ||
|
|
||
| if (correlationContextLength >= MaxCorrelationContextLength) | ||
| { | ||
| break; | ||
| } | ||
|
|
||
| if (NameValueHeaderValue.TryParse(pair, out NameValueHeaderValue baggageItem)) | ||
| { | ||
| activity.AddBaggage(baggageItem.Name, baggageItem.Value); | ||
| } | ||
| else | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.HeaderParsingError(CorrelationContextHeaderName, pair); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Reads Request-Id and Correlation-Context headers and sets ParentId and Baggage on Activity. | ||
| /// </summary> | ||
| /// <param name="activity">Instance of activity that has not been started yet.</param> | ||
| /// <param name="requestHeaders">Request headers collection.</param> | ||
| /// <returns>true if request was parsed successfully, false - otherwise.</returns> | ||
| [Obsolete("Method is obsolete, use Extract method instead", true)] | ||
| [EditorBrowsable(EditorBrowsableState.Never)] | ||
| public static bool TryParse(this Activity activity, NameValueCollection requestHeaders) | ||
| { | ||
| return Extract(activity, requestHeaders); | ||
| } | ||
| } | ||
| } | ||
| // <copyright file="ActivityExtensions.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System; | ||
| using System.Collections.Specialized; | ||
| using System.ComponentModel; | ||
| using System.Diagnostics; | ||
|
|
||
| namespace Microsoft.AspNet.TelemetryCorrelation | ||
| { | ||
| /// <summary> | ||
| /// Extensions of Activity class. | ||
| /// </summary> | ||
| [EditorBrowsable(EditorBrowsableState.Never)] | ||
| public static class ActivityExtensions | ||
| { | ||
| /// <summary> | ||
| /// Http header name to carry the Request Id: https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. | ||
| /// </summary> | ||
| internal const string RequestIdHeaderName = "Request-Id"; | ||
|
|
||
| /// <summary> | ||
| /// Http header name to carry the traceparent: https://www.w3.org/TR/trace-context/. | ||
| /// </summary> | ||
| internal const string TraceparentHeaderName = "traceparent"; | ||
|
|
||
| /// <summary> | ||
| /// Http header name to carry the tracestate: https://www.w3.org/TR/trace-context/. | ||
| /// </summary> | ||
| internal const string TracestateHeaderName = "tracestate"; | ||
|
|
||
| /// <summary> | ||
| /// Http header name to carry the correlation context. | ||
| /// </summary> | ||
| internal const string CorrelationContextHeaderName = "Correlation-Context"; | ||
|
|
||
| /// <summary> | ||
| /// Maximum length of Correlation-Context header value. | ||
| /// </summary> | ||
| internal const int MaxCorrelationContextLength = 1024; | ||
|
|
||
| /// <summary> | ||
| /// Reads Request-Id and Correlation-Context headers and sets ParentId and Baggage on Activity. | ||
| /// </summary> | ||
| /// <param name="activity">Instance of activity that has not been started yet.</param> | ||
| /// <param name="requestHeaders">Request headers collection.</param> | ||
| /// <returns>true if request was parsed successfully, false - otherwise.</returns> | ||
| public static bool Extract(this Activity activity, NameValueCollection requestHeaders) | ||
| { | ||
| if (activity == null) | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("activity is null"); | ||
| return false; | ||
| } | ||
|
|
||
| if (activity.ParentId != null) | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("ParentId is already set on activity"); | ||
| return false; | ||
| } | ||
|
|
||
| if (activity.Id != null) | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("Activity is already started"); | ||
| return false; | ||
| } | ||
|
|
||
| var parents = requestHeaders.GetValues(TraceparentHeaderName); | ||
| if (parents == null || parents.Length == 0) | ||
| { | ||
| parents = requestHeaders.GetValues(RequestIdHeaderName); | ||
| } | ||
|
|
||
| if (parents != null && parents.Length > 0 && !string.IsNullOrEmpty(parents[0])) | ||
| { | ||
| // there may be several Request-Id or traceparent headers, but we only read the first one | ||
| activity.SetParentId(parents[0]); | ||
|
|
||
| var tracestates = requestHeaders.GetValues(TracestateHeaderName); | ||
| if (tracestates != null && tracestates.Length > 0) | ||
| { | ||
| if (tracestates.Length == 1 && !string.IsNullOrEmpty(tracestates[0])) | ||
| { | ||
| activity.TraceStateString = tracestates[0]; | ||
| } | ||
| else | ||
| { | ||
| activity.TraceStateString = string.Join(",", tracestates); | ||
| } | ||
| } | ||
|
|
||
| // Header format - Correlation-Context: key1=value1, key2=value2 | ||
| var baggages = requestHeaders.GetValues(CorrelationContextHeaderName); | ||
| if (baggages != null) | ||
| { | ||
| int correlationContextLength = -1; | ||
|
|
||
| // there may be several Correlation-Context header | ||
| foreach (var item in baggages) | ||
| { | ||
| if (correlationContextLength >= MaxCorrelationContextLength) | ||
| { | ||
| break; | ||
| } | ||
|
|
||
| foreach (var pair in item.Split(',')) | ||
| { | ||
| correlationContextLength += pair.Length + 1; // pair and comma | ||
|
|
||
| if (correlationContextLength >= MaxCorrelationContextLength) | ||
| { | ||
| break; | ||
| } | ||
|
|
||
| if (NameValueHeaderValue.TryParse(pair, out NameValueHeaderValue baggageItem)) | ||
| { | ||
| activity.AddBaggage(baggageItem.Name, baggageItem.Value); | ||
| } | ||
| else | ||
| { | ||
| AspNetTelemetryCorrelationEventSource.Log.HeaderParsingError(CorrelationContextHeaderName, pair); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Reads Request-Id and Correlation-Context headers and sets ParentId and Baggage on Activity. | ||
| /// </summary> | ||
| /// <param name="activity">Instance of activity that has not been started yet.</param> | ||
| /// <param name="requestHeaders">Request headers collection.</param> | ||
| /// <returns>true if request was parsed successfully, false - otherwise.</returns> | ||
| [Obsolete("Method is obsolete, use Extract method instead", true)] | ||
| [EditorBrowsable(EditorBrowsableState.Never)] | ||
| public static bool TryParse(this Activity activity, NameValueCollection requestHeaders) | ||
| { | ||
| return Extract(activity, requestHeaders); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.