{
    "info": {
        "author": "Jakob Naucke",
        "author_email": "jakob.naucke@ibm.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": ".. Copyright 2018 IBM Corp. All Rights Reserved.\n.. \n.. Licensed under the Apache License, Version 2.0 (the \"License\");\n.. you may not use this file except in compliance with the License.\n.. You may obtain a copy of the License at\n.. \n..    http://www.apache.org/licenses/LICENSE-2.0\n.. \n.. Unless required by applicable law or agreed to in writing, software\n.. distributed under the License is distributed on an \"AS IS\" BASIS,\n.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n.. See the License for the specific language governing permissions and\n.. limitations under the License.\n\nzhmc-prometheus-exporter\n========================\n\n.. image:: https://travis-ci.org/zhmcclient/zhmc-prometheus-exporter.svg?branch=master\n    :target: https://travis-ci.org/zhmcclient/zhmc-prometheus-exporter\n.. image:: https://readthedocs.org/projects/zhmc-prometheus-exporter/badge/?version=stable\n    :target: https://zhmc-prometheus-exporter.readthedocs.io/en/latest/?badge=stable\n.. image:: https://coveralls.io/repos/github/zhmcclient/zhmc-prometheus-exporter/badge.svg?branch=master\n    :target: https://coveralls.io/github/zhmcclient/zhmc-prometheus-exporter?branch=master\n\n\nA `prometheus.io`_ exporter written in Python for metrics from the `IBM Z`_ Hardware Management Console using `zhmcclient`_. Tested with Python 3.4 through 3.7.\n\n.. _prometheus.io: https://prometheus.io/\n.. _IBM Z: https://www.ibm.com/it-infrastructure/z\n.. _zhmcclient: https://github.com/zhmcclient/python-zhmcclient\n\nInstallation\n------------\n\n.. code-block:: bash\n\n  $ pip3 install zhmc-prometheus-exporter\n\nDocumentation\n-------------\n\n`Read the Docs`_\n\n.. _Read the Docs: https://zhmc-prometheus-exporter.readthedocs.io/en/stable/\n\n\nQuickstart\n----------\n\nThe exporter itself\n^^^^^^^^^^^^^^^^^^^\n\nSet up your exporter. Edit your credentials YAML file. A `sample credentials YAML`_ is provided. Enter the IP address of the HMC, your username, and your password there. Put this file and ``metrics.yaml`` into ``/etc/zhmc-prometheus-exporter/``. The latter defines the metrics and descriptions, you do not have to edit it. You can then run\n\n.. code-block:: bash\n\n  $ zhmc_prometheus_exporter\n\nThe default port is 9291, you can change it with ``-p``. If you do not want to put ``hmccreds.yaml`` and ``metrics.yaml`` into ``/etc/zhmc-prometheus-exporter``, you can also specify them with ``-c`` and ``-m`` respectively.\n\n.. _sample credentials YAML: examples/hmccreds.yaml\n\nDemo setup\n^^^^^^^^^^\n\nIf you want a quick \"three simple metrics\" setup with Prometheus and Grafana you can proceed as follows:\n\n* Set up a Prometheus server. Get it from `Prometheus`_. A `sample configuration YAML`_ is provided. Fill in the IP and port the exporter will run on. If you left it at default, the port will be 9291. You can then run::\n\n    $ ./prometheus --config.file=prometheus.yaml\n\n  See also `Prometheus' guide`_.\n\n.. _Prometheus: https://prometheus.io/download/\n.. _sample configuration YAML: examples/prometheus.yaml\n.. _Prometheus' guide: https://prometheus.io/docs/prometheus/latest/getting_started/\n\n* Set up a Grafana server. Get it from `Grafana`_. You can then run::\n\n    $ ./bin/grafana-server web\n\n  By default it will be on ``localhost:3000``. You will have to set IP and port of the Prometheus server. If you didn't change it, it's ``localhost:9090``. See also `Prometheus' guide on Grafana`_.\n\n.. _Grafana: https://grafana.com/grafana/download\n.. _Prometheus' guide on Grafana: https://prometheus.io/docs/visualization/grafana/\n\n* Create the dashboard in Grafana. A `sample JSON`_ is provided. If you want it to work natively, you will have to name your source ``ZHMC_Prometheus``.\n\n.. _sample JSON: examples/grafana.json\n\nThe following image illustrates what the setup described above could look like.\n\n.. image:: https://github.com/zhmcclient/zhmc-prometheus-exporter/blob/master/examples/Deployment.png?raw=true\n    :align: center\n    :alt: Deployment diagram of the example\n\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/zhmcclient/zhmc-prometheus-exporter",
        "keywords": "",
        "license": "Apache-2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "zhmc-prometheus-exporter",
        "package_url": "https://pypi.org/project/zhmc-prometheus-exporter/",
        "platform": "",
        "project_url": "https://pypi.org/project/zhmc-prometheus-exporter/",
        "project_urls": {
            "Homepage": "https://github.com/zhmcclient/zhmc-prometheus-exporter"
        },
        "release_url": "https://pypi.org/project/zhmc-prometheus-exporter/0.4.0/",
        "requires_dist": [
            "PyYAML (>=5.1)",
            "zhmcclient (>=0.19.0)",
            "prometheus-client (>=0.3.1)"
        ],
        "requires_python": "",
        "summary": "A prometheus.io exporter for metrics from the IBM Z HMC",
        "version": "0.4.0"
    },
    "last_serial": 5707577,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "048a34b5f3ba709467e73f8464a87b54",
                    "sha256": "dac56da7810a9031f2c181b3a1471b08c4b7af39af53814892eccea22285ada3"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "048a34b5f3ba709467e73f8464a87b54",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14407,
                "upload_time": "2018-08-23T12:46:18",
                "url": "https://files.pythonhosted.org/packages/73/52/ceeb341f8a34b23f0dafa4f825c3244d2bf0227baebe236b07eed90cac8c/zhmc_prometheus_exporter-0.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "62b0fef097247ee54f91aea7415474ac",
                    "sha256": "aebdc054bd71a8ef698599375bfce758e31a847e970cf6ad90a955890fabdcef"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "62b0fef097247ee54f91aea7415474ac",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 37515,
                "upload_time": "2018-08-23T12:46:20",
                "url": "https://files.pythonhosted.org/packages/fa/09/f7e68936ec62018286c77cc1eec55dae593a0687fc64eb91c69ed114e459/zhmc_prometheus_exporter-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "94f1ad606bc196cf1d97a8ffad73a8e6",
                    "sha256": "5fafb98b41ff292efa13b73b741d12c24ff40bb30b3e91518ef70c396ac29f97"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.1.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "94f1ad606bc196cf1d97a8ffad73a8e6",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14419,
                "upload_time": "2018-08-23T16:48:02",
                "url": "https://files.pythonhosted.org/packages/f9/59/45555eac7b8eb359b12791a8f1ad524406515424cf2c9ae6faf2faaca3f5/zhmc_prometheus_exporter-0.1.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "dd6295e728e97988854ec9c5a2ef69d9",
                    "sha256": "3797346e13a7d03c57b0e3c2f865b30238f875c3da38098556321c8c36b28ed1"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "dd6295e728e97988854ec9c5a2ef69d9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 37662,
                "upload_time": "2018-08-23T16:48:04",
                "url": "https://files.pythonhosted.org/packages/6e/6a/44ae566a4be3d6d281f64c18b3774779b9376f930f275c7c68041d8fdc4a/zhmc_prometheus_exporter-0.1.2.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "02607cc58942f129d788e15e64930d71",
                    "sha256": "45dd2f5349200392ff48e5215fafc7f9c14dfd331e291c812680931464c686dd"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.2.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "02607cc58942f129d788e15e64930d71",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14500,
                "upload_time": "2018-08-24T09:19:52",
                "url": "https://files.pythonhosted.org/packages/cd/47/298d97fad028d73e293314d0a923197ddc04be5c5cadfef59ea041b467b9/zhmc_prometheus_exporter-0.2.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "4469bf750d4a046dba85ba038d481c7e",
                    "sha256": "328819a2ce4e26aaa1e4cc3ea7e24263f823266cad0331cb2a91e5d118e20d8f"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "4469bf750d4a046dba85ba038d481c7e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 37763,
                "upload_time": "2018-08-24T09:19:53",
                "url": "https://files.pythonhosted.org/packages/e2/9d/5716265c18328ed3ececbb16ad60f951ed64a567110ccb74c60cb36025ec/zhmc_prometheus_exporter-0.2.0.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2391875bbd1c26bca66782908a62434d",
                    "sha256": "e98c4c192376350a1673042b098be821ed748519985c3ec62d03b853b150b22a"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.3.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2391875bbd1c26bca66782908a62434d",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14696,
                "upload_time": "2019-08-11T15:28:38",
                "url": "https://files.pythonhosted.org/packages/98/4a/fa59e2776cd061cf1f1e78037aac01b31538507f1d431d4220f260aba868/zhmc_prometheus_exporter-0.3.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0c40e7501d40b05de43ddbb62338c5f5",
                    "sha256": "9d96e5aebea2925e248637b7901554aece69c057c4755d4e3f34af65f67d6691"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "0c40e7501d40b05de43ddbb62338c5f5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 39449,
                "upload_time": "2019-08-11T15:28:41",
                "url": "https://files.pythonhosted.org/packages/7f/02/53dcb3d02ad0a124949038d44f08c35e744fc635f58f497a4d916d129ea9/zhmc_prometheus_exporter-0.3.0.tar.gz"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a901a1601ebac0e1f61d04c8ba588663",
                    "sha256": "127c5c434f667f1ec49e5ff75d97d8df45acd10be62313a17f9206385c09a3e1"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.4.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a901a1601ebac0e1f61d04c8ba588663",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14744,
                "upload_time": "2019-08-21T07:39:19",
                "url": "https://files.pythonhosted.org/packages/2e/8a/169730e102692907bf7265b73371a7d7f818559900ac46384b2d2882b662/zhmc_prometheus_exporter-0.4.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "393533a85f9f542581e54170d192dcd0",
                    "sha256": "54ac3e2b7e2760d4143a836592cea8c1a98dcb9ce806fbbafaa49a143ea549b8"
                },
                "downloads": -1,
                "filename": "zhmc_prometheus_exporter-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "393533a85f9f542581e54170d192dcd0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 39706,
                "upload_time": "2019-08-21T07:39:21",
                "url": "https://files.pythonhosted.org/packages/22/2e/eefd0d9dbf3bd15bc06cd81dceca4be820f8949d3cd4bf7d515f0b38a9c8/zhmc_prometheus_exporter-0.4.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a901a1601ebac0e1f61d04c8ba588663",
                "sha256": "127c5c434f667f1ec49e5ff75d97d8df45acd10be62313a17f9206385c09a3e1"
            },
            "downloads": -1,
            "filename": "zhmc_prometheus_exporter-0.4.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a901a1601ebac0e1f61d04c8ba588663",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 14744,
            "upload_time": "2019-08-21T07:39:19",
            "url": "https://files.pythonhosted.org/packages/2e/8a/169730e102692907bf7265b73371a7d7f818559900ac46384b2d2882b662/zhmc_prometheus_exporter-0.4.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "393533a85f9f542581e54170d192dcd0",
                "sha256": "54ac3e2b7e2760d4143a836592cea8c1a98dcb9ce806fbbafaa49a143ea549b8"
            },
            "downloads": -1,
            "filename": "zhmc_prometheus_exporter-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "393533a85f9f542581e54170d192dcd0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 39706,
            "upload_time": "2019-08-21T07:39:21",
            "url": "https://files.pythonhosted.org/packages/22/2e/eefd0d9dbf3bd15bc06cd81dceca4be820f8949d3cd4bf7d515f0b38a9c8/zhmc_prometheus_exporter-0.4.0.tar.gz"
        }
    ]
}