grafyaml/grafana_dashboards/schema/panel/graph.py

125 lines
5.6 KiB
Python

# -*- coding: utf-8 -*-
# Copyright 2015 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import voluptuous as v
from grafana_dashboards.schema.panel.base import Base
class Graph(Base):
def get_schema(self):
alert_format = {
# could enforce "evaulator"/"operator"/"query" on this...
v.Required('conditions'): v.All(list),
v.Required('frequency', default='60s'): v.All(str),
v.Required('name'): v.All(str),
v.Required('executionErrorState', default='alerting'): (
v.Any('alerting', 'keep_state')),
v.Required('noDataState', default='no_data'): (
v.Any('no_data', 'alerting', 'ok', 'keep_state')),
v.Optional('notifications', default=[]): v.All(list),
}
yaxes_format = [
{
v.Optional('decimals'): v.All(int),
v.Optional('format', default='short'): Base.formats,
v.Optional('label', default=''): v.All(str),
v.Optional('logBase', default=1): v.All(int, v.Range(min=1)),
v.Optional('max'): v.All(int),
v.Optional('min'): v.All(int),
v.Optional('show', default=True): v.All(bool),
}
]
legend = {
v.Optional('alignAsTable', default=False): v.All(bool),
v.Optional('avg', default=False): v.All(bool),
v.Optional('current', default=False): v.All(bool),
v.Optional('max', default=False): v.All(bool),
v.Optional('min', default=False): v.All(bool),
v.Optional('rightSide', default=False): v.All(bool),
v.Optional('show', default=False): v.All(bool),
v.Optional('total', default=False): v.All(bool),
v.Optional('values', default=False): v.All(bool),
}
null_point_modes = v.Any('connected', 'null', 'null as zero')
value_types = v.Any('individual', 'cumulative')
tooltip = {
v.Required('query_as_alias', default=True): v.All(bool),
v.Required('shared', default=True): v.All(bool),
v.Required('value_type', default='cumulative'): v.All(value_types),
}
series_override = {
v.Required('alias'): v.All(str, v.Length(min=1)),
v.Optional('bars'): v.All(bool),
v.Optional('lines'): v.All(bool),
v.Optional('fill'): v.All(int, v.Range(min=0, max=10)),
v.Optional('width'): v.All(int, v.Range(min=1, max=10)),
v.Optional('nullPointMode'): v.All(null_point_modes),
v.Optional('fillBelowTo'): v.All(str),
v.Optional('steppedLine'): v.All(bool),
v.Optional('points'): v.All(bool),
v.Optional('pointsradius'): v.All(int, v.Range(min=1, max=5)),
v.Optional('stack'): v.All(v.Any(bool, 'A', 'B', 'C', 'D')),
v.Optional('color'): v.All(str),
v.Optional('yaxis'): v.All(int, v.Range(min=1, max=2)),
v.Optional('zindex'): v.All(int, v.Range(min=-3, max=3)),
v.Optional('transform'): v.All(v.Any('negative-Y')),
v.Optional('legend'): v.All(bool),
}
series_overrides = [series_override]
graph = {
v.Optional('alert'): v.All(alert_format),
v.Required('bars', default=False): v.All(bool),
v.Optional('datasource'): v.All(str),
v.Optional('decimals'): v.All(int),
v.Required('fill', default=1): v.All(int),
v.Optional('hideTimeOverride'): v.All(bool),
v.Optional('leftYAxisLabel'): v.All(str, v.Length(min=1)),
v.Optional('legend'): v.All(legend),
v.Required('lines', default=True): v.All(bool),
v.Required('linewidth', default=2): v.All(int),
v.Optional('minSpan'): v.All(int, v.Range(min=0, max=12)),
v.Optional('nullPointMode'): v.All(null_point_modes),
v.Required('percentage', default=False): v.All(bool),
v.Required('pointradius', default=5): v.All(int),
v.Required('points', default=False): v.All(bool),
v.Optional('repeat'): v.All(str),
v.Optional('rightYAxisLabel'): v.All(str, v.Length(min=1)),
v.Optional('seriesOverrides'): v.All(series_overrides,
v.Length(min=1)),
v.Required('stack', default=False): v.All(bool),
v.Required('steppedLine', default=False): v.All(bool),
v.Required('targets', default=[]): v.All(list),
v.Optional('timeFrom'): v.All(v.Match(r'[1-9]+[0-9]*[smhdw]')),
v.Optional('timeShift'): v.All(v.Match(r'[1-9]+[0-9]*[smhdw]')),
v.Optional('tooltip'): v.All(tooltip),
v.Required('x-axis', default=True): v.All(bool),
v.Required('y-axis', default=True): v.All(bool),
v.Optional('y_formats'): v.All([Base.formats],
v.Length(min=2, max=2)),
v.Optional('yaxes'): v.All(yaxes_format, v.Length(min=2, max=2)),
}
graph.update(self.base)
return v.Schema(graph)