heartbeats

Heartbeats

A lightweight HTTP service for monitoring periodic “heartbeat” pings (“bumps”) and notifying configured receivers when a heartbeat goes missing or recovers. Includes an in‐browser read-only dashboard showing current heartbeats, receivers, and historical events.

Features

• Heartbeat monitoring with configurable interval & grace periods
• Pluggable notifications via Slack, Email, or MS Teams
• In-memory history of events (received, failed, state changes, notifications, API requests)
• Dashboard with:
  • Heartbeats: status, URL, last bump, receivers, quick-links
  • Receivers: type, destination, last sent, status
  • History: timestamped events, filter by heartbeat
  • Text-search filters & copy-to-clipboard URLs
• /healthz and /metrics endpoints for health checks & Prometheus
• YAML configuration with variable resolution via containeroo/resolver

Flags

Proxy Environment Variables

You can set the following environment variables for proxy configuration:

• HTTP_PROXY: URL of the proxy server to use for HTTP requests.
• HTTPS_PROXY: URL of the proxy server to use for HTTPS requests.

HTTP Endpoints

Endpoints

Configuration

heartbeats and receivers must be defined in your YAML file (default config.yaml).

Examples

---
receivers:
  dev-crew-int:
    slack_configs:
      - channel: integration
        token: env:SLACK_TOKEN
        # not title or text specified, will use the default
      - channel: dev-crew
        token: env:SLACK_TOKEN
        # not title or text specified, will use the default
    email_configs:
      - smtp:
          host: smtp.gmail.com
          port: 587
          from: env:MAIL_FROM
          username: env:MAIL_USERNAME
          password: env:MAIL_PASSWORD
          startTLS: true
          skipInsecureVerify: true
        email:
          isHTML: true
          subjectTemplate: "[HEARTBEATS] {{ .Name }} {{ upper .Status }}"
          password: env:MAIL_PASSWORD
  dev-crew-prod:
    msteams_configs:
      - webhook_url: file:/secrets/teams/webhooks//production
        # no title nor text specified, will use the default
    msteamsgraph_configs:
      - token: env:MSTEAMSGRAPH_TOKEN
        teamID: env:MSTEAMSGRAPH_TEAM_ID
        channelID: env:MSTEAMSGRAPH_CHANNEL_ID
        # no title nor text specified, will use the default

Heartbeats

A heartbeat waits for periodic pings (“bumps”). If no bump arrives within interval + grace, notifications are sent.

Example

heartbeats:
  prometheus-int:
    description: "Prometheus → Alertmanager test"
    interval: 30s
    grace: 10s
    receivers:
      - dev-crew-int

Receivers

Each receiver can have multiple notifier configurations. Supported under receivers::

• slack_configs
• email_configs
• msteams_configs

You may use any template variable from the heartbeat (e.g. {{ .ID }}, {{ .Status }}), and these helper functions:

• upper: {{ upper .ID }}
• lower: {{ lower .ID }}
• formatTime: {{ formatTime .LastBump "2006-01-02 15:04:05" }}
• ago: {{ ago .LastBump }}
• isRecent: {{ isRecent .LastBump }} // isRecent returns true if the last bump was less than 2 seconds ago
• join: {{ join .Tags ", " }}

Variable Resolution

Heartbeats uses containeroo/resolver for variable resolving.

Resolver supports:

• Plain: literal value
• Environment: env:VAR_NAME
• File: file:/path/to/file
• Within-file: file:/path/to/file//KEY, also supported yaml:,json:,ini: and toml:. For more details see containeroo/resolver.

Slack

Defaults:

• SubjectTemplate: [{{ upper .Status }}] {{ .ID }}"
• TextTemplate: {{ .ID }} is {{ .Status }} (last bump: {{ ago .LastBump }})"

receivers:
  dev-crew-int:
    slack_configs:
      - channel: "#integration"
        token: env:SLACK_TOKEN
        # optional custom templates:
        titleTemplate: "[{{ upper .Status }}] {{ .ID }}"
        textTemplate: "{{ .ID }} status: {{ .Status }}"
        # optional: override global skip TLS
        skipTLS: true

Note > Heartbeats adds a custom User-Agent: Heartbeats/<version> header to all outbound HTTP requests. The Content-Type header is also set to application/json.

Email

Defaults:

• SubjectTemplate: "[HEARTBEATS]: {{ .ID }} {{ upper .Status }}"
• BodyTemplate: "<b>Description:</b> {{ .Description }}<br>Last bump: {{ ago .LastBump }}"

email_configs:
  - smtp:
      host: smtp.gmail.com
      port: 587
      from: admin@example.com
      username: env:EMAIL_USER
      password: env:EMAIL_PASS
      # optional
      startTLS: true
      # optional: override global skip TLS
      skipInsecureVerify: true
    email:
      isHTML: true
      to: ["ops@example.com"]
      # optional custom templates:
      subjectTemplate: "[HB] {{ .ID }} {{ upper .Status }}"
      bodyTemplate: "Last bump: {{ ago .LastBump }}"

MS Teams (incomming webhook)

Defaults:

• TitleTemplate: "[{{ upper .Status }}] {{ .ID }}"
• TextTemplate: "{{ .ID }} is {{ .Status }} (last bump: {{ ago .LastBump }})"

msteams_configs:
  - webhook_url: file:/secrets/teams/webhook//prod
    # optional custom templates:
    titleTemplate: "[{{ upper .Status }}] {{ .ID }}"
    textTemplate: "{{ .ID }} status: {{ .Status }}"
    # optional: override global skip TLS
    skipTLS: true

Note > Heartbeats adds a custom User-Agent: Heartbeats/<version> header to all outbound HTTP requests. The Content-Type header is also set to application/json.

MS Teams (Graph API) (NOT TESTED)

Defaults:

• TitleTemplate: "[{{ upper .Status }}] {{ .ID }}"
• TextTemplate: "{{ .ID }} is {{ .Status }} (last bump: {{ ago .LastBump }})"

msteamsgraph_configs:
  - webhook_url: file:/secrets/teams/webhook//graph
    # optional custom templates:
    titleTemplate: "[{{ upper .Status }}] {{ .ID }}"
    textTemplate: "{{ .ID }} status: {{ .Status }}"
    # optional: override global skip TLS
    skipTLS: true

Note > Heartbeats adds a custom User-Agent: Heartbeats/<version> header to all outbound HTTP requests. The Content-Type header is also set to application/json.

Deployment

Download the binary and update the example config.yaml according your needs. If you prefer to run heartbeats in docker, you find a docker-compose.yaml & config.yaml here. For a kubernetes deployment you find the manifests here.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.