Skip to content

Panel plugins#

This documentation provides an exhaustive list of the panel plugins supported by Perses.

BarChart#

kind: "BarChart"
spec:
  calculation: <Calculation specification>
  format: <Format specification> # Optional
  sort: <enum = "asc" | "desc"> # Optional
  mode: <enum = "value" | "percentage"> # Optional

GaugeChart#

kind: "GaugeChart"
spec:
  calculation: <Calculation specification>
  format: <Format specification> # Optional
  thresholds: <Thresholds specification> # Optional
  max: <int> # Optional

Markdown#

kind: "Markdown"
spec:
  text: <string>

PieChart#

kind: "PieChart"
# TODO document the spec of PieChart

StatChart#

kind: "StatChart"
spec:
  calculation: <Calculation specification>
  format: <Format specification> # Optional
  thresholds: <Thresholds specification> # Optional
  sparkline: <Sparkline specification> # Optional
  valueFontSize: <int> # Optional

Sparkline specification#

color: <string> # Optional
width: <int> # Optional

ScatterChart#

kind: "ScatterChart"
spec: # TODO document the spec of ScatterChart

Table#

kind: "Table"
spec:
  density: <enum = "compact" | "standard" | "comfortable"> # Optional
  columnSettings: <Column Settings specification> # Optional

Column Settings specification#

name:  <string>
header:  <string> # Optional
headerDescription:  <string> # Optional
cellDescription: <string> # Optional
align: <enum = "left" | "center" | "right"> # Optional
enableSorting: <boolean> # Optional
width: <number | "auto"> # Optional
hide: <boolean> # Optional

TimeSeriesChart#

kind: "TimeSeriesChart"
spec:
  legend: <Legend specification> # Optional
  tooltip: <Tooltip specification> # Optional
  yAxis: <YAxis specification> # Optional
  thresholds: <Thresholds specification> # Optional
  visual: <Visual specification> # Optional
  querySettings:
  - <Query Settings specification> # Optional

Legend specification#

position: <enum = "bottom" | "right">
mode: <enum = "list" | "table"> # Optional
size: <enum = "small" | "medium"> # Optional
values:
  - <calculation> # Optional

Tooltip specification#

enablePinning: <boolean | default = false> # Optional

YAxis specification#

show: <boolean> # Optional
label: <string> # Optional
format: <format_spec> # Optional
min: <int> # Optional
max: <int> # Optional

Visual specification#

display: <enum = "line" | "bar"> # Optional
# Must be between 0.25 and 3
lineWidth: <int> # Optional
# Must be between 0 and 1
areaOpacity: <int> # Optional
showPoints: <enum = "auto" | "always"> # Optional
palette: <Palette specification> # Optional
# Must be between 0 and 6
pointRadius: <number> # Optional
stack: <enum = "all" | "percent"> # Optional
connectNulls: boolean | default = false # Optional

Palette specification#

mode: <enum = "auto" | "categorical">

Query Settings specification#

# queryIndex is an unsigned integer that should match an existing index in the panel's `queries` array
queryIndex: <number>
# colorMode represents the coloring strategy to use
# - "fixed":        for any serie returned by the query, apply the colorValue defined
# - "fixed-single": if only one serie returned by the query, apply the colorValue defined, otherwise do nothing
colorMode: <enum = "fixed" | "fixed-single">
# colorValue is an hexadecimal color code
colorValue: <string>

TimeSeriesTable#

kind: "TimeSeriesTable"
# TODO document the spec of TimeSeriesTable

TraceTable#

kind: "TraceTable"
# TODO document the spec of TraceTable

TracingGanttChart#

kind: "TracingGanttChart"
# TODO document the spec of TracingGanttChart

Common definitions#

Calculation specification#

It's an enum. Possible values are:

  • first
  • last
  • first-number
  • last-number
  • mean
  • sum
  • min
  • max

Format specification#

The format spec is one of the following:

Time format#

unit: <enum = "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years">
decimalPlaces: <int> # Optional

Percent format#

unit: <enum =  "percent" | "percent-decimal">
decimalPlaces: <int> # Optional

Decimal format#

unit: "decimal"
decimalPlaces: <int> # Optional
shortValues: <boolean> | default = false # Optional

Bytes format#

unit: "bytes"
decimalPlaces: <int> # Optional
shortValues: <boolean> | default = false # Optional

Throughput format#

unit: < enum = "counts/sec" | "events/sec" | "messages/sec" | "ops/sec" | "packets/sec" | "reads/sec" | "records/sec" | "requests/sec" | "rows/sec" | "writes/sec">
decimalPlaces: <int> # Optional
shortValues: <boolean> | default = false # Optional

Thresholds specification#

mode: <enum = "percent" | "absolute"> # Optional
defaultColor: string # Optional
steps:
  - <Step specification> # Optional

Step specification#

value: <int>
color: <string> # Optional
name: <string> # Optional