Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thiagobarradas/serilog-sinks-newrelic-logs
A Serilog sink that writes events to the NewRelic Logs.
https://github.com/thiagobarradas/serilog-sinks-newrelic-logs
apm dotnet-core dotnet-core2 dotnet-core3 dotnet-framework dotnet-standard log new-relic newrelic serilog sink
Last synced: 5 days ago
JSON representation
A Serilog sink that writes events to the NewRelic Logs.
- Host: GitHub
- URL: https://github.com/thiagobarradas/serilog-sinks-newrelic-logs
- Owner: ThiagoBarradas
- License: other
- Created: 2020-05-26T02:37:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T18:01:51.000Z (7 months ago)
- Last Synced: 2025-01-09T23:08:22.259Z (12 days ago)
- Topics: apm, dotnet-core, dotnet-core2, dotnet-core3, dotnet-framework, dotnet-standard, log, new-relic, newrelic, serilog, sink
- Language: C#
- Homepage: https://www.nuget.org/packages/Serilog.Sinks.NewRelic.Logs
- Size: 35.2 KB
- Stars: 31
- Watchers: 6
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://barradas.visualstudio.com/Contributions/_build/latest?definitionId=8&branchName=master)
[](https://www.nuget.org/packages/Serilog.Sinks.NewRelic.Logs/)
[](https://www.nuget.org/packages/Serilog.Sinks.NewRelic.Logs/)
[](https://sonarcloud.io/dashboard?id=ThiagoBarradas_serilog-sinks-newrelic-logs)
A Serilog sink that writes events to the [NewRelic Logs](https://docs.newrelic.com/docs/logs/new-relic-logs/get-started/introduction-new-relic-logs).
## Getting started
```csharp
Log.Logger = new LoggerConfiguration()
.WriteTo.NewRelicLogs(
endpointUrl: "https://log-api.newrelic.com/log/v1",
applicationName: "Serilog.Sinks.NewRelic.Sample",
licenseKey: "[Your API key]")
.CreateLogger();
```
If you have new relic agent and use environment variables `NEW_RELIC_APP_NAME` and `NEW_RELIC_LICENSE_KEY`, you can do just:
```csharp
Log.Logger = new LoggerConfiguration()
.WriteTo.NewRelicLogs()
.CreateLogger();
```
The available parameters are:
* `applicationName` of the current application in NewRelic If the parameter is omitted, then the value of the "NewRelic.AppName" appSetting will be used.
* `endpointUrl` is the ingestion URL of NewRelic Logs. The US endpoint is used by default if this value is omitted.
* `licenseKey` is the NewRelic License key, which is also used with the NewRelic Agent.
* `insertKey` is New Relic Insert API key. Either `licenseKey` or `insertKey` must be supplied.
The events are submitted to NewRelic Logs in batches, and the sink is derived from [PeriodicBatchingSink](https://github.com/serilog/serilog-sinks-periodicbatching). It therefore supports the following parameter:
* `batchSizeLimit` is the maximum number of events to include in a single batch. Default is 1000 entries
* `period` is the time to wait between checking for event batches. It is TimeSpan with a default value of 2 seconds. If provided from [AppSettings](https://github.com/serilog/serilog/wiki/AppSettings),
the value should be given as an absolute time span, i.e.: "0.00:00:05" standing for 5 seconds.
The batches are formatted using NewRelic Logs [detailed JSON body](https://docs.newrelic.com/docs/logs/new-relic-logs/log-api/introduction-log-api#json-content) and are transmitted GZip-compressed.
All properties along with the rendered message will be emitted to NewRelic Logs.
This sink adds four additional properties:
* `timestamp` in milliseconds since epoch
* `application` holds the value from `applicationName`
* `level` is the actual log level of the event.
* `stack_trace` holds the stack trace portion of an exception.
* `exception` holds the `.toString()` of an exception.
If `newrelic.linkingmetadata` property is present in an event, it will be unrolled into individual NewRelic properties used for "logs in context".
## Install via NuGet
```
PM> Install-Package Serilog.Sinks.NewRelic.Logs
```
### JSON configuration
It is possible to configure the sink using [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration) by specifying the license key and other desired parameters in `appsettings.json`:
```
{
"Serilog": {
"Using": [ "Serilog.Sinks.NewRelic.Logs" ],
"WriteTo": [
{
"Name": "NewRelicLogs",
"Args": {
"applicationName": "NewRelicLogTestSample",
"licenseKey": "58e9892abd3f09d91b0db0d0e9e95628FFFFNRAL"
//... other parameters
}
}
],
"Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId", "WithNewRelicLogsInContext" ]
}
}
```
## Contributors
This code is based on https://github.com/stanisls/serilog-sinks-newreliclogs
Thanks [@stanisls](https://github.com/stanisls) and [@johnkattenhorn](https://github.com/johnkattenhorn) :muscle:
## How can I contribute?
Please, refer to [CONTRIBUTING](.github/CONTRIBUTING.md)
## Found something strange or need a new feature?
Open a new Issue following our issue template [ISSUE_TEMPLATE](.github/ISSUE_TEMPLATE.md)
## Changelog
See in [nuget version history](https://www.nuget.org/packages/JsonMasking)
## Did you like it? Please, make a donate :)
if you liked this project, please make a contribution and help to keep this and other initiatives, send me some Satochis.
BTC Wallet: `1G535x1rYdMo9CNdTGK3eG6XJddBHdaqfX`
