codemicro/analytics
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
akp 2023-04-05 17:44:03 +01:00
parent f3c3dd1e7d
commit bc976f5846
No known key found for this signature in database
GPG key ID: AA5726202C8879B7
1 changed files with 27 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,6 +1,32 @@
# codemicro/analytics
A simple self-hosted analytics system that ingests logs from the Caddy HTTP server.
A basic self-hosted analytics system that ingests logs from the Caddy HTTP server.
## Architecture
* Ingest server
* A Go app listening on a TCP socket to ingest JSON logs from the Caddy web server
* Groups requests into sessions and persists them to a database
* Datasette
* Provides a frontend, data explorer and visualisation tool
## Docker
`Dockerfile` can be used for deployment. The directory containing the database and configuration file (which must be called `analytics.db` and `config.yml` respectively) should be mounted at `/analytics/run` within the container.
The ingest server listens on `0.0.0.0:7500` and Datasette listens on `0.0.0.0:8001`.
The following environment variables should be set:
* `BASE_URL`: the URL at which the Datasette instance can be accessed at.
## Caddy configuration
```
log {
output net whateveraddr:7500
format json
}
```
---