go/sliding-sync
go/sliding-sync
1
0
Fork 0
mirror of https://github.com/matrix-org/sliding-sync.git synced 2025-03-10 13:37:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #463 from matrix-org/rav/log_docs

Browse Source 
Add some documentation on the log fields
This commit is contained in:
Richard van der Hoff 2024-09-13 16:32:55 +01:00 committed by GitHub
commit c23af6099b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -99,7 +99,7 @@ docker run --rm -e "SYNCV3_SERVER=https://matrix-client.matrix.org" -e "SYNCV3_S
Download the binary for your architcture (eg. `syncv3_linux_amd64` for 64-bit AMD/Intel) from https://github.com/matrix-org/sliding-sync/releases/latest
```
$ SYNCV3_SECRET=$(cat .secret) SYNCV3_SERVER="https://matrix-client.matrix.org" SYNCV3_DB="user=$(whoami) dbname=syncv3 sslmode=disable password='DATABASE_PASSWORD_HERE'" SYNCV3_BINDADDR=0.0.0.0:8008 ./syncv3_linux_amd64
$ SYNCV3_SECRET=$(cat .secret) SYNCV3_SERVER="https://matrix-client.matrix.org" SYNCV3_DB="user=$(whoami) dbname=syncv3 sslmode=disable password='DATABASE_PASSWORD_HERE'" SYNCV3_BINDADDR=0.0.0.0:8008 ./syncv3_linux_amd64
```
Optionally also set `SYNCV3_TLS_CERT=path/to/cert.pem` and `SYNCV3_TLS_KEY=path/to/key.pem` to listen on HTTPS instead of HTTP.
@ -119,6 +119,8 @@ Wait for the first initial v2 sync to be processed (this can take minutes!) and
Note that some clients might require that your home server advertises support for sliding-sync in the `.well-known/matrix/client` endpoint; details are in [the work-in-progress specification document](https://github.com/matrix-org/matrix-spec-proposals/blob/kegan/sync-v3/proposals/3575-sync.md#unstable-prefix).
There are some notes on the log format in [docs/log_format.md](./docs/log_format.md).
### Prometheus
To enable metrics, pass `SYNCV3_PROM=:2112` to listen on that port and expose a scraping endpoint `GET /metrics`.

20
docs/log_format.md Normal file
View File

@ -0,0 +1,20 @@
# Log line format
Log lines may contain the following fields:
* `u`: user ID.
* `dev`: device ID.
* `p`: `pos` parameter from incoming requests.
* `q`: `pos` value from outgoing responses.
* `t`: transaction ID.
* `c`: connection ID.
* `b`: buffer summary.
* Update counts in outgoing responses, each of which are omitted if zero:
* `r`: rooms.
* `d`: to-device events.
* `ag`: global account data updates.
* `dl-c`: changed devices.
* `dl-l`: left devices.
* `sub`: room subscriptions.
* `usub`: room unsubscriptions.
* `l`: lists.

4
internal/context.go
View File

@ -106,6 +106,10 @@ func DecorateLogger(ctx context.Context, l *zerolog.Event) *zerolog.Event {
return l
}
da := d.(*data)
// NOTE: These log fields are documented in `docs/log_format.md`: remember to
// keep that document up-to-date.
if da.userID != "" {
l = l.Str("u", da.userID)
}