Skip to content

Commit 7e84e3f

Browse files
committed
Services monitoring documentation
1 parent d39b914 commit 7e84e3f

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

docs/05-monitor-services.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Monitoring Sentinel-Kit Services
2+
3+
Sentinel Kit includes a set of monitoring services that are enabled when the `internal-monitoring` profile is added to your `COMPOSE_PROFILES` in the `.env` file. These services rely on Prometheus, which is queried by Grafana.
4+
5+
By default, Grafana is accessible at:
6+
**[https://grafana.sentinel-kit.local](https://grafana.sentinel-kit.local)**
7+
8+
### Access Credentials
9+
10+
The access credentials for Grafana can be customized in the `.env` file:
11+
```bash
12+
GF_SECURITY_ADMIN_USER=sentinel-kit_grafana_admin
13+
GF_SECURITY_ADMIN_PASSWORD=sentinel-kit_grafana_password
14+
```
15+
### Initial Setup
16+
17+
In its default configuration, Sentinel-Kit does not include any custom dashboards. However, the services for `fluentbit`, `mysql`, and `elasticsearch` are already configured within the platform. You can access all available metrics under the `metrics` section, and it is also possible to filter by service (jobs).
18+
19+
![Sentinel-Kit Grafana](img/sentinel-kit_grafana.png)
20+
21+
### Importing Additional Dashboards
22+
23+
You can import many additional dashboards from the official [Grafana website](https://grafana.com/grafana/dashboards/).
24+
25+
### Performance Consideration
26+
27+
**Warning**: On systems with limited memory or CPU resources, it is recommended to avoid enabling the `internal-monitoring` profile to ensure optimal performance.

docs/img/sentinel-kit_grafana.png

198 KB
Loading

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ Sentinel Kit server launches as a `docker-compose` stack and exposes the followi
1414
* [Sentinel-Kit quickstart](01-start-sentinel-kit.md)
1515
* [Custommize your stack, credential, elastic cluster...](02-customize-stack.md)
1616
* [Create a first admin account](03-create-admin-user.md)
17-
* [Ingest logs](04-ingest-logs.md)
17+
* [Ingest logs](04-ingest-logs.md)
18+
* [Monitore services](05-monitor-services.md)

0 commit comments

Comments
 (0)