Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More details about setting up logging (IsLoggingContentEnabled) #2383

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/overview/azure/latest/ai.formrecognizer-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -821,7 +821,7 @@ To create an Azure SDK log listener that outputs messages to console use the Azu

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [Diagnostics Samples][logging].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ The simplest way to see the logs is to enable console logging. To create an Azur

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][core_logging].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -326,11 +326,29 @@ The simplest way to see the logs is to enable console logging. To create an Azur

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][core_logging].

#### Logging request and response content

To log the content of requests and responses set `IsLoggingContentEnabled` to true when creating the client and set the log level to verbose.

```C#
QuestionAnsweringClientOptions options = new()
{
Diagnostics =
{
IsLoggingContentEnabled = true
}
};

QuestionAnsweringClient client = new(endpoint, credential, options);

using AzureEventSourceListener listener = AzureEventSourceListener.CreateTraceLogger(level: EventLevel.Verbose);
```

## Next steps

* View our [samples][questionanswering_samples].
Expand Down
2 changes: 1 addition & 1 deletion api/overview/azure/latest/ai.metricsadvisor-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ To create an Azure SDK log listener that outputs messages to the console use the

```C#
// Set up a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [Diagnostics Samples][logging].
Expand Down
20 changes: 19 additions & 1 deletion api/overview/azure/latest/ai.textanalytics-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -758,11 +758,29 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][logging].

#### Logging request and response content

To log the content of requests and responses set `IsLoggingContentEnabled` to true when creating the client and set the log level to verbose.

```C#
TextAnalyticsClientOptions options = new()
{
Diagnostics =
{
IsLoggingContentEnabled = true
}
};

TextAnalyticsClient client = new(endpoint, credential, options);

using AzureEventSourceListener listener = AzureEventSourceListener.CreateTraceLogger(level: EventLevel.Verbose);
```

## Next steps

Samples showing how to use this client library are available in this GitHub repository.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][logging].
Expand Down
2 changes: 1 addition & 1 deletion api/overview/azure/latest/core-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ To create an Azure SDK log listener that outputs messages to console use `AzureE

```C# Snippet:ConsoleLogging
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

More on logging in [diagnostics samples](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Core_1.35.0/sdk/core/Azure.Core/samples/Diagnostics.md).
Expand Down
2 changes: 1 addition & 1 deletion api/overview/azure/latest/data.tables-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][logging].
Expand Down
2 changes: 1 addition & 1 deletion api/overview/azure/latest/identity-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ The simplest way to see the logs to help debug authentication issues is to enabl

``` c#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

All credentials can be configured with diagnostic options, in the same way as other clients in the SDK.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][logging].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ To create an Azure SDK log listener that outputs messages to console, use the `A

```c#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][logging].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][azure_core_diagnostics].
Expand Down
2 changes: 1 addition & 1 deletion api/overview/azure/preview/ai.anomalydetector-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ To create an Azure SDK log listener that outputs messages to console use the Azu

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [Diagnostics Samples][logging].
Expand Down
20 changes: 19 additions & 1 deletion api/overview/azure/preview/ai.contentsafety-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,11 +363,29 @@ To create an Azure SDK log listener that outputs messages to console use the Azu

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [Diagnostics Samples][logging].

#### Logging request and response content

To log the content of requests and responses set `IsLoggingContentEnabled` to true when creating the client and set the log level to verbose.

```C#
ContentSafetyClientOptions options = new()
{
Diagnostics =
{
IsLoggingContentEnabled = true
}
};

ContentSafetyClient client = new(endpoint, credential, options);

using AzureEventSourceListener listener = AzureEventSourceListener.CreateTraceLogger(level: EventLevel.Verbose);
```

## Next steps

### Additional documentation
Expand Down
2 changes: 1 addition & 1 deletion api/overview/azure/preview/ai.metricsadvisor-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ To create an Azure SDK log listener that outputs messages to the console use the

```C#
// Set up a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [Diagnostics Samples][logging].
Expand Down
2 changes: 1 addition & 1 deletion api/overview/azure/preview/ai.translation.text-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][logging].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][azure_core_diagnostics].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][azure_core_diagnostics].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][azure_core_diagnostics].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][azure_core_diagnostics].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][azure_core_diagnostics].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ To create an Azure SDK log listener that outputs messages to console use the Azu

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [Diagnostics Samples][logging].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ To create an Azure SDK log listener that outputs messages to console use the Azu

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [Diagnostics Samples][logging].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The simplest way to see the logs to help debug authentication issues is to enabl

``` c#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

All credentials can be configured with diagnostic options, in the same way as other clients in the SDK.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ To create an Azure SDK log listener that outputs messages to console use AzureEv

```C#
// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(level: EventLevel.Informational);
```

To learn more about other logging mechanisms see [here][azure_core_diagnostics].
Expand Down