prometheus / prometheus/alertmanager

Offer solution to test receivers

Open
#2,845 8 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component/notify help wanted kind/enhancement stale
Dominant language
Go
Stars
8.6k
Forks
2.5k
Avg merge
2d 6h
Merged PRs (30d)
61

Description

When creating a receiver, it is essentially up to trial-and-error to determine whether it is working properly. There is no way to validate the provided configuration - rather, the user must simply wait for an affected alert to fire and see whether the notification was delivered.

This makes it extremely difficult for a user to determine if their receiver is working as expected, especially when using complex templates or integrating with external systems. An API to validate a receiver and to send test notifications could be a solution to this issue.

FYI this has been added to Grafana with https://github.com/grafana/grafana/pull/37308 (related blog post), we are happy to upstream similar changes if they provide value to everyone.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing the linked Grafana pull request and blog post, then inspect Alertmanager's existing receiver configuration and API design; done should include a defined way to validate receiver configurations and send test notifications before an alert fires.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.