https://github.com/lig/fedistats

https://github.com/lig/fedistats

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lig/fedistats
• Owner: lig
• License: agpl-3.0
• Created: 2021-11-22T20:27:27.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-05T00:50:18.000Z (about 2 years ago)
• Last Synced: 2024-04-16T04:00:41.841Z (6 months ago)
• Language: Go
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

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)