Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/byndyusoft/byndyusoft.aspnetcore.instrumentation.tracing
ASP.NET Core MVC tracing.
https://github.com/byndyusoft/byndyusoft.aspnetcore.instrumentation.tracing
aspnet aspnetcore byndyusoft tracing
Last synced: 22 days ago
JSON representation
ASP.NET Core MVC tracing.
- Host: GitHub
- URL: https://github.com/byndyusoft/byndyusoft.aspnetcore.instrumentation.tracing
- Owner: Byndyusoft
- License: mit
- Created: 2022-02-13T15:14:48.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T09:16:27.000Z (8 months ago)
- Last Synced: 2024-05-23T09:36:16.394Z (8 months ago)
- Topics: aspnet, aspnetcore, byndyusoft, tracing
- Language: C#
- Homepage: https://en.byndyusoft.com
- Size: 148 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Byndyusoft.AspNetCore.Instrumentation.Tracing
ASP.NET Core MVC tracing.
[](LICENSE.txt)
[](https://www.nuget.org/packages/Byndyusoft.AspNetCore.Instrumentation.Tracing/) [](https://www.nuget.org/packages/Byndyusoft.AspNetCore.Instrumentation.Tracing/)
## Installing
```shell
dotnet add package Byndyusoft.AspNetCore.Instrumentation.Tracing
```
## Usages
```csharp
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers()
.AddTracing();
...
}
}
```
## Configuring
```csharp
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers()
.AddTracing(options =>
{
options.TagRequestParamsInTrace = true;
options.EnrichLogsWithParams = true;
options.EnrichLogsWithHttpInfo = true;
options.ValueMaxStringLength = 50;
options.Formatter = new SystemTextJsonFormatter
{
Options = new JsonSerializerOptions(JsonSerializerDefaults.Web)
{
Converters =
{
new JsonStringEnumConverter()
}
}
};
});
...
}
}
```
There are some default option parameters:
1. EnrichTraceWithTaggedRequestParams — if true then http request params will be added to trace tags. Default: true. For more detail how params are extracted, refer to [page](https://github.com/Byndyusoft/Byndyusoft.Telemetry#object-telemetry-item-collector).
2. EnrichLogsWithParams — if true then every log will be enriched with request params during this request. Default: true. For more detail how params are extracted, refer to [page](https://github.com/Byndyusoft/Byndyusoft.Telemetry#object-telemetry-item-collector).
3. EnrichLogsWithHttpInfo — if true then every log will be enriched with request http info during this request. Default: true.
4. ValueMaxStringLength — maximum number of serialized request and response body string length. This string will be written to trace events and/or logs. The excess will be trimmed. Default: null - unlimited.
5. Formatter — it is used to serialize request and response body. Default: [SystemTextJsonFormatter](src/Byndyusoft.AspNetCore.Instrumentation.Tracing/Serialization/Json/SystemTextJsonFormatter.cs).
## MaskedSerialization
Masked serialization package [Byndyusoft.MaskedSerialization](https://github.com/Byndyusoft/Byndyusoft.MaskedSerialization) is used to hide sensitive data. Is it implemented in [NewtonsoftJsonFormatter.cs](https://github.com/Byndyusoft/Byndyusoft.AspNetCore.Instrumentation.Tracing/blob/master/src/Byndyusoft.AspNetCore.Instrumentation.Tracing/Serialization/Json/NewtonsoftJsonFormatter.cs) class.
# Contributing
To contribute, you will need to setup your local environment, see [prerequisites](#prerequisites). For the contribution and workflow guide, see [package development lifecycle](#package-development-lifecycle).
A detailed overview on how to contribute can be found in the [contributing guide](CONTRIBUTING.md).
## Prerequisites
Make sure you have installed all of the following prerequisites on your development machine:
- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
- .NET Core (version 8.0 or higher) - [Download & Install .NET Core](https://dotnet.microsoft.com/download/dotnet-core/8.0).
## General folders layout
### src
- source code
### tests
- unit-tests
### example
- example application
## Package development lifecycle
- Implement package logic in `src`
- Add or addapt unit-tests (prefer before and simultaneously with coding) in `tests`
- Add or change the documentation as needed
- Open pull request in the correct branch. Target the project's `master` branch
# Maintainers
[[email protected]](mailto:[email protected])