No description
Find a file
2023-04-06 16:30:04 +02:00
.cargo Use mold for linking 2023-04-06 16:29:46 +02:00
src Add Opentelemetry tracing 2023-04-06 13:51:16 +02:00
.gitignore Initial Commit 2023-04-05 02:32:25 +02:00
.woodpecker.yml Use mold for linking 2023-04-06 16:29:46 +02:00
Cargo.lock Add Opentelemetry tracing 2023-04-06 13:51:16 +02:00
Cargo.toml Add Opentelemetry tracing 2023-04-06 13:51:16 +02:00
Dockerfile Document environment variables in the dockerfile 2023-04-06 16:30:04 +02:00
readme.md Update readme 2023-04-06 14:12:04 +02:00

status-badge

OSRS Prometheus Exporter

Collects data about oldschool runescape from various source

Features

  • Track highscores rank per player
  • Track xp gain per skill per player
  • Track levels per skill per player
  • Track how many player are logged in per world

Endpoints

uri description
/stats/:rsn Player metrics endpoint
/worlds World metrics endpoint

Prometheus metrics

# Player metrics
osrs_player_level{skill="Hunter",player="rsn",profile="Standard"} 1
osrs_player_xp{skill="Hunter",player="rsn",profile="Standard"} 0
osrs_player_rank{skill="Hunter",player="rsn",profile="Standard"} 0
# World metrics
osrs_world_players{id="302",isMembers="true",location="UK"}

Prometheus Configuration

scrape_configs:
  - job_name: osrs-world-data
    scrape_interval: 5m
    metrics_path: /worlds
    static_configs:
      - targets:
          - osrs-prometheus-exporter:3030

  - job_name: osrs-player-runebaas
    scrape_interval: 1h
    metrics_path: /stats/runebaas
    static_configs:
      - targets:
          - osrs-prometheus-exporter:3030

Open Telemetry

This app includes support for Open Telemetry

It supports the following configuration options:

Name Default Description
OTEL_SERVICE_NAME app Name of the app
OTEL_EXPORTER_OTLP_ENDPOINT http://localhost:4317 Collection endpoint
OTEL_EXPORTER_OTLP_PROTOCOL grpc Collection protocol