https://github.com/panagiks/opium
OpenShift Pod Independent Usage Metrics (OPIUM) pulling & aggregating metrics from multiple pods made easy!
https://github.com/panagiks/opium
observability okd prometheus
Last synced: 11 months ago
JSON representation
OpenShift Pod Independent Usage Metrics (OPIUM) pulling & aggregating metrics from multiple pods made easy!
- Host: GitHub
- URL: https://github.com/panagiks/opium
- Owner: panagiks
- License: mit
- Created: 2020-10-25T12:37:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-25T20:32:11.000Z (over 5 years ago)
- Last Synced: 2025-03-02T16:49:42.657Z (over 1 year ago)
- Topics: observability, okd, prometheus
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
=====
opium
=====
.. image:: https://img.shields.io/pypi/v/opium.svg
:target: https://pypi.python.org/pypi/opium
.. image:: https://img.shields.io/travis/panagiks/opium.svg
:target: https://travis-ci.com/panagiks/opium
.. image:: https://readthedocs.org/projects/opium/badge/?version=latest
:target: https://opium.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
OpenShift Pod Independent Usage Metrics (OPIUM) pulling & aggregating metrics from multiple pods made easy!
* Free software: MIT license
* Documentation: https://opium.readthedocs.io.
Aggregating metrics from pods through OKD's router can be a challenge. OPIUM offers the next best thing.
While it doesn't (yet) aggregate the varius metrics it gathers the metrics from the defined Deployment Configs
on a specific OKD project and serves them to a single /metrics endpoint. This way it allows for easier gathering
of per-pod metrics.
Of course, given no real aggregation is happening, it makes sense that your metrics should contain some unique label
value to differentiate the same measurements from different pods. The contents of the HOSTNAME env variable are usually
a good fit for the value of such a label since they will be unique (within a project). This way 'true' aggregation can happen
at a later stage (i.e. with a sum across all instances while graphing the values).
Configuration
-------------
OPIUM is configured through environment variables and specifically the following:
* OPIUM_OKD_URL => The url of the OKD instance's master, including the scheme and without a trailing `/`
* OPIUM_OKD_TOKEN => An access token for a service account with `view` and `edit` permissions on the desired project
* OPIUM_PROJECT => Project to be exported
* OPIUM_DEPLOYMENT_CONFIGS => Comma separated (no spaces) list of Deployment Configs to export
OKD Preparation
---------------
In your OKD admin CLI you will need to run the following
.. code-block:: bash
# create a service account
oc create serviceaccount
# Retrieve the service account's access token (set this to OPIUM_OKD_TOKEN)
oc serviceaccounts get-token
# Give the service account the required permissions to the desired project
oc policy add-role-to-user view system:serviceaccount::
oc policy add-role-to-user edit system:serviceaccount::
Execution
---------
To start OPIUM (after you've set the configuration environment variables appropriately) simly run:
.. code-block:: bash
opium
This will spawn an HTTP server listening on your system's public interface and on port 8080.
Configuration for the listening interface, as well as a containerized version of OPIUM will follow in later versions.
Features
--------
* Gather the response of `/metrics` from all the pods of the specified `deployment_config`
* Serve them as one response
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
This repository uses the following as a preview image (under CC BY-SA 2.0): "July 19th. Opium Poppy" by amandabhslater is licensed with CC BY-SA 2.0. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/2.0/
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage