Metadata-Version: 2.1
Name: python-observabilityclient
Version: 0.3.0
Summary: OpenStack Observability Client
Home-page: https://infrawatch.github.io/documentation/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: Apache License, Version 2.0
Description: # 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
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8
Provides-Extra: doc
Provides-Extra: test
