prometheus / prometheus/alertmanager

[Feature Request] Add `visibleTo` field to OpsGenie integration

Open
#3,953 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

What did you do?
I checked the documentation and code and didn't find any option to map the field visibleTo for the OpsGenie integration. The field visibleTo would be very useful to give a team access to see the alert, but not trigger the normal responder workflow.

What do you want to solve?
Usecase: Several teams of developers have ownership of several applications each. All these applications have global alerts that the developers want to receive, so they are the responders. The infrastructure team want insight, but doesn't need to respond to the developers alerts and this is where visibleTo comes in.

Suggestion
I suggest a new field called visible_to (following the naming scheme that's already in place) that's mapped to OpsGenie's Alert API with the field name visibleTo. Here's the relevant OpsGenie documentation. I've added the relevant row from the table in the documentation below for convenience.

Field Mandatory Description Limit
visibleTo false Teams and users that the alert will become visible to without sending any notification. type field is mandatory for each item, where possible values are team and user. In addition to the type field, either id or name should be given for teams and either id or username should be given for users. Please note: that alert will be visible to the teams that are specified within responders field by default, so there is no need to re-specify them within visibleTo field. You can refer below for example values. 50 teams or users in total

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

Start with config/notifiers.go at the linked OpsGenie configuration section, then compare the existing responder mapping with the OpsGenie Alert API documentation. Add the proposed visible_to configuration and map it to visibleTo, with coverage for team and user entries; done means the field is documented and sent correctly in created alerts.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.