Skip to content

Commit 3e3be5c

Browse files
committed
docs: add migration notice for ASP.NET Core integration and move changelog to GitHub releases.
1 parent d2fd29a commit 3e3be5c

3 files changed

Lines changed: 7 additions & 9 deletions

File tree

‎Correlate.sln‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
2929
.editorconfig = .editorconfig
3030
.gitignore = .gitignore
3131
appveyor.yml = appveyor.yml
32-
CHANGELOG.md = CHANGELOG.md
3332
Directory.Build.props = Directory.Build.props
3433
README.md = README.md
3534
EndProjectSection

CHANGELOG.md renamed to OLD_CHANGELOG.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
# Changelog
22

3-
## Unreleased
4-
5-
- Added .NET 7 target framework
6-
- Refactored ASP.NET Core integration to be based on `DiagnosticsListener`, by subscribing an observer and watch for HttpRequestIn (activity) events. This gives us the soonest opportunity to create the correlation context. Previously, `.UseCorrelate()` would register middleware. There were a few downsides with that approach, all having to do with _when_ the correlation context actually was being created:
7-
- it was depending on the registration order when considering other middleware. F.ex. if `UseCorrelate()` was not called before any other middleware was registered, the correlation context was also not created as soon as possible.
8-
- the ASP.NET Core its own built-in request-start and request-stop log messages did not have a Correlation ID property attached because the log scope created by Correlate is created after/disposed before these are emitted.
9-
- for unhandled exceptions, the correlation context was already gone in the global exception handler because the request middleware pipeline completes before it gets there (unless you registered a custom one!). Again, this means those (default) log messages would not have a correlation ID property (see previous point).
10-
- the middleware had a little too many allocations to my liking (considering that it runs in a fast-path).
3+
## Future changelog moved to GitHub releases
4+
From v5.0.0 onwards, the changelog can be found at:
5+
https://github.com/skwasjer/Correlate/releases
116

127
## v4.0.0
138

‎src/Correlate.AspNetCore/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
Provides abstractions to correlate requests between microservices.
22

3+
### Migration from v4.x to 5.0.0
4+
5+
- Replace `Correlate.AspNetCore.Middleware` namespace with `Correlate.AspNetCore`.
6+
37
### Useful links
48

59
- [GitHub / docs](https://github.com/skwasjer/Correlate)

0 commit comments

Comments
 (0)