Perses
Docs

Label Names Variable builder

The Label Names Variable builder helps creating prometheus label names variables in the format expected by Perses.

Usage

package myDaC

import (
	labelNamesVarBuilder "github.com/perses/perses/cue/dac-utils/prometheus/variable/labelnames"
)

labelNamesVarBuilder & {} // input parameters expected

Parameters

ParameterTypeMandatory/OptionalDefaultDescription
#namestringMandatoryThe name of this variable.
#displayDisplayOptionalDisplay object to tune the display name, description and visibility (show/hide).
#allowAllValuebooleanOptionalfalseWhether to append the “All” value to the list.
#allowMultiplebooleanOptionalfalseWhether to allow multi-selection of values.
#customAllValuestringOptionalCustom value that will be used if #allowAllValue is true and if All is selected.
#capturingRegexpstringOptionalRegexp used to catch and filter the results of the query. If empty, then nothing is filtered (equivalent of setting it to (.*)).
#sortSortOptionalSort method to apply when rendering the list of values.
#datasourceNamestringMandatoryThe name of the datasource to query.
#metricstringOptionalThe name of the source metric to be used. /!\ Mandatory if you want to rely on the standard query pattern, thus didn’t provide a value to the #query parameter.
#querystringOptionalCustom query to be used for this variable. /!\ Mandatory if you didn’t provide a value to the #metric parameter.

Output

FieldTypeDescription
variableVariableThe final variable object, to be passed to the dashboard.

Example

package myDaC

import (
	labelNamesVarBuilder "github.com/perses/perses/cue/dac-utils/prometheus/variable/labelnames"
)

{labelNamesVarBuilder & {
	#name:           "namespaceLabels"
	#metric:         "kube_namespace_labels"
	#datasourceName: "promDemo"
}}.variable
Prev
Installing Perses in a container
Next
Label Values Variable builder