Note Widget

Using the Note widget, you can add descriptions, instructions, links, and images to your dashboards. Notes are written in markdown syntax which allows you to style the text and insert HTML snippets and create links to other dashboards and external systems.

Note Widget

Figure 116. Note Widget


Example Markdown Note

ini files
## Instructions
This dashboard contains the current status of our systems. These links will take you to relevant external systems:

- [Grafana Dashboard using this dashboard's time range](https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from={{startTime}}&to={{endTime}})
- [Host Details Humio Dashboard](/my-repo/dashboards/19213?host={{ parameter "host" }})

Here is a kitten:
![So cute](http://www.lolcats.com/images/u/12/43/lolcatsdotcomnapkin.jpg)

Templates

As you might have noticed in the example above, you can inject values into your notes using embedded template expressions. A template expression is wrapped in {{ ... }} (double curly braces).

This is especially useful when used to create links to external systems, where you can pass information from the dashboard as part of the URL.

An expression is either a variable name or a function call. Here are the variables and functions available in template expressions.

Variables

{{ startTime }}

The start of the current global dashboard time interval — as selected in the Time Selector field. It does not matter if you have activated global time or not, this will always be available.

It is formatted as a milliseconds instant, 1561584065821.

This is very useful when you want to use the dashboard's current time interval to look at details in another system or dashboard.

{{ endTime }}

The end of the current global dashboard time interval — as selected in the Time Selector. It does not matter if you have activated global time or not, this will always be available.

It is formatted as a milliseconds instant, for example 1561584095932.

This is very useful when you want to use the dashboard's current time interval to look at details in another system or dashboard.

Template Functions

parameter

Usage: {{ parameter "<PARAM_ID>" }}

Example: {{ parameter "hostname" }}

Inserts the current value of a dashboard parameter.

External Images

Humio's default content security policy (CSP) prevents loading images from external servers. Displaying images from other domains is possible by setting the environment variable named STATIC_IMAGE_CONTENT_URL. For example, to allow images from the www.lolcats.com domain, start Humio with this environment variable set:

humio
STATIC_IMAGE_CONTENT_URL=https://www.lolcats.com

See STATIC_IMAGE_CONTENT_URL for more information.

Widget Properties

Use the widget's Edit Style panel to configure the following properties.

  • Title

    The title of the note as displayed in the dashboard.

  • Description

    The description of the note. This is free form text supporting markdown syntax.

    The description appears in the dashboard as a tooltip when hovering over the question mark on top of the note.

  • Colors

    • Text allows to change the default font color of the note.

    • Background sets a color for the note's background.