https://github.com/fantasticfiasco/serilog-logspout-elastic-stack
Sample application of Serilog sending log events to Elastic Stack using Logspout.
https://github.com/fantasticfiasco/serilog-logspout-elastic-stack
elasticsearch kibana logspout logstash serilog
Last synced: 2 months ago
JSON representation
Sample application of Serilog sending log events to Elastic Stack using Logspout.
- Host: GitHub
- URL: https://github.com/fantasticfiasco/serilog-logspout-elastic-stack
- Owner: FantasticFiasco
- License: apache-2.0
- Created: 2019-06-18T05:31:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T03:20:08.000Z (5 months ago)
- Last Synced: 2025-02-13T15:18:27.298Z (4 months ago)
- Topics: elasticsearch, kibana, logspout, logstash, serilog
- Language: C#
- Homepage:
- Size: 89.8 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serilog, Logspout and the Elastic Stack
## Table of contents
- [Introduction](#introduction)
- [What you will end up with](#what-you-will-end-up-with)
- [Requirements](#requirements)
- [Usage on Windows](#usage-on-windows)
- [Usage on Linux](#usage-on-linux)
- [Credit](#credit)
---
## Introduction
[Elastic Stack](https://www.elastic.co/products) is fantastic at collecting and visualizing log events. [Serilog](https://serilog.net/) is fantastic at producing structured log events. This repository provides a sandbox where developers can explore the life of a log event starting with its birth in Serilog, its transport over the network to Logstash using [Logspout](https://github.com/gliderlabs/logspout), its fields being indexed by Elasticsearch and finally its legacy being recorded as a historical event in Kibana.
## What you will end up with
With a running Elastic Stack and Serilog producing log events you are now ready to take it to the next level. If you fancy the producing part you'll dig deeper into Serilog and its configuration of log contexts, enrichers and message formatters. If you enjoy monitoring applications in production you'll explore Kibana with its visualizations and dashboards.
## Requirements
- [Docker](https://www.docker.com/community-edition#/download)
## Usage on Windows
### Bringing up Elastic Stack
Start the stack using `docker`:
```powershell
cd .\elastic-stack\
docker compose up
```
If this is the first time the stack is started, you'll have to create a Logstash index pattern. Give the stack some time to initialize and then run the following commands in PowerShell:
```powershell
$Headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"; `
$Headers.Add("Content-Type", "application/json"); `
$Headers.Add("kbn-version", "6.8.0"); `
Invoke-RestMethod "http://localhost:5601/api/saved_objects/index-pattern" `
-Method Post `
-Headers $Headers `
-Body '{"attributes":{"title":"logstash-*","timeFieldName":"@timestamp"}}'
```
### Publishing log events using Serilog
Run the following commands to publish log events to Logstash using Serilog:
```powershell
cd .\serilog\
docker compose up
```
### Using Kibana to render the log events
Access the Kibana web UI by hitting [http://localhost:5601](http://localhost:5601) with a web browser.
## Usage on Linux
### Bringing up Elastic Stack
Start the stack using `docker`:
```bash
cd elastic-stack/
docker compose up
```
If this is the first time the stack is started, you'll have to create a Logstash index pattern. Give the stack some time to initialize and then run the following commands:
```bash
curl -XPOST -D- 'http://localhost:5601/api/saved_objects/index-pattern' \
-H 'Content-Type: application/json' \
-H 'kbn-version: 6.8.0' \
-d '{"attributes":{"title":"logstash-*","timeFieldName":"@timestamp"}}'
```
### Publishing log events using Serilog
Run the following commands to publish log events to Logstash using Serilog:
```bash
cd serilog/
docker compose up
```
### Using Kibana to render the log events
Access the Kibana web UI by hitting [http://localhost:5601](http://localhost:5601) with a web browser.
## Credit
The `elastic-stack` directory is a clone of [docker-elk](https://github.com/deviantony/docker-elk) with minor modifications. Credit to [deviantony](https://github.com/deviantony) for publishing the Elastic Stack boilerplate.