53b335aaca
* Add unit testing
* Fix code according to CI
This includes:
- formating changes
- rewording of some doc strings
- adding support to {label!~'value'} in rbac
* Add unit tests automation
* Fix CI automation
* Add requirements.txt
97 lines
3.8 KiB
Python
97 lines
3.8 KiB
Python
# Copyright 2023 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.
|
|
|
|
from observabilityclient.utils.metric_utils import format_labels
|
|
from observabilityclient.v1 import base
|
|
|
|
|
|
class QueryManager(base.Manager):
|
|
def list(self, disable_rbac=False):
|
|
"""List metric names.
|
|
|
|
:param disable_rbac: Disables rbac injection if set to True
|
|
:type disable_rbac: boolean
|
|
"""
|
|
if disable_rbac or self.client.rbac.disable_rbac:
|
|
metric_names = self.prom.label_values("__name__")
|
|
return sorted(metric_names)
|
|
else:
|
|
match = f"{{{format_labels(self.client.rbac.default_labels)}}}"
|
|
metrics = self.prom.series(match)
|
|
if metrics == []:
|
|
return []
|
|
unique_metric_names = list(set([m['__name__'] for m in metrics]))
|
|
return sorted(unique_metric_names)
|
|
|
|
def show(self, name, disable_rbac=False):
|
|
"""Show current values for metrics of a specified name.
|
|
|
|
:param disable_rbac: Disables rbac injection if set to True
|
|
:type disable_rbac: boolean
|
|
"""
|
|
enriched = self.client.rbac.append_rbac(name,
|
|
disable_rbac=disable_rbac)
|
|
last_metric_query = f"last_over_time({enriched}[5m])"
|
|
return self.prom.query(last_metric_query)
|
|
|
|
def query(self, query, disable_rbac=False):
|
|
"""Send a query to prometheus.
|
|
|
|
The query can be any PromQL query. Labels for enforcing
|
|
rbac will be added to all of the metric name inside the query.
|
|
Having labels as part of a query is allowed.
|
|
|
|
A call like this:
|
|
query("sum(name1) - sum(name2{label1='value'})")
|
|
will result in a query string like this:
|
|
"sum(name1{rbac='rbac_value'}) -
|
|
sum(name2{label1='value', rbac='rbac_value'})"
|
|
|
|
:param query: Custom query string
|
|
:type query: str
|
|
:param disable_rbac: Disables rbac injection if set to True
|
|
:type disable_rbac: boolean
|
|
"""
|
|
query = self.client.rbac.enrich_query(query, disable_rbac=disable_rbac)
|
|
return self.prom.query(query)
|
|
|
|
def delete(self, matches, start=None, end=None):
|
|
"""Delete metrics from Prometheus.
|
|
|
|
The metrics aren't deleted immediately. Do a call to clean_tombstones()
|
|
to speed up the deletion. If start and end isn't specified, then
|
|
minimum and maximum timestamps are used.
|
|
|
|
:param matches: List of matches to match which metrics to delete
|
|
:type matches: [str]
|
|
:param start: timestamp from which to start deleting
|
|
:type start: rfc3339 or unix_timestamp
|
|
:param end: timestamp until which to delete
|
|
:type end: rfc3339 or unix_timestamp
|
|
"""
|
|
# TODO(jwysogla) Do we want to restrict access to the admin api
|
|
# endpoints? We could either try to inject
|
|
# the project label like in query. We could also
|
|
# do some check right here, before
|
|
# it gets to prometheus.
|
|
return self.prom.delete(matches, start, end)
|
|
|
|
def clean_tombstones(self):
|
|
"""Instruct prometheus to clean tombstones."""
|
|
return self.prom.clean_tombstones()
|
|
|
|
def snapshot(self):
|
|
"""Create a snapshot of the current data."""
|
|
return self.prom.snapshot()
|