mirror
/
gotosocial
mirror of https://github.com/superseriousbusiness/gotosocial
1
0
Fork 0
Code Issues
gotosocial/docs/advanced/metrics.md

1.1 KiB
Raw Permalink Blame History

Metrics

GoToSocial comes with OpenTelemetry based metrics built-in with pull-style Prometheus exporter. Currently the following metrics are collected:

  • Go performance and runtime metrics
  • Gin (HTTP) metrics
  • Bun (database) metrics

How to configure metrics is explained in the Observability configuration reference.

For a quickstart, add the following to your GoToSocial configuration and restart your instance:

metrics-enabled: true
metrics-auth-enabled: true
metrics-auth-username: some_username
metrics-auth-password: some_password

This will expose the metrics under the endpoint /metrics, protected with HTTP Basic Authentication.

A following is an example how to configure a job for collecting the metrics in Prometheus scrape_configs:

  - job_name: gotosocial
    metrics_path: /metrics
    scheme: https
    basic_auth:
        username: some_username
        password: some_password
    static_configs:
    - targets:
      - example.org