Skip to main content

Enhancement: Check Descriptions

Spoke to support, very helpful. Suggested I create an enhancement for review:

Our use case: allow the team to quickly understand the motivation behind created checks without going into each one. Internal only (not public).

An example implementation that would work for us:

  1. An additional optional field in the check setup that allows input of freeform text description

  2. When a description is present, show a small informational icon/symbol e.g.

    image
    on the check in the home screen (similar to how tags show up)

  3. When mouse hovering the info icon on the home screen check, the description snippet is displayed as a hovering tooltip so the user can quickly scan checks and pull up more detail if required

    original GH issue link https://github.com/checkly/public-roadmap/issues/241

Status: Completed6 comments

Log in to comment and vote

Comments6

  • Susanne Tünker

    •

    Apr 9

    @Wilfred van der Deijl See my announcement below - I’ve logged your request about optionally showing the description on dashboard as a follow up task 👍

  • Susanne Tünker

    •

    Apr 9

    Update: Check descriptions are now available in the UI and CLI. Terraform and Pulumi support will follow shortly.

    Descriptions are currently shown on the check overview page and included in most alert channels.

    Feedback is welcome 👍

  • tpalhota@aifs.co.uk

    •

    Nov 4, 2025

    This would also be great for us. It would give the team a clear understanding of what the service being monitored does and how it could affect our customers.

    Thank you!

  • Wilfred van der Deijl

    •

    Jan 11, 2024

    This enhancement request is about having an internal only (private) description, which sounds like a great plan.

    We would like to advocate for a description that is shown on the dashboard to better explain to our customers what a check is. Having two separate descriptions might be a bit much, but perhaps it could be flag on the dashboard if descriptions should be shown (similar to the current flag to show/hide the tags)

    • Tim Nolet

      •

      Jan 11, 2024

      that makes sense, thanks for adding the context

  • Tim Nolet

    •

    Jan 11, 2024

    @Wilfred van der Deijl I'm merging this one with an existing request.