add readme

This commit is contained in:
Pavel 2023-10-24 15:57:48 +03:00
parent c71313d367
commit 261e79af54

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# Grafana Clickhouse Docker Log Aggregation
This demo project can aggregate logs from Docker containers and store them in Clickhouse. In the `dashboards` directory you can find dashboard examples for specific log format. `Logs + Structured via Query` is recommended.
**Note**: dashboards are tuned for structured logging (JSON log records).
## How to start
Obviously, you'll need Docker:
1. `make migrate` (you can totally use `clickhouse-client` inside container if migrator hangs up).
2. Navigate to `http://localhost:3000`, use `admin:admin` as credentials.
3. Create your own dashboard or import those I provided (`dashboards/` directory).
4. Run any Docker project with structured JSON logs.
5. Done.