https://github.com/pm4net/serilog-sinks-ocel
Serilog sinks that write events to Object-Centric Event Logs (OCEL)
https://github.com/pm4net/serilog-sinks-ocel
dotnet ocel process-mining
Last synced: 5 months ago
JSON representation
Serilog sinks that write events to Object-Centric Event Logs (OCEL)
- Host: GitHub
- URL: https://github.com/pm4net/serilog-sinks-ocel
- Owner: pm4net
- License: apache-2.0
- Created: 2022-11-02T11:12:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T11:20:35.000Z (over 2 years ago)
- Last Synced: 2024-08-31T00:36:36.656Z (almost 2 years ago)
- Topics: dotnet, ocel, process-mining
- Language: C#
- Homepage:
- Size: 94.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serilog.Sinks.OCEL
[](https://github.com/pm4net/serilog-sinks-ocel/blob/master/LICENSE)
[](https://github.com/pm4net/serilog-sinks-ocel/actions/workflows/tests.yml)
[](https://www.nuget.org/packages/Serilog.Sinks.OCEL/)
[](https://www.nuget.org/packages/Serilog.Sinks.OCEL/#versions-body-tab)
Serilog sinks that write events to Object-Centric Event Logs (OCEL) [1], using the [.NET OCEL library](https://github.com/pm4net/OCEL).
There is a separate sinks for each of the supported OCEL format: `Serilog.Sinks.OCEL.Sinks.OcelJsonSink`, `Serilog.Sinks.OCEL.Sinks.OcelXmlSink`, and `Serilog.Sinks.OCEL.Sinks.OcelLiteDbSink`.
Rolling files are supported by configuring the log directory and file name separately. Depending on the [rolling period](https://github.com/pm4net/serilog-sinks-ocel/blob/master/Serilog.Sinks.OCEL/RollingPeriod.cs), the file name is prepended with an identifier.
Sample configuration:
```csharp
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Information()
.WriteTo.OcelLiteDbSink(new LiteDbSinkOptions(string.Empty, "log.db", RollingPeriod.Never))
.CreateLogger();
```
Or via `appsettings.json` (using [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration)):
```json
"Serilog": {
"MinimumLevel": {
"Default": "Information"
},
"WriteTo": [
{
"Name": "Console"
},
{
"Name": "OcelJsonSink",
"Args": {
"directory": "",
"fileName": "log.jsonocel",
"rollingPeriod": "Month",
"formatting": "Indented",
"prefix": "myprefix_"
}
}
]
}
```
# Supported formats
The OCEL standard is defined for both JSON and XML. Both include a validation schema that is used by the library to validate input.
An additional useful format is to store OCEL data in document databases such as MongoDB [2]. A very good alternative for .NET is [LiteDB](https://www.litedb.org/), which is an embedded NoSQL database that is similar to MongoDB. It allows writing to files directly and does not require a database server to use. Support for MongoDB will be evaluated in the future.
| Format | Status |
| ------------- |:-------------:|
| JSON | Implemented |
| XML | Implemented |
| LiteDB | Implemented |
| MongoDB | TBD |
# Performance
JSON and XML files cannot simply be appended like a text file or a database table. The entire file has to be rewritten each time, which is expensive. If you are going to use either the JSON or XML sink, make sure to use short rolling periods to avoid log files with more than a few thousand events at a time. It is generally **recommended to use the LiteDb sink for all logging** due to better performance, even though LiteDb files tend to be larger in size overall. The [OCEL library](https://github.com/pm4net/OCEL) can be used to later convert between formats or even merge multiple files together.
# References
[1] Farhang, A., Park, G. G., Berti, A., & Aalst, W. Van Der. (2020). OCEL Standard. http://ocel-standard.org/
[2] Berti, A., Ghahfarokhi, A. F., Park, G., & van der Aalst, W. M. P. (2021). A Scalable Database for the Storage of Object-Centric Event Logs. CEUR Workshop Proceedings, 3098, 19–20. https://arxiv.org/abs/2202.05639.