Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datalust/serilog-sinks-seq
A Serilog sink that writes events to the Seq structured log server
https://github.com/datalust/serilog-sinks-seq
seq serilog serilog-sink
Last synced: 6 days ago
JSON representation
A Serilog sink that writes events to the Seq structured log server
- Host: GitHub
- URL: https://github.com/datalust/serilog-sinks-seq
- Owner: datalust
- License: apache-2.0
- Created: 2015-02-22T22:55:09.000Z (almost 10 years ago)
- Default Branch: dev
- Last Pushed: 2024-12-20T23:14:41.000Z (13 days ago)
- Last Synced: 2024-12-21T00:19:36.263Z (13 days ago)
- Topics: seq, serilog, serilog-sink
- Language: C#
- Homepage: https://datalust.co/seq
- Size: 854 KB
- Stars: 241
- Watchers: 15
- Forks: 51
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Serilog.Sinks.Seq [](https://github.com/datalust/serilog-sinks-seq/actions) [](https://nuget.org/packages/serilog.sinks.seq)
A Serilog sink that writes events to the [Seq](https://datalust.co/seq) structured log server. Supports all modern .NET platforms.
[
](https://nuget.org/packages/serilog.sinks.seq)
> [!TIP]
> If you would like to see timing and dependency information in Seq, [SerilogTracing](https://github.com/serilog-tracing/serilog-tracing) is a Serilog extension that can send both logs and traces through this sink.
### Getting started
Install _Serilog.Sinks.Seq_ into your .NET project:
```powershell
> dotnet add package Serilog.Sinks.Seq
```
Point the logger to Seq:
```csharp
Log.Logger = new LoggerConfiguration()
.WriteTo.Seq("http://localhost:5341")
.CreateLogger();
```
And use the Serilog logging methods to associate named properties with log events:
```csharp
Log.Error("Failed to log on user {ContactId}", contactId);
```
Then query log event properties like `ContactId` from the browser:
When the application shuts down, [ensure any buffered events are propertly flushed to Seq](https://merbla.com/2016/07/06/serilog-log-closeandflush/) by disposing the logger or calling `Log.CloseAndFlush()`:
```csharp
Log.CloseAndFlush();
```
The sink can take advantage of Seq's [API keys](https://docs.datalust.co/docs/api-keys) to authenticate clients and dynamically attach properties to events at the server-side. To use an API key, specify it in the `apiKey` parameter of `WriteTo.Seq()`.
### XML `` configuration
To adjust the Seq server URL at deployment time, it's often convenient to configure it using XML ``, in the `App.config` or `Web.config` file.
Before Serilog can be configured using XML, the [Serilog.Settings.AppSettings](https://nuget.org/packages/serilog.settings.appsettings) package must be installed and enabled using the `LoggerConfiguration`:
```csharp
Log.Logger = new LoggerConfiguration()
.ReadFrom.AppSettings()
.CreateLogger();
```
When XML is used for configuration, it's not necessary to include the `WriteTo.Seq()` method. It is important however that the _Serilog.Sinks.Seq.dll_ assembly is present alongside the app's binaries.
The settings typically included are:
```xml
```
Serilog's XML configuration has several other capabilities that are described on the [Serilog wiki](https://github.com/serilog/serilog/wiki/AppSettings).
### JSON `appsettings.json` configuration
To use the Seq sink with _Microsoft.Extensions.Configuration_, for example with ASP.NET Core or .NET Core, use the [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration) package. First install that package if you have not already done so:
```powershell
dotnet add package Serilog.Settings.Configuration
```
Instead of configuring the Seq sink directly in code, call `ReadFrom.Configuration()`:
```csharp
var configuration = new ConfigurationBuilder()
.AddJsonFile("appsettings.json")
.Build();
var logger = new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
.CreateLogger();
```
In your `appsettings.json` file, under the `Serilog` node, :
```json
{
"Serilog": {
"WriteTo": [
{ "Name": "Seq", "Args": { "serverUrl": "http://localhost:5341" } }
]
}
}
```
See the XML `` example above for a discussion of available `Args` options.
### Dynamic log level control
The Seq sink can dynamically adjust the logging level up or down based on the level associated with an API key in Seq. To use this feature, create a `LoggingLevelSwitch` to control the `MinimumLevel`, and pass this in the `controlLevelSwitch` parameter of `WriteTo.Seq()`:
```csharp
var levelSwitch = new LoggingLevelSwitch();
Log.Logger = new LoggerConfiguration()
.MinimumLevel.ControlledBy(levelSwitch)
.WriteTo.Seq("http://localhost:5341",
apiKey: "yeEZyL3SMcxEKUijBjN",
controlLevelSwitch: levelSwitch)
.CreateLogger();
```
The equivalent configuration in XML (Serilog 2.6+) is:
```xml
```
The equivalent configuration in JSON is:
```json
{
"Serilog":
{
"LevelSwitches": { "$controlSwitch": "Information" },
"MinimumLevel": { "ControlledBy": "$controlSwitch" },
"WriteTo":
[{
"Name": "Seq",
"Args":
{
"serverUrl": "http://localhost:5341",
"apiKey": "yeEZyL3SMcxEKUijBjN",
"controlLevelSwitch": "$controlSwitch"
}
}]
}
}
```
For further information see the [Seq documentation](https://docs.datalust.co/docs/using-serilog#dynamic-level-control).
### Troubleshooting
> Nothing showed up, what can I do?
If events don't appear in Seq after pressing the refresh button in the _filter bar_, either your application was unable to contact the Seq server, or else the Seq server rejected the log events for some reason.
#### Server-side issues
The Seq server may reject incoming events if they're missing a required API key, if the payload is corrupted somehow, or if the log events are too large to accept.
Server-side issues are diagnosed using the Seq _Ingestion Log_, which shows the details of any problems detected on the server side. The ingestion log is linked from the _Settings_ > _Diagnostics_ page in the Seq user interface.
#### Client-side issues
If there's no information in the ingestion log, the application was probably unable to reach the server because of network configuration or connectivity issues. These are reported to the application through Serilog's `SelfLog`.
Add the following line after the logger is configured to print any error information to the console:
```csharp
Serilog.Debugging.SelfLog.Enable(Console.Error);
```
If the console is not available, you can pass a delegate into `SelfLog.Enable()` that will be called with each error message:
```csharp
Serilog.Debugging.SelfLog.Enable(message => {
// Do something with `message`
});
```
#### Troubleshooting checklist
* Check the Seq _Ingestion Log_, as described in the _Server-side issues_ section above.
* Turn on the Serilog `SelfLog` as described above to check for connectivity problems and other issues on the client side.
* Make sure your application calls `Log.CloseAndFlush()`, or disposes the root `Logger`, before it exits - otherwise, buffered events may be lost.
* If your app is a Windows console application, it is also important to close the console window by exiting the app; Windows console apps are terminated "hard" if the close button in the title bar is used, so events buffered for sending to Seq may be lost if you use it.
* [Raise an issue](https://github.com/serilog/serilog-sinks-seq/issues), ask for help on the [Seq support forum](https://docs.datalust.co/discuss) or email **[email protected]**.