An open API service indexing awesome lists of open source software.

https://github.com/lig/fedistats


https://github.com/lig/fedistats

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# Fedistats

https://gitlab.com/lig/fedistats

## About

`Fedistats` collects metrics of a Mastodon instance using the Public Timeline API.

## How to Use

### Build

```shell
go build -o ./build/ -v ./...
```

Creates `./build/fedistats-collector` binary.

## Configure

Create `./config/fedistats.yaml`.

```yaml
mastodon:
server: "https://fosstodon.org" # Required. The Mastodon instance to connect to.
client_id: "" # Required.
client_secret: "" # Required.
access_token: "" # Required.
metrics:
path: "/metrics" # Optional. Path on which metrics are being served.
port: 2112 # Optional. Port on which metrics are being served.
```

# Run

Launch using:

```shell
./build/fedistats-collector
```

Point your Prometheus instance to `http://your-host.tld:`

## License

[GNU Affero General Public License v3.0](./LICENSE)