diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..298ea9e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..fbbb8e1 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,194 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('../')) + + +# -- Project information ----------------------------------------------------- + +project = 'Prometheus Client API Python' +copyright = '2019, Anand Sanmukhani' +author = 'Anand Sanmukhani' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '0.0.1' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'PrometheusClientAPIPythondoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'PrometheusClientAPIPython.tex', 'Prometheus Client API Python Documentation', + 'Anand Sanmukhani', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'prometheusclientapipython', 'Prometheus Client API Python Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'PrometheusClientAPIPython', 'Prometheus Client API Python Documentation', + author, 'PrometheusClientAPIPython', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d999f04 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. Prometheus Client API Python documentation master file, created by + sphinx-quickstart on Thu Mar 21 15:35:17 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Prometheus Client API Python's documentation! +======================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..27f573b --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..0b9071a --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +prometheus_api_client +===================== + +.. toctree:: + :maxdepth: 4 + + prometheus_api_client diff --git a/docs/source/prometheus_api_client.rst b/docs/source/prometheus_api_client.rst new file mode 100644 index 0000000..d15ca9e --- /dev/null +++ b/docs/source/prometheus_api_client.rst @@ -0,0 +1,22 @@ +prometheus\_api\_client package +=============================== + +Submodules +---------- + +prometheus\_api\_client.prometheus\_connect module +-------------------------------------------------- + +.. automodule:: prometheus_api_client.prometheus_connect + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: prometheus_api_client + :members: + :undoc-members: + :show-inheritance: diff --git a/prometheus_api_client/prometheus_connect.py b/prometheus_api_client/prometheus_connect.py index 80fe733..c056122 100644 --- a/prometheus_api_client/prometheus_connect.py +++ b/prometheus_api_client/prometheus_connect.py @@ -21,17 +21,18 @@ class PrometheusConnect: """ A Class for collection of metrics from a Prometheus Host + + :param url: (str) url for the prometheus host + :param headers: (dict) A dictionary of http headers to be used to communicate with the host. + Example: {"Authorization": "bearer my_oauth_token_to_the_host"} + :param disable_ssl: (bool) If set to True, will disable ssl certificate verification + for the http requests made to the prometheus host + """ def __init__(self, url='http://127.0.0.1:9090', headers=None, disable_ssl=False): """ Constructor for the class PrometheusConnect - Args: - url (str): url for the prometheus host - headers (dict): A dictionary of http headers to be used to communicate with the host. - Example: {'Authorization': "bearer my_oauth_token_to_the_host"} - disable_ssl (bool): If set to True, will disable ssl certificate verification - for the http requests made to the prometheus host """ self.headers = headers self.url = url @@ -42,13 +43,13 @@ def __init__(self, url='http://127.0.0.1:9090', headers=None, disable_ssl=False) @retry(stop_max_attempt_number=MAX_REQUEST_RETRIES, wait_fixed=CONNECTION_RETRY_WAIT_TIME) def all_metrics(self): """ - Get the list of all the metrics that the prometheus host has + Get the list of all the metrics that the prometheus host scrapes + + :return: (list) A list of names of all the metrics available from the + specified prometheus host - Returns: - list: list of names of all the metrics available from the specified prometheus host + :raises: (Http Response error) Raises an exception in case of a connection error - Raises: - Http Response error: Raises an exception in case of a connection error """ response = requests.get('{0}/api/v1/label/__name__/values'.format(self.url), verify=self.ssl_verification, @@ -69,21 +70,21 @@ def get_current_metric_value(self, metric_name, label_config=None): A method to get the current metric value for the specified metric and label configuration. - For example: - prom = PrometheusConnect() - my_label_config = {'cluster': 'my_cluster_id', - 'label_2': 'label_2_value'} - prom.get_current_metric_value(metric_name='up', label_config=my_label_config) + :param metric_name: (str) The name of the metric + + :param label_config: (dict) A dictionary that specifies metric labels and their values + + :return: (list) A list of current metric values for the specified metric - Args: - metric_name (str): The name of the metric - label_config (dict): A dictionary that specifies metric labels and their values + :raises: (Http Response error) Raises an exception in case of a connection error - Returns: - list: A list of current metric data for the specified metric + Example Usage: + ``prom = PrometheusConnect()`` + + ``my_label_config = {'cluster': 'my_cluster_id', 'label_2': 'label_2_value'}`` + + ``prom.get_current_metric_value(metric_name='up', label_config=my_label_config)`` - Raises: - Http Response error: Raises an exception in case of a connection error """ data = [] if label_config: @@ -120,42 +121,26 @@ def get_metric_range_data(self, A method to get the current metric value for the specified metric and label configuration. - For example: - prom = PrometheusConnect() - my_label_config = {'cluster': 'my_cluster_id', - 'label_2': 'label_2_value'} - prom.get_current_metric_value(metric_name='up', label_config=my_label_config) - - Args: - metric_name (str): The name of the metric - label_config (dict): A dictionary that specifies metric labels and their values - start_time (str): A string that specifies the metric range start time. - It uses the dateparser (https://dateparser.readthedocs.io/en/v0.3.4/) - module. - Example: - start_time='15m' will set the start time to - 15 mins before the current time - start_time='1553092437' will set the start time - to the given unix timestamp - start_time='12 May 2018' will set the start time to - '2018-05-12 00:00:00' - end_time (str): A string that specifies the metric range end time. - It follows the same rules as parameter start_time, it just - needs to be a time later than the start_time. - Example: - end_time='now' will set the end time to the current time - chunk_size (str): Duration of metric data downloaded in one request. - example, setting it to '3h' will download 3 hours - worth of data in each request made to the prometheus host - store_locally (bool): If set to True, will store data locally at, - "./metrics/$(PROMETHEUS_HOST)/$(METRIC_DATE)/$(METRIC_TIMESTAMP).json.bz2" - - Returns: - list: A list of metric data for the specified metric in the given time range - - Raises: - Http Response error: Raises an exception in case of a connection error + :param metric_name: (str) The name of the metric. + + :param label_config: (dict) A dictionary that specifies metric labels and their values. + + :param start_time: (str) A string that specifies the metric range start time. + + :param end_time: (str) A string that specifies the metric range end time. + + :param chunk_size: (str) Duration of metric data downloaded in one request. + example, setting it to '3h' will download 3 hours + worth of data in each request made to the prometheus host + :param store_locally: (bool) If set to True, will store data locally at, + `"./metrics/hostname/metric_date/name_time.json.bz2"` + + :return: (list) A list of metric data for the specified metric in the given time range + + :raises: (Http Response error) Raises an exception in case of a connection error + """ + data = [] start = int(dateparser.parse(str(start_time)).timestamp()) @@ -206,6 +191,7 @@ def get_metric_range_data(self, def _store_metric_values_local(self, metric_name, values, end_timestamp, compressed=False): ''' Method to store metrics locally + ''' if not values: _LOGGER.debug("No values for %s", metric_name) @@ -228,6 +214,7 @@ def _store_metric_values_local(self, metric_name, values, end_timestamp, compres def _metric_filename(self, metric_name, end_timestamp): ''' Adds a timestamp to the filename before it is stored + ''' end_timestamp = dateparser.parse(str(end_timestamp)) directory_name = end_timestamp.strftime("%Y%m%d") @@ -244,15 +231,13 @@ def custom_query(self, query: str): This method takes as input a string which will be sent as a query to the specified Prometheus Host. This query is a PromQL query. - Args: - query (str): This is a PromQL query, a few examples can be found - at https://prometheus.io/docs/prometheus/latest/querying/examples/ + :param query: (str) This is a PromQL query, a few examples can be found + at https://prometheus.io/docs/prometheus/latest/querying/examples/ - Returns: - list: A list of metric data received in response of the query sent + :Returns: (list) A list of metric data received in response of the query sent + + :raises: (Http Response error) Raises an exception in case of a connection error - Raises: - Http Response error: Raises an exception in case of a connection error """ data = None query = str(query) @@ -276,9 +261,9 @@ def pretty_print_metric(metric_data): """ A function to pretty print the metric data downloaded using class PrometheusConnect. - Args: - metric_data (list): This is the metric data list returned from methods + :param metric_data: (list) This is the metric data list returned from methods get_metric_range_data and get_current_metric_value + """ data = metric_data for metric in data: