Go to file
Takashi Kajinami 4db9450929 Replace os-client-config
It was deprecated[1] after the code was merged into openstacksdk[2].

[1] https://review.opendev.org/c/openstack/os-client-config/+/549307
[2] https://review.opendev.org/c/openstack/openstacksdk/+/518128

Change-Id: I0cc581153c73a9dacc8a160fd63f9cb95660ef3a
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
2025-06-30 16:14:29 +00:00
2023-11-15 05:54:41 -05:00
2023-10-16 09:02:34 -04:00
2023-10-16 09:02:34 -04:00
2022-11-23 08:49:25 -05:00
2023-08-04 14:25:09 +02:00
2022-04-25 13:02:34 +02:00
2025-06-30 16:14:29 +00:00
2025-06-05 06:40:38 +00:00

python-observabilityclient

observabilityclient is an OpenStackClient (OSC) plugin implementation that implements commands for management of Prometheus.

Development

Install your OpenStack environment and patch your openstack client application using python.

# if using standalone, the following commands come after 'sudo dnf install -y python3-tripleoclient'

su - stack

# clone and install observability client plugin
git clone https://opendev.org/openstack/python-observabilityclient.git
cd python-observabilityclient
sudo python setup.py install --prefix=/usr

Usage

Use openstack metric query somequery to query for metrics in prometheus.

To use the python api do the following:

from observabilityclient import client

c = client.Client(
            '1', keystone_client.get_session(conf),
            adapter_options={
                'interface': conf.service_credentials.interface,
                'region_name': conf.service_credentials.region_name})
c.query.query("somequery")

List of commands

openstack metric list - lists all metrics openstack metric show - shows current values of a metric openstack metric query - queries prometheus and outputs the result openstack metric delete - deletes some metrics openstack metric snapshot - takes a snapshot of the current data openstack metric clean-tombstones - cleans the tsdb tombstones

List of functions provided by the python library

c.query.list - lists all metrics c.query.show - shows current values of a metric c.query.query - queries prometheus and outputs the result c.query.delete - deletes some metrics c.query.snapshot - takes a snapshot of the current data c.query.clean-tombstones - cleans the tsdb tombstones

Description
Client for Telemetry projects for Prometheus communication
Readme 671 KiB
Languages
Python 98.1%
Shell 1.9%