| | | 1 | | // Copyright (c) Microsoft Corporation. All rights reserved. |
| | | 2 | | // Licensed under the MIT License. |
| | | 3 | | |
| | | 4 | | using System; |
| | | 5 | | using System.Collections.Generic; |
| | | 6 | | using System.Diagnostics; |
| | | 7 | | using System.Globalization; |
| | | 8 | | using System.IO; |
| | | 9 | | using System.Linq; |
| | | 10 | | using System.Reflection; |
| | | 11 | | using System.Text; |
| | | 12 | | using System.Threading.Tasks; |
| | | 13 | | using Azure.Core.Pipeline; |
| | | 14 | | |
| | | 15 | | #nullable enable |
| | | 16 | | |
| | | 17 | | namespace Azure.Core.Pipeline |
| | | 18 | | { |
| | | 19 | | internal sealed partial class ClientDiagnostics : DiagnosticScopeFactory |
| | | 20 | | { |
| | | 21 | | private const string DefaultMessage = "Service request failed."; |
| | | 22 | | |
| | | 23 | | private readonly HttpMessageSanitizer _sanitizer; |
| | 43 | 24 | | public ClientDiagnostics(ClientOptions options) : base( |
| | 43 | 25 | | options.GetType().Namespace!, |
| | 43 | 26 | | GetResourceProviderNamespace(options.GetType().Assembly), |
| | 43 | 27 | | options.Diagnostics.IsDistributedTracingEnabled) |
| | | 28 | | { |
| | 43 | 29 | | _sanitizer = new HttpMessageSanitizer( |
| | 43 | 30 | | options.Diagnostics.LoggedQueryParameters.ToArray(), |
| | 43 | 31 | | options.Diagnostics.LoggedHeaderNames.ToArray()); |
| | 43 | 32 | | } |
| | | 33 | | |
| | | 34 | | /// <summary> |
| | | 35 | | /// Partial method that can optionally be defined to extract the error |
| | | 36 | | /// message, code, and details in a service specific manner. |
| | | 37 | | /// </summary> |
| | | 38 | | /// <param name="content">The error content.</param> |
| | | 39 | | /// <param name="message">The error message.</param> |
| | | 40 | | /// <param name="errorCode">The error code.</param> |
| | | 41 | | /// <param name="additionalInfo">Additional error details.</param> |
| | | 42 | | partial void ExtractFailureContent( |
| | | 43 | | string? content, |
| | | 44 | | ref string? message, |
| | | 45 | | ref string? errorCode, |
| | | 46 | | ref IDictionary<string, string>? additionalInfo); |
| | | 47 | | |
| | | 48 | | public async ValueTask<RequestFailedException> CreateRequestFailedExceptionAsync(Response response, string? mess |
| | | 49 | | { |
| | 34 | 50 | | var content = await ReadContentAsync(response, true).ConfigureAwait(false); |
| | 34 | 51 | | ExtractFailureContent(content, ref message, ref errorCode, ref additionalInfo); |
| | 34 | 52 | | return CreateRequestFailedExceptionWithContent(response, message, content, errorCode, additionalInfo, innerE |
| | 34 | 53 | | } |
| | | 54 | | |
| | | 55 | | public RequestFailedException CreateRequestFailedException(Response response, string? message = null, string? er |
| | | 56 | | { |
| | 0 | 57 | | string? content = ReadContentAsync(response, false).EnsureCompleted(); |
| | 0 | 58 | | ExtractFailureContent(content, ref message, ref errorCode, ref additionalInfo); |
| | 0 | 59 | | return CreateRequestFailedExceptionWithContent(response, message, content, errorCode, additionalInfo, innerE |
| | | 60 | | } |
| | | 61 | | |
| | | 62 | | public RequestFailedException CreateRequestFailedExceptionWithContent( |
| | | 63 | | Response response, |
| | | 64 | | string? message = null, |
| | | 65 | | string? content = null, |
| | | 66 | | string? errorCode = null, |
| | | 67 | | IDictionary<string, string>? additionalInfo = null, |
| | | 68 | | Exception? innerException = null) |
| | | 69 | | { |
| | 34 | 70 | | var formatMessage = CreateRequestFailedMessageWithContent(response, message, content, errorCode, additionalI |
| | 34 | 71 | | var exception = new RequestFailedException(response.Status, formatMessage, errorCode, innerException); |
| | | 72 | | |
| | 34 | 73 | | if (additionalInfo != null) |
| | | 74 | | { |
| | 0 | 75 | | foreach (KeyValuePair<string, string> keyValuePair in additionalInfo) |
| | | 76 | | { |
| | 0 | 77 | | exception.Data.Add(keyValuePair.Key, keyValuePair.Value); |
| | | 78 | | } |
| | | 79 | | } |
| | | 80 | | |
| | 34 | 81 | | return exception; |
| | | 82 | | } |
| | | 83 | | |
| | | 84 | | public ValueTask<string> CreateRequestFailedMessageAsync(Response response, string? message = null, string? erro |
| | | 85 | | { |
| | 0 | 86 | | return CreateRequestFailedMessageAsync(response, message, errorCode, additionalInfo, true); |
| | | 87 | | } |
| | | 88 | | |
| | | 89 | | public string CreateRequestFailedMessage(Response response, string? message = null, string? errorCode = null, ID |
| | | 90 | | { |
| | 0 | 91 | | return CreateRequestFailedMessageAsync(response, message, errorCode, additionalInfo, false).EnsureCompleted( |
| | | 92 | | } |
| | | 93 | | |
| | | 94 | | private async ValueTask<string> CreateRequestFailedMessageAsync(Response response, string? message, string? erro |
| | | 95 | | { |
| | 0 | 96 | | var content = await ReadContentAsync(response, async).ConfigureAwait(false); |
| | | 97 | | |
| | 0 | 98 | | return CreateRequestFailedMessageWithContent(response, message, content, errorCode, additionalInfo); |
| | 0 | 99 | | } |
| | | 100 | | |
| | | 101 | | public string CreateRequestFailedMessageWithContent(Response response, string? message, string? content, string? |
| | | 102 | | { |
| | 34 | 103 | | StringBuilder messageBuilder = new StringBuilder() |
| | 34 | 104 | | .AppendLine(message ?? DefaultMessage) |
| | 34 | 105 | | .Append("Status: ") |
| | 34 | 106 | | .Append(response.Status.ToString(CultureInfo.InvariantCulture)); |
| | | 107 | | |
| | 34 | 108 | | if (!string.IsNullOrEmpty(response.ReasonPhrase)) |
| | | 109 | | { |
| | 1 | 110 | | messageBuilder.Append(" (") |
| | 1 | 111 | | .Append(response.ReasonPhrase) |
| | 1 | 112 | | .AppendLine(")"); |
| | | 113 | | } |
| | | 114 | | else |
| | | 115 | | { |
| | 33 | 116 | | messageBuilder.AppendLine(); |
| | | 117 | | } |
| | | 118 | | |
| | 34 | 119 | | if (!string.IsNullOrWhiteSpace(errorCode)) |
| | | 120 | | { |
| | 8 | 121 | | messageBuilder.Append("ErrorCode: ") |
| | 8 | 122 | | .Append(errorCode) |
| | 8 | 123 | | .AppendLine(); |
| | | 124 | | } |
| | | 125 | | |
| | 34 | 126 | | if (additionalInfo != null && additionalInfo.Count > 0) |
| | | 127 | | { |
| | 0 | 128 | | messageBuilder |
| | 0 | 129 | | .AppendLine() |
| | 0 | 130 | | .AppendLine("Additional Information:"); |
| | 0 | 131 | | foreach (KeyValuePair<string, string> info in additionalInfo) |
| | | 132 | | { |
| | 0 | 133 | | messageBuilder |
| | 0 | 134 | | .Append(info.Key) |
| | 0 | 135 | | .Append(": ") |
| | 0 | 136 | | .AppendLine(info.Value); |
| | | 137 | | } |
| | | 138 | | } |
| | | 139 | | |
| | 34 | 140 | | if (content != null) |
| | | 141 | | { |
| | 24 | 142 | | messageBuilder |
| | 24 | 143 | | .AppendLine() |
| | 24 | 144 | | .AppendLine("Content:") |
| | 24 | 145 | | .AppendLine(content); |
| | | 146 | | } |
| | | 147 | | |
| | 34 | 148 | | messageBuilder |
| | 34 | 149 | | .AppendLine() |
| | 34 | 150 | | .AppendLine("Headers:"); |
| | | 151 | | |
| | 332 | 152 | | foreach (HttpHeader responseHeader in response.Headers) |
| | | 153 | | { |
| | 132 | 154 | | string headerValue = _sanitizer.SanitizeHeader(responseHeader.Name, responseHeader.Value); |
| | 132 | 155 | | messageBuilder.AppendLine($"{responseHeader.Name}: {headerValue}"); |
| | | 156 | | } |
| | | 157 | | |
| | 34 | 158 | | return messageBuilder.ToString(); |
| | | 159 | | } |
| | | 160 | | |
| | | 161 | | private static async ValueTask<string?> ReadContentAsync(Response response, bool async) |
| | | 162 | | { |
| | 34 | 163 | | string? content = null; |
| | | 164 | | |
| | 34 | 165 | | if (response.ContentStream != null && |
| | 34 | 166 | | ContentTypeUtilities.TryGetTextEncoding(response.Headers.ContentType, out var encoding)) |
| | | 167 | | { |
| | 24 | 168 | | using (var streamReader = new StreamReader(response.ContentStream, encoding)) |
| | | 169 | | { |
| | 24 | 170 | | content = async ? await streamReader.ReadToEndAsync().ConfigureAwait(false) : streamReader.ReadToEnd |
| | 24 | 171 | | } |
| | | 172 | | } |
| | | 173 | | |
| | 34 | 174 | | return content; |
| | 34 | 175 | | } |
| | | 176 | | |
| | | 177 | | internal static string? GetResourceProviderNamespace(Assembly assembly) |
| | | 178 | | { |
| | 645 | 179 | | foreach (var customAttribute in assembly.GetCustomAttributes(true)) |
| | | 180 | | { |
| | | 181 | | // Weak bind internal shared type |
| | 301 | 182 | | var attributeType = customAttribute.GetType(); |
| | 301 | 183 | | if (attributeType.Name == "AzureResourceProviderNamespaceAttribute") |
| | | 184 | | { |
| | 43 | 185 | | return attributeType.GetProperty("ResourceProviderNamespace")?.GetValue(customAttribute) as string; |
| | | 186 | | } |
| | | 187 | | } |
| | | 188 | | |
| | 0 | 189 | | return null; |
| | | 190 | | } |
| | | 191 | | } |
| | | 192 | | } |