Reference

heatmap

Fields and display options of a heatmap panel.

Example

{
  "id": "p_latency_heat",
  "type": "heatmap",
  "title": "Request latency over time",
  "gridPos": {
    "x": 0,
    "y": 55,
    "w": 12,
    "h": 8
  },
  "datasource": "prom",
  "queries": [
    {
      "query": "http_request_duration_seconds{service=\"checkout\"}"
    }
  ],
  "display": {
    "calculate": true,
    "xBuckets": {
      "mode": "count",
      "value": 12
    },
    "xBucketScale": "log",
    "xBucketLogBase": 10
  }
}

From spec/examples/evolved-features.json.

Fields

Field	Type	Description
`id` (required)	`string`	Stable across versions; comments anchor to it.
`title` (required)	`string`
`description`	`string`
`gridPos` (required)	`gridPos`	Position on the 24-column grid; x + w must not exceed 24.
`type` (required)	`"timeseries"`, `"stat"`, `"gauge"`, `"bargauge"`, `"table"`, `"piechart"`, `"heatmap"`, `"histogram"`, `"state-timeline"`, `"logs"`, `"barchart"`, `"status-history"`, `"trend"`, `"xychart"`, `"candlestick"`, `"nodeGraph"`, `"traces"`, `"flamegraph"`, `"geomap"`, `"canvas"`, `"alertlist"`
`datasource`	`datasourceRef`	A configured datasource uid, or ${name} naming a datasource variable declared in variables (before this variable, when used by one); queries then run on the datasource selected in that variable, and macros follow its datasourceType.
`queries` (required)	array of `panelQuery` or `expressionQuery` or `dashboardQuery`	At most 26 items.
`overrides`	array of `override`	At most 50 items.
`transform`	array of `transform`	At most 20 items.
`repeat`	`variableName`	Referenced in queries as $name, ${name} or ${name:format}.
`repeatDirection`	`"h"`, `"v"`
`maxPerRow`	`integer`	Between 1 and 24.
`timeFrom`	`string`
`timeShift`	`string`
`timezone`	`string`	browser, utc or an IANA zone such as Asia/Kolkata. The times this panel draws are shown in this zone instead of the dashboard’s.
`hideTimeOverride`	`boolean`	Do not show the time override note (from timeFrom and timeShift) in the panel header. The override still applies to the queries. Absent means shown.
`interval`	`intervalRef`	A minimum step such as 30s, or ${name} naming an interval variable; queries then use the step selected in that variable.
`maxDataPoints`	`integer`	Between 10 and 11000.
`transparent`	`boolean`
`titleHidden`	`boolean`	Keep the title as the panel’s name for menus and screen readers but do not show it. Absent means shown.

Every data panel also takes the field options.

Display options

Field	Values	Description
`calculate`	`true`, `false`
`yScale`	`"linear"`, `"log"`, `"symlog"`
`colorMode`	`"scheme"`, `"opacity"`	scheme colors the cells with colorScheme; opacity varies the opacity of colorFill. Absent means opacity.
`colorScheme`	`"greenYellowRed"`, `"redYellowGreen"`, `"blueYellowRed"`, `"yellowRed"`, `"bluePurple"`, `"yellowBlue"`, `"blues"`, `"reds"`, `"greens"`, `"purples"`, `"oranges"`, `"viridis"`, `"magma"`, `"plasma"`, `"inferno"`, `"cividis"`, `"warm"`
`colorSteps`	`integer`	Number of distinct colors in scheme mode; absent means a continuous ramp. Between 2 and 128.
`colorScale`	`"linear"`, `"exponential"`
`colorExponent`	`number`	Exponent of an exponential colorScale; 0.5 when absent. Between 0.1 and 2.
`colorFill`	`color`	The color whose opacity varies in opacity mode; absent means the first series color.
`colorMin`	`number`
`colorMax`	`number`
`colorReverse`	`true`, `false`
`cellGap`	`integer`	Pixels between cells. Between 0 and 25.
`cellRadius`	`integer`	Cell corner radius in pixels. Between 0 and 10.
`cellUnit`	`unit`	A Grafana unit id, or a custom suffix:, prefix:, time:, si:, count: or currency: unit.
`cellDecimals`	`integer`	Between 0 and 10.
`legend`	`"bottom"`, `"hidden"`	Whether the color scale is shown under the chart; bottom when absent.
`hideBelow`	`number`	Cells with a value at or below this are not drawn; 0 when absent.
`hideAbove`	`number`	Cells with a value at or above this are not drawn.
`showValues`	`"auto"`, `"always"`, `"never"`	Whether cells carry their value as text: auto only where it fits, always, or never (the default).
`xBuckets`	`object`	How calculate groups time into columns: size is seconds per column and count is the number of columns; without a value the size is the data step and the count is one column per sample time. Absent keeps one column per sample time.
`yBuckets`	`object`	How calculate groups values into rows: size is the value range of a row (the exponent step on a log scale) and count is the number of rows; without a value the size is a round step that gives about 16 rows and the count is 16. Absent means 16 rows.
`yBucketScale`	`"linear"`, `"log"`, `"symlog"`	Spacing of calculated rows; absent follows yScale.
`yBucketLogBase`	`2`, `10`	Base of a logarithmic yBucketScale; 2 when absent.
`xBucketScale`	`"linear"`, `"log"`, `"symlog"`	Spacing of calculated columns; log and symlog space them by the logarithm of the time, with 16 columns when xBuckets has no count, and a size is then a step in scaled units, not seconds. Absent is linear.
`xBucketLogBase`	`2`, `10`	Base of a logarithmic xBucketScale; 2 when absent.
`rowsLayout`	`"auto"`, `"le"`, `"ge"`, `"unknown"`	How pre-bucketed series are read: le takes each bound as the upper edge of its row, ge as the lower edge, unknown draws one ordinary row per series, and auto uses le for series with an le label.
`rowsValue`	`fieldName`	The field holding the cell value when the data is already bucketed in rows; a frame without a field of this name keeps all its number fields.
`yUnit`	`unit`	Unit of the row labels; absent uses the field’s unit.
`yDecimals`	`integer`	Between 0 and 10.
`yMin`	`number`	Rows that end at or below this value are not drawn.
`yMax`	`number`	Rows that start at or above this value are not drawn.
`yReverse`	`true`, `false`	Draws the lowest row at the top.
`yAxis`	`"left"`, `"right"`, `"hidden"`	Side of the row labels; left when absent.
`yAxisWidth`	`integer`	Width of the row labels in pixels; absent fits the longest label. Between 0 and 400.
`yAxisLabel`	`string`
`tooltip`	`"single"`, `"all"`, `"hidden"`	single shows the hovered cell, all lists every row of its column, hidden shows no tooltip; single when absent.
`tooltipHistogram`	`true`, `false`	Adds a small histogram of the hovered column’s rows to the tooltip.
`tooltipColorScale`	`true`, `false`	Adds the color scale to the tooltip with a marker at the hovered value.
`tooltipMaxWidth`	`integer`	Between 100 and 2000.
`tooltipMaxHeight`	`integer`	Between 100 and 2000.
`exemplars`	`true`, `false`	Whether the exemplars of queries that ask for them are drawn; true when absent.
`exemplarColor`	`color`	The color of exemplar diamonds; absent means the foreground color.

Generated from spec/schema/observespec.v0.json at bac0fe39. Report a problem.