openstack/python-observabilityclient

Files

Takashi Kajinami 9d4fe50163 Convert README to rst

... because rst is more widely used than markdown.

Also make the following minor improvements.
 - Add project badge
 - Remove reference to TripleO
 - Use actual list format to list up commands or interfaces

Change-Id: Ifc21c94ecacb3075f258388993657290ec9659d4
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>

2025-11-22 00:30:05 +09:00

1.9 KiB

Raw Permalink Blame History

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.

Usage

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

To use the python api do the following:

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