feat: add semantic logging support for Akka.NET 1.5.56+ #242
Conversation
This file contains hidden or 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
Enhances NLogLogger to leverage Akka.NET's new semantic logging APIs
introduced in version 1.5.56. This change enables structured properties
to be accessible in NLog's LogEventInfo.Properties dictionary.
Changes:
- Modified NLogLogger.LogEvent() to extract structured properties using
TryGetProperties() and populate LogEventInfo.Properties dictionary
- NLog layouts and targets can now access structured properties by name
using ${event-properties:PropertyName} syntax
- Added comprehensive test suite (SemanticLoggingSpecs.cs) with 8 tests covering:
* Named and positional template properties
* Multiple properties handling
* Complex object properties
* Akka metadata preservation
* Format specifiers handling
* ${all-event-properties} support
All existing tests pass (8 tests). Backwards compatible through
TryGetProperties() conditional check.
Example NLog layout usage:
${event-properties:UserId}|${event-properties:Email}
Depends on: Akka.NET >= 1.5.56
- Updated Akka.NET dependency from 1.5.46 to 1.5.56 - Added FluentAssertions package for semantic logging tests - Required for semantic logging API support
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds semantic logging support to leverage Akka.NET's new semantic logging APIs introduced in version 1.5.56.
This enhancement populates NLog's LogEventInfo.Properties dictionary with structured properties extracted from log message templates, enabling NLog layouts and targets to access structured data by property name.
Changes
Test Coverage
New test suite includes:
All 8 existing tests pass.
Example Usage
NLog layouts can now access structured properties using event-properties syntax, or access all properties at once.
Backwards Compatibility
Fully backwards compatible through conditional TryGetProperties() check. Works with both older and newer Akka.NET versions.
Dependencies
Requires Akka.NET >= 1.5.56 (not yet released)
Notes