# 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
Raw data
{
"_id": null,
"home_page": "https://infrawatch.github.io/documentation/",
"name": "python-observabilityclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/f4/cc/030a6d00689993a8c8bc57f2949be1025534da41739fc3c07f255d070761/python-observabilityclient-0.2.0.tar.gz",
"platform": null,
"description": "# python-observabilityclient\n\nobservabilityclient is an OpenStackClient (OSC) plugin implementation that\nimplements commands for management of Prometheus.\n\n## Development\n\nInstall your OpenStack environment and patch your `openstack` client application using python.\n\n```\n# if using standalone, the following commands come after 'sudo dnf install -y python3-tripleoclient'\n\nsu - stack\n\n# clone and install observability client plugin\ngit clone https://github.com/infrawatch/python-observabilityclient\ncd python-observabilityclient\nsudo python setup.py install --prefix=/usr\n```\n\n## Usage\n\nUse `openstack metric query somequery` to query for metrics in prometheus.\n\nTo use the python api do the following:\n```\nfrom observabilityclient import client\n\nc = client.Client(\n '1', keystone_client.get_session(conf),\n adapter_options={\n 'interface': conf.service_credentials.interface,\n 'region_name': conf.service_credentials.region_name})\nc.query.query(\"somequery\")\n```\n\n## List of commands\n\nopenstack metric list - lists all metrics\nopenstack metric show - shows current values of a metric\nopenstack metric query - queries prometheus and outputs the result\nopenstack metric delete - deletes some metrics\nopenstack metric snapshot - takes a snapshot of the current data\nopenstack metric clean-tombstones - cleans the tsdb tombstones\n\n## List of functions provided by the python library\nc.query.list - lists all metrics\nc.query.show - shows current values of a metric\nc.query.query - queries prometheus and outputs the result\nc.query.delete - deletes some metrics\nc.query.snapshot - takes a snapshot of the current data\nc.query.clean-tombstones - cleans the tsdb tombstones\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "OpenStack Observability Client",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://infrawatch.github.io/documentation/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a7369940b6578bb93b4873d74d3995030a62aba0b47d7d2f40d4a0f90ac12e6",
"md5": "859e9056a92edd524c9442cdab245da7",
"sha256": "a242203ad4debc1cf75e75e04c393de17a86ccc93182111839fedafd6dc9d22a"
},
"downloads": -1,
"filename": "python_observabilityclient-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "859e9056a92edd524c9442cdab245da7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 35753,
"upload_time": "2024-04-25T11:20:29",
"upload_time_iso_8601": "2024-04-25T11:20:29.068975Z",
"url": "https://files.pythonhosted.org/packages/7a/73/69940b6578bb93b4873d74d3995030a62aba0b47d7d2f40d4a0f90ac12e6/python_observabilityclient-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f4cc030a6d00689993a8c8bc57f2949be1025534da41739fc3c07f255d070761",
"md5": "6fc776f48adecbf89e313c6f3246a79a",
"sha256": "03046ed857c5c2856827671ad4fde47d8dd5916e9fc1493f80bb77ac055262fc"
},
"downloads": -1,
"filename": "python-observabilityclient-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6fc776f48adecbf89e313c6f3246a79a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27094,
"upload_time": "2024-04-25T11:20:30",
"upload_time_iso_8601": "2024-04-25T11:20:30.204728Z",
"url": "https://files.pythonhosted.org/packages/f4/cc/030a6d00689993a8c8bc57f2949be1025534da41739fc3c07f255d070761/python-observabilityclient-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 11:20:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "python-observabilityclient"
}
JSON