Twitch Exporter

Export Twitch metrics to Prometheus.

Collectors

Each collector can be toggled with --[no-]collector.<name> flags.

Flags

./twitch_exporter --help

• twitch.channel: Name of a Twitch channel to request metrics.
• twitch.client-id: Client ID for the Twitch Helix API.
• twitch.client-secret: Client Secret for the Twitch Helix API.
• twitch.access-token: Access Token for the Twitch Helix API.
• twitch.access-token-file: File containing the Access Token (alternative to twitch.access-token).
• twitch.refresh-token: Refresh Token for the Twitch Helix API.
• twitch.refresh-token-file: File containing the Refresh Token (alternative to twitch.refresh-token).
• log.format: Output format of log messages. One of: logfmt, json.
• log.level: Logging level. One of: debug, info, warn, error. Default: info.
• version: Show application version.
• web.listen-address: Addresses on which to expose metrics and web interface. Repeatable for multiple addresses.
• web.telemetry-path: Path under which to expose metrics.
• web.config.file: Path to configuration file that can enable TLS or authentication.
• eventsub.enabled: Enable eventsub endpoint (default: false).
• eventsub.webhook-url: The url your collector will be expected to be hosted at, eg: http://example.svc/eventsub (Must end with /eventsub).
• eventsub.webhook-secret: Secure 1-100 character secret for your eventsub validation.

EventSub

EventSub metrics are disabled by default because they require a publicly accessible endpoint and additional permissions.

If you wish to use eventsub based metrics then you should deploy an instance of the exporter just for the user that needs the eventsub metrics, such as your own channel, and just collect the privileged metrics using that exporter.

Setting up EventSub metrics

You can read more about the process here

1. Install the twitch-cli
2. Ensure your twitch app has localhost:3000 added as a redirect uri
3. twitch token -u -s 'channel:read:subscriptions bits:read moderator:read:chatters moderation:read channel:read:goals channel:read:charity channel:bot user:read:chat user:bot'
4. Start the collector with client-id, client-secret, access-token, and refresh-token defined

./twitch_exporter \
  --twitch.client-id xxx \
  --twitch.client-secret xxx \
  --twitch.access-token xxx \
  --twitch.refresh-token xxx \
  --twitch.channel surdaft \
  --eventsub.enabled \
  --eventsub.webhook-url 'https://xxx/eventsub' \
  --eventsub.webhook-secret xxxx \
  --collector.channel_chat_messages_total \
  --collector.channel_subscribers_total \
  --no-collector.channel_followers_total \
  --no-collector.channel_up \
  --no-collector.channel_viewers_total

Development & Testing

Prerequisites

• Go 1.25+
• A Twitch Developer account
• twitch-cli installed

Create a Twitch Application

1. Go to https://dev.twitch.tv/console/apps
2. Register a new app, set OAuth redirect to http://localhost:3000
3. Note the Client ID and Client Secret

Build

make build

Run with app token (basic collectors)

./twitch_exporter \
  --twitch.client-id <client-id> \
  --twitch.client-secret <client-secret> \
  --twitch.channel <channel>

Configure twitch-cli

Required before generating user tokens:

twitch configure

Enter Client ID and Client Secret when prompted.

Get a user token (for privileged collectors)

twitch token -u -s 'channel:read:subscriptions bits:read moderator:read:chatters moderation:read channel:read:goals channel:read:charity channel:bot user:read:chat user:bot'

Run with user token

./twitch_exporter \
  --twitch.client-id <client-id> \
  --twitch.client-secret <client-secret> \
  --twitch.access-token <access-token> \
  --twitch.refresh-token <refresh-token> \
  --twitch.channel <channel> \
  --collector.channel_subscribers_total

Verify metrics

curl http://localhost:9184/metrics

Run tests

make test

Testing with twitch-cli mock API

Start mock server:

twitch mock-api start

Useful for development without hitting Twitch rate limits.

Using Docker

You can deploy this exporter using the ghcr.io/damoun/twitch-exporter Docker image.

For example:

docker pull ghcr.io/damoun/twitch-exporter

docker run -d -p 9184:9184 \
        ghcr.io/damoun/twitch-exporter \
        --twitch.client-id <client-id> \
        --twitch.client-secret <client-secret> \
        --twitch.channel dam0un

Using Helm

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm has been set up correctly, add the repo as follows:

helm repo add twitch-exporter https://damoun.github.io/twitch-exporter

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages. You can then run helm search repo twitch-exporter to see the charts.

To install the twitch-exporter chart:

helm install my-twitch-exporter twitch-exporter/twitch-exporter

To uninstall the chart:

helm delete my-twitch-exporter