Skip to content

Add syntax highlighting to README.md #4

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add syntax highlighting to README.md #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1c3aed
Add syntax highlighting to README.md
rklec Aug 30, 2024
12f277b
Fix missing indentation
rklec Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,23 @@ For more background on Polly see the [main Polly repo](https://github.com/App-vN

Define an `Action<ILogger, Context, DelegateResult<TResult>> logAction` to log exceptions or results. The `Context` input parameter allows filtering based on Polly's in-built [execution metadata](https://github.com/App-vNext/Polly/wiki/Keys-And-Context-Data) or context you pass in to the execution.

Action<ILogger, Context, DelegateResult<HttpResponseMessage>> logAction = (logger, context, outcome) =>
{
logger.LogError("The call resulted in outcome: {happened}", outcome.Exception?.Message ?? outcome.Result.StatusCode.ToString());
}
```csharp
Action<ILogger, Context, DelegateResult<HttpResponseMessage>> logAction = (logger, context, outcome) =>
{
logger.LogError("The call resulted in outcome: {happened}", outcome.Exception?.Message ?? outcome.Result.StatusCode.ToString());
}
```

Define a `Func<Context, ILogger> loggerProvider` to select an `ILogger` based on `Context`. This can use the extension method `Context.GetLogger()` defined on `Polly.Context`, if execution dispatch uses the `Context.WithLogger(ILogger)` overload, as demonstrated in the ConsoleApp example.

Configure the policy:

var loggingPolicy = Policy<HttpResponseMessage>
.Handle<HttpRequestException>()
.OrResult((int)response.StatusCode >= 500 || response.StatusCode == HttpStatusCode.RequestTimeout)
.AsyncLog(ctx => ctx.GetLogger(), logAction);
```csharp
var loggingPolicy = Policy<HttpResponseMessage>
.Handle<HttpRequestException>()
.OrResult((int)response.StatusCode >= 500 || response.StatusCode == HttpStatusCode.RequestTimeout)
.AsyncLog(ctx => ctx.GetLogger(), logAction);
```

The policy would typically be combined with other policies in a PolicyWrap - see below.

Expand All @@ -32,9 +36,11 @@ Define a `logAction` and `loggerProvider` as above.

Configure the policy, for example:

var loggingPolicy = Policy
.Handle<Exception>()
.Log(ctx => ctx.GetLogger(), logAction);
```csharp
var loggingPolicy = Policy
.Handle<Exception>()
.Log(ctx => ctx.GetLogger(), logAction);
```

### Using LoggingPolicy in PolicyWrap

Expand Down