prometheus / prometheus/alertmanager

Implement Base64 Decoding in Alert Description Templates

Open
#2,385 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

What did you do?

I want to be able to enrich the content of alert notifications by embedding links to documentation or other assets related to the alert.
Some of our alerts are relevant across different resources and so I'd like to use labels of the resource to hydrate the URLs provided by the kube_state_metrics.
However Kubernetes labels do not support all the chars required to do this so some encoding method such as Base64 is required.
This is all manageable up to decoding the string when the alert fires.

What did you expect to see?

Some form of decoding function for use in the Alert templates

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

The issue names no files, tests, or entry points. Start by locating Alert description template handling and its existing template functions, then determine the expected Base64 input and output behavior; done means the decoding function is available in templates and covered by relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.