Self-host Self-Hosted Metrics (SHM)

Self-Hosted Metrics (SHM) README

How to install Self-Hosted Metrics (SHM)

SHM_DB_DSN, PORT, GITHUB_TOKEN, SHM_RATELIMIT_*

name: shm

services:
  db:
    image: postgres:15-alpine
    container_name: shm-db
    restart: unless-stopped
    environment:
      POSTGRES_USER: shm
      POSTGRES_PASSWORD: ${DB_PASSWORD:-change-me-in-production}
      POSTGRES_DB: metrics
    volumes:
      - postgres_data:/var/lib/postgresql/data
      - ./migrations:/docker-entrypoint-initdb.d
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U shm -d metrics"]
      interval: 10s
      timeout: 5s
      retries: 5

  app:
    image: ghcr.io/kolapsis/shm:latest
    container_name: shm-app
    restart: unless-stopped
    depends_on:
      db:
        condition: service_healthy
    environment:
      SHM_DB_DSN: "postgres://shm:${DB_PASSWORD:-change-me-in-production}@db:5432/metrics?sslmode=disable"
      PORT: "8080"
    ports:
      - "8080:8080"

volumes:
  postgres_data:

mkdir -p migrations
curl -sL https://raw.githubusercontent.com/kolapsis/shm/main/migrations/001_init.sql -o migrations/001_init.sql
curl -sL https://raw.githubusercontent.com/kolapsis/shm/main/migrations/002_applications.sql -o migrations/002_applications.sql

docker compose up -d

How to configure Self-Hosted Metrics (SHM)

• DO_NOT_TRACKSet to true or 1 to completely disable telemetry

  Set to true or 1 to completely disable telemetry

  values: true, 1

• GITHUB_TOKENGitHub Personal Access Token for higher API rate limits

  GitHub Personal Access Token for higher API rate limits

• PORT=8080HTTP server port

  HTTP server port

• SHM_COLLECT_SYSTEM_METRICS=trueSet to false or 0 to disable automatic system metrics collection

  Set to false or 0 to disable automatic system metrics collection

  values: true, false

• SHM_DB_DSNPostgreSQL connection string

  PostgreSQL connection string

• SHM_RATELIMIT_ADMIN_BURST=10Burst allowance for admin endpoints

  Burst allowance for admin endpoints

• SHM_RATELIMIT_ADMIN_PERIOD=1mTime window for admin endpoints

  Time window for admin endpoints

• SHM_RATELIMIT_ADMIN_REQUESTS=30Max requests per period for /api/v1/admin/*

  Max requests per period for /api/v1/admin/*

• SHM_RATELIMIT_BRUTEFORCE_BAN=15mDuration of IP ban after brute-force detection

  Duration of IP ban after brute-force detection

• SHM_RATELIMIT_BRUTEFORCE_THRESHOLD=5Failed auth attempts before IP ban

  Failed auth attempts before IP ban

• SHM_RATELIMIT_CLEANUP_INTERVAL=10mInterval for cleaning up expired limiters

  Interval for cleaning up expired limiters

• SHM_RATELIMIT_ENABLED=trueEnable/disable rate limiting

  Enable/disable rate limiting

• SHM_RATELIMIT_REGISTER_BURST=2Burst allowance for register endpoints

  Burst allowance for register endpoints

• SHM_RATELIMIT_REGISTER_PERIOD=1mTime window for register endpoints

  Time window for register endpoints

• SHM_RATELIMIT_REGISTER_REQUESTS=5Max requests per period for /v1/register and /v1/activate

  Max requests per period for /v1/register and /v1/activate

• SHM_RATELIMIT_SNAPSHOT_BURST=2Burst allowance for snapshot endpoint

  Burst allowance for snapshot endpoint

• SHM_RATELIMIT_SNAPSHOT_PERIOD=1mTime window for snapshot endpoint

  Time window for snapshot endpoint

• SHM_RATELIMIT_SNAPSHOT_REQUESTS=1Max requests per period for /v1/snapshot (per instance)

  Max requests per period for /v1/snapshot (per instance)