https://github.com/openstack/python-observabilityclient
Client for Telemetry projects for Prometheus communication. Mirror of code maintained at opendev.org.
https://github.com/openstack/python-observabilityclient
Last synced: about 1 year ago
JSON representation
Client for Telemetry projects for Prometheus communication. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/python-observabilityclient
- Owner: openstack
- License: apache-2.0
- Created: 2023-10-14T02:47:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-03T08:59:20.000Z (about 1 year ago)
- Last Synced: 2025-06-03T19:37:15.653Z (about 1 year ago)
- Language: Python
- Homepage: https://opendev.org/openstack/python-observabilityclient
- Size: 157 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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://github.com/infrawatch/python-observabilityclient
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