diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f27228 --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file