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

Resilience readme, namespace #4659

Merged
merged 1 commit into from
Nov 2, 2023

Conversation

Tratcher
Copy link
Member

@Tratcher Tratcher commented Nov 2, 2023

I moved the ResilienceContext extensions to match the Polly namespace.

Microsoft Reviewers: Open in CodeFlow

@Tratcher Tratcher added this to the 8.0-rtm milestone Nov 2, 2023
@Tratcher Tratcher self-assigned this Nov 2, 2023
@dotnet-comment-bot
Copy link
Collaborator

🎉 Good job! The coverage increased 🎉
Update MinCodeCoverage in the project files.

Project Expected Actual
Microsoft.Extensions.Telemetry 92 93
Microsoft.AspNetCore.Diagnostics.Middleware 99 100
Microsoft.Extensions.Diagnostics.ResourceMonitoring 98 100

Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=458803&view=codecoverage-tab

Copy link
Member

@joperezr joperezr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

public static IServiceCollection AddResilienceEnricher(this IServiceCollection services)
```

This will optionally consume the `IExceptionSummarizer` service if it has been registered and add that data to Polly's telemetry. It will also include `RequestMetadata` that can be set or retrieved with these extensions:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if the README should have a pointer to the exception summarizer package as well as the Telemetry one. That said, it probably makes more sense to point to conceptual docs describing these, so perhaps it's fine to keep as is and once we have those conceptual docs we just add a pointer to those here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, concept doc links would be more helpful.

The services can be registered using the following method:

```csharp
public static IServiceCollection AddResilienceEnricher(this IServiceCollection services)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put a semi-colon on these API blocks. We should standardize when all the READMEs are in

Copy link
Member Author

@Tratcher Tratcher Nov 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does the semi-colon help? Neither are syntactically correct. This is a method definition which would be followed by { ... }. A semi-colon would make sense if this was a calling example like serviceCollection.AddResilienceEnricher();.

@joperezr joperezr merged commit e51e809 into dotnet:release/8.0 Nov 2, 2023
6 checks passed
@Tratcher Tratcher deleted the tratcher/readmes/resilience branch November 3, 2023 18:26
@github-actions github-actions bot locked and limited conversation to collaborators Dec 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants