Skip to content

Extend GaugePanel options #668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Extend GaugePanel options #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1e7ba7b
add color, fieldMinMax, and thresholdType parameters to class GaugePa…
Jul 19, 2024
3e2abf1
add color, fieldMinMax, and thresholdType parameters to class GaugePa…
Jul 19, 2024
7ff57bd
updated change log
Jul 19, 2024
21a4f0d
add thresholds and thresholdType to self.panel_josn.fieldConfig
Jul 22, 2024
7ff8f3e
took thresholds back out of the return dict since it triggers the ite…
Jul 22, 2024
d01b362
added transformations option to class Stat, organized the return of B…
Jul 22, 2024
5f3462b
added TempoTarget and TempoFilter classes to target Tempo queries
Jul 23, 2024
76c5618
added white space around classes and removed commented out value opti…
Jul 24, 2024
544fce5
added 'LibraryPanel' class
Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ x.x.x ?
* Fix mappings for Table
* Added support for AWS Cross-Account in CloudwatchMetricsTarget
* Added `LokiTarget`
* Added `color`, `fieldMinMax`, and `thresholdType` option for `GaugePanel`
* Added `TempoTarget` and `TempoFilter` to target Tempo queries

0.7.1 2024-01-12
================
Expand Down
118 changes: 105 additions & 13 deletions grafanalib/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,7 @@ class Target(object):
target = attr.ib(default="")
instant = attr.ib(validator=instance_of(bool), default=False)
datasource = attr.ib(default=None)
range = attr.ib(validator=instance_of(bool), default=False)

def to_json_data(self):
return {
Expand All @@ -605,6 +606,7 @@ def to_json_data(self):
'step': self.step,
'instant': self.instant,
'datasource': self.datasource,
'range': self.range,
}


Expand All @@ -631,6 +633,54 @@ def to_json_data(self):
}


@attr.s
class TempoTarget(Target):
"""
Metric target to support Tempo queries
"""

filters = attr.ib(default=attr.Factory(list), validator=instance_of(list))
limit = attr.ib(default="")
queryType = attr.ib(default="")
tableType = attr.ib(default="")

def to_json_data(self):
"""Override the Target to_json_data to add addtional fields.
"""
super_json = super(TempoTarget, self).to_json_data()
super_json["filters"] = self.filters
super_json["limit"] = self.limit
super_json["queryType"] = self.queryType
super_json["tableType"] = self.tableType
return super_json


@attr.s
class TempoFilter(object):
"""
Constructor for Tempo filtering
"""

id = attr.ib(default="")
dataSource = attr.ib(default=None)
operator = attr.ib(default="")
scope = attr.ib(default="")
tag = attr.ib(default="")
value = attr.ib(default="")
valueType = attr.ib(default="")

def to_json_data(self):
return {
'id': self.id,
'dataSource': self.dataSource,
'operator': self.operator,
'scope': self.scope,
'tag': self.tag,
'value': self.value,
'valueType': self.valueType,
}


@attr.s
class SqlTarget(Target):
"""
Expand Down Expand Up @@ -2033,6 +2083,35 @@ def to_json_data(self):
return self.panel_json(graph_object)


@attr.s
class LibraryPanel(object):
title = attr.ib(default="")
gridPos = attr.ib(default=None)
id = attr.ib(default=None)
libraryPanel = attr.ib(default="")

def to_json_data(self):
return self.panel_json(
{
#'gridPos': self.gridPos,
'id': self.id,
'libraryPanel': self.libraryPanel,
}
)

def _map_panels(self, f):
return f(self)

def panel_json(self, overrides):
res = {
'gridPos': self.gridPos,
'id': self.id,
'libraryPanel': self.libraryPanel,
}
_deep_update(res, overrides)
return res


@attr.s
class RowPanel(Panel):
"""
Expand Down Expand Up @@ -2811,6 +2890,7 @@ class Stat(Panel):
fields = attr.ib(default="")
textMode = attr.ib(default='auto')
thresholds = attr.ib(default="")
transformations = attr.ib(default=attr.Factory(list), validator=instance_of(list))

def to_json_data(self):
return self.panel_json(
Expand Down Expand Up @@ -2840,6 +2920,7 @@ def to_json_data(self):
'values': False
}
},
'transformations': self.transformations,
'type': STAT_TYPE,
}
)
Expand Down Expand Up @@ -3360,6 +3441,7 @@ class BarGauge(Panel):

:param allValue: If All values should be shown or a Calculation
:param calc: Calculation to perform on metrics
:param color: color mode
:param dataLinks: list of data links hooked to datapoints on the graph
:param decimals: override automatic decimal precision for legend/tooltips
:param displayMode: style to display bar gauge in
Expand All @@ -3379,6 +3461,7 @@ class BarGauge(Panel):

allValues = attr.ib(default=False, validator=instance_of(bool))
calc = attr.ib(default=GAUGE_CALC_MEAN)
color = attr.ib(default=None)
dataLinks = attr.ib(default=attr.Factory(list))
decimals = attr.ib(default=None)
displayMode = attr.ib(
Expand Down Expand Up @@ -3419,28 +3502,28 @@ class BarGauge(Panel):
def to_json_data(self):
return self.panel_json(
{
'options': {
'displayMode': self.displayMode,
'fieldOptions': {
'fieldConfig': {
'defaults': {
'calcs': [self.calc],
'defaults': {
'decimals': self.decimals,
'max': self.max,
'min': self.min,
'title': self.label,
'unit': self.format,
'links': self.dataLinks,
},
'color': self.color,
'decimals': self.decimals,
'max': self.max,
'min': self.min,
'title': self.label,
'unit': self.format,
'links': self.dataLinks,
'limit': self.limit,
'mappings': self.valueMaps,
'override': {},
'thresholds': self.thresholds,
'values': self.allValues,
},
'orientation': self.orientation,
'showThresholdLabels': self.thresholdLabels,
'showThresholdMarkers': self.thresholdMarkers,
},
'options': {
'displayMode': self.displayMode,
'orientation': self.orientation,
},
'type': BARGAUGE_TYPE,
}
)
Expand All @@ -3452,8 +3535,10 @@ class GaugePanel(Panel):

:param allValue: If All values should be shown or a Calculation
:param calc: Calculation to perform on metrics
:param color: color mode
:param dataLinks: list of data links hooked to datapoints on the graph
:param decimals: override automatic decimal precision for legend/tooltips
:param fieldMinMax: force disable/enable min max values
:param format: defines value units
:param labels: option to show gauge level labels
:param limit: limit of number of values to show when not Calculating
Expand All @@ -3463,15 +3548,18 @@ class GaugePanel(Panel):
:param thresholdLabel: label for gauge. Template Variables:
"$__series_namei" "$__field_name" "$__cell_{N} / $__calc"
:param thresholdMarkers: option to show marker of level on gauge
:param thresholdType: threshold mode
:param thresholds: single stat thresholds
:param valueMaps: the list of value to text mappings
:param neutral: neutral point of gauge, leave empty to use Min as neutral point
"""

allValues = attr.ib(default=False, validator=instance_of(bool))
calc = attr.ib(default=GAUGE_CALC_MEAN)
color = attr.ib(default=None)
dataLinks = attr.ib(default=attr.Factory(list))
decimals = attr.ib(default=None)
fieldMinMax = attr.ib(default=None)
format = attr.ib(default='none')
label = attr.ib(default=None)
limit = attr.ib(default=None)
Expand All @@ -3480,6 +3568,7 @@ class GaugePanel(Panel):
rangeMaps = attr.ib(default=attr.Factory(list))
thresholdLabels = attr.ib(default=False, validator=instance_of(bool))
thresholdMarkers = attr.ib(default=True, validator=instance_of(bool))
thresholdType = attr.ib(default='absolute')
thresholds = attr.ib(
default=attr.Factory(
lambda: [
Expand All @@ -3498,7 +3587,9 @@ def to_json_data(self):
'fieldConfig': {
'defaults': {
'calcs': [self.calc],
'color': self.color,
'decimals': self.decimals,
'fieldMinMax': self.fieldMinMax,
'max': self.max,
'min': self.min,
'title': self.label,
Expand All @@ -3507,6 +3598,7 @@ def to_json_data(self):
'limit': self.limit,
'mappings': self.valueMaps,
'override': {},
'thresholdType': self.thresholdType,
'values': self.allValues,
'custom': {
'neutral': self.neutral,
Expand Down