forked from Azure/azure-sdk-for-net
-
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.
Update Azure.Core READMES (Azure#9871)
- Loading branch information
Showing
6 changed files
with
142 additions
and
57 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Azure SDK diagnostics | ||
|
|
||
| **NOTE:** Samples in this file apply only to packages that follow [Azure SDK Design Guidelines](https://azure.github.io/azure-sdk/dotnet_introduction.html). Names of such packages usually start with `Azure`. | ||
|
|
||
| ## Logging | ||
|
|
||
| Azure SDKs produce various log messages that include information about: | ||
| 1. Requests and reponses | ||
| 2. Authentication attempts | ||
| 3. Retries | ||
|
|
||
| The simplest way to see the logs is to enable the console logging. | ||
|
|
||
| ```C# Snippet:ConsoleLogging | ||
| // Setup a listener to monitor logged events. | ||
| using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(); | ||
| ``` | ||
|
|
||
| ### Enabling content logging | ||
|
|
||
| By default only URI and headers are logged to enable content logging set the `Diagnostics.IsLoggingContentEnabled` client option: | ||
|
|
||
| ```C# Snippet:LoggingContent | ||
| SecretClientOptions options = new SecretClientOptions() | ||
| { | ||
| Diagnostics = | ||
| { | ||
| IsLoggingContentEnabled = true | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ### Logging redacted headers and query parameters | ||
|
|
||
| Some sensitive headers and query parameters are not logged by default and are displayed as "REDACTED", to include them in logs use the `Diagnostics.LoggedHeaderNames` and `Diagnostics.LoggedQueryParameters` client options. | ||
|
|
||
| ```C# Snippet:LoggingRedactedHeader | ||
| SecretClientOptions options = new SecretClientOptions() | ||
| { | ||
| Diagnostics = | ||
| { | ||
| LoggedHeaderNames = { "x-ms-request-id" }, | ||
| LoggedQueryParameters = { "api-version" } | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| You can also disable redaction completely by adding a `"*"` to collections mentioned above. | ||
|
|
||
| ```C# Snippet:LoggingRedactedHeaderAll | ||
| SecretClientOptions options = new SecretClientOptions() | ||
| { | ||
| Diagnostics = | ||
| { | ||
| LoggedHeaderNames = { "*" }, | ||
| LoggedQueryParameters = { "*" } | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ### ASP.NET Core applications | ||
|
|
||
| If your are using Azure SDK libraries in ASP.NET Core application consider using the `Microsoft.Extensions.Azure` package that provides integration with `Microsoft.Extensions.Logging` library. See [Microsoft.Extensions.Azure readme](../../Microsoft.Extensions.Azure/README.md) for more details. | ||
|
|
||
|
|
||
| ### Custom logging callback | ||
|
|
||
| The `AzureEventSourceListener` class can also be used with a custom callback that allows log messages to be written to destination of your choice. | ||
|
|
||
| ```C# Snippet:LoggingCallback | ||
| using AzureEventSourceListener listener = new AzureEventSourceListener( | ||
| (e, message) => Console.WriteLine($"{DateTime.Now} {message}"), | ||
| level: EventLevel.Verbose); | ||
| ``` | ||
|
|
||
| ## Distributed tracing | ||
|
|
||
| Azure SDKs are instrumented for distributed tracing using ApplicationsInsights or OpenTelemetry. | ||
|
|
||
| ### ApplicationInsights with Azure Monitor | ||
|
|
||
| Application Insights, a feature of Azure Monitor, is an extensible Application Performance Management (APM) service for developers and DevOps professionals. Use it to monitor your live applications. It will automatically detect performance anomalies, and includes powerful analytics tools to help you diagnose issues and to understand what users actually do with your app | ||
|
|
||
| If you application already uses ApplicationInsights, automatic collection of Azure SDK traces is supported since version `2.12.0`. | ||
|
|
||
| To setup ApplicationInsights tracking for your application follow the [Start Monitoring Application](https://docs.microsoft.com/en-us/azure/azure-monitor/learn/dotnetcore-quick-start) guide. | ||
|
|
||
| ### OpenTelemetry with Azure Monitor, Zipkin and others | ||
|
|
||
| Follow the [OpenTelemetry configuration guide](https://github.com/open-telemetry/opentelemetry-dotnet#configuration-with-microsoftextensionsdependencyinjection) to configure collecting distribute tracing event collection using the OpenTelemetry library. |
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