Matthew Helmke

Technical writer · musician · reader

Get notified when a metric crosses a threshold

Format: Markdown for an interactive lab platform · Client: Grafana · Year: 2022

A hands-on lab that walks a learner through building a Grafana managed alert, from contact point to notification policy. The source uses a lab platform’s own markup (variables, page breaks, checkboxes), so it links to the file rather than a live page. What it shows is the task-based instructional voice: each step names exactly what to click, then a short aside explains why it matters and what a real-world choice would be.

View the original source (Markdown)


Excerpt — setting up a contact point:

  1. Open the dropdown for Contact point type. There are many options available. For simplicity, choose Email.

  2. Enter your email address under Addresses. It can be any email address and what you set here will not be saved or used for any purpose other than this lab. The lab instance is deleted when you exit.

    Typically, you would want to use a group or team email alias here instead of one for an individual, but that is not necessary for this lab.

  3. (optional) Click Test to send a test email to yourself.

  4. Click Save contact point.

When you set up other contact points you will need to know details like webhook URLs, tokens, integration keys, and so on. Various optional settings are available. These differ depending on the contact point type selected.

It is in this tab where you can create Message templates, which use the Go templating system to enable you to automate messages where variables in your template are replaced with actual values in the sent notifications. There is a link to the Google page with syntax and usage details provided for you when you click + New template, for when you are ready to do this in a real-world setting.


Excerpt from “Get notified when a metric crosses a threshold using a Grafana managed alert.” Back to all writing samples.