Skip to content

Commit 8d7d27c

Browse files
author
jmanuelcorral
committed
Added Documentation
1 parent 56c6597 commit 8d7d27c

6 files changed

Lines changed: 28 additions & 1 deletion

File tree

elk/Readme.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
This article contains a brief introduction to centralized structured logging with [Serilog](https://serilog.net/) and event viewing with [ELK](https://www.elastic.co/elk-stack) in eShopOnContainers. ELK is an acronym of ElasticSearch, LogStash and Kibana. This is one of the most used tools in the industry standards.
2+
3+
![](img/elk/kibana-working.png)
4+
5+
## Wiring eshopOnContainers with ELK
6+
7+
eshopOnContainers is ready for work with ELK, you only need to setup the configuration parameter **LogstashgUrl**, in **Serilog** Section, for achieve this, you can do it modifing this parameter in every appsettings.json in every service, or via Environment Variable **Serilog:LogstashUrl**.
8+
9+
There is another option, a zero-configuration environment for testing the integration launching via ```docker-compose``` command, on the root directory of eshopOnContainers:
10+
11+
```sh
12+
docker-compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.elk.yml
13+
```
14+
15+
### Configuring Logstash index on Kibana
16+
17+
Once time you have started and configured your application, you only need to configure the logstash index on kibana.
18+
You can address to Kibana, with docker-compose setup is at [http://localhost:5601](http://localhost:5601)
19+
20+
If you have accessed to kibana too early, you can see this error. It's normal, depending of your machine the kibana stack needs a bit of time to startup.
21+
![](img/elk/kibana_startup.png)
22+
23+
You can wait a bit and refresh the page, the first time you enter, you need to configure and index pattern, in the ```docker-compose``` configuration, the index pattern name is **eshops-\***.
24+
![](img/elk/kibana_eshops_index.png)
25+
26+
With the index pattern configured, you can enter in the discover section and start viewing how the tool is recollecting the logging information.
27+
28+
![](img/elk/kibana_result.png)

img/elk/kibana_eshops_index.png

36.7 KB
Loading

img/elk/kibana_result.png

71.4 KB
Loading

img/elk/kibana_startup.png

57.3 KB
Loading

img/elk/kibana_working.png

77.6 KB
Loading

k8s/helm/elk/installelk.ps1

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)