tableau-prometheus-exporter


Nametableau-prometheus-exporter JSON
Version 0.3.2 PyPI version JSON
download
home_pagehttps://github.com/freenowtech/tableau-prometheus-exporter/
SummaryTableau Server Manager Prometheus Exporter
upload_time2023-08-23 10:50:44
maintainer
docs_urlNone
authorsergioasantiago
requires_python
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            .. image:: https://static.pepy.tech/badge/tableau-prometheus-exporter
    :alt: Monthly Downloads
    :target: https://pepy.tech/project/tableau-prometheus-exporter

.. image:: https://img.shields.io/pypi/v/tableau-prometheus-exporter.svg
    :alt: PyPI-Server
    :target: https://pypi.org/project/tableau-prometheus-exporter/

.. image:: https://coveralls.io/repos/github/freenowtech/tableau-prometheus-exporter/badge.svg?branch=main
    :target: https://coveralls.io/github/freenowtech/tableau-prometheus-exporter?branch=main

.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
    :alt: Project generated with PyScaffold
    :target: https://pyscaffold.org/

|

===========================
Tableau Prometheus Exporter
===========================


    Tableau Server Manager Prometheus Exporter


This repository contains the codebase to expose the Tableau Server Manager metrics to prometheus and visualize them in grafana.

---------------
Metrics Example
---------------

.. code-block::

    # HELP tableau_service_status Tableau services statuses
    # TYPE tableau_service_status gauge
    tableau_service_status{instance_id="0",node_id="node2",service_name="filestore",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="authnservice",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="databasemaintenance",state="Disabled",status="Stopped"} 0.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="dataserver",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="1",node_id="node2",service_name="dataserver",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="cacheserver",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="1",node_id="node2",service_name="cacheserver",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="interactive",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="searchserver",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="statsservice",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="vizportal",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="1",node_id="node2",service_name="vizportal",state="Enabled",status="Active"} 1.0
    tableau_service_status{instance_id="0",node_id="node2",service_name="backuprestore",state="Disabled",status="Stopped"} 0.0


--------------------
Install it from PyPI
--------------------

.. code-block:: bash

    $ pip install tableau-prometheus-exporter

-----
Usage
-----

**Python**

.. code-block:: python

    from tableau_prometheus_exporter.server import Server

    Server(config).start_and_run_forever()

**Command Line**

.. code-block:: bash

    $ python -m tableau_prometheus_exporter --h

**Docker**

.. code-block:: bash

    $ docker run --rm -p 8000:8000 -v ${PWD}/config.yaml:/app/config.yaml tableau-prometheus-exporter --config-file config.yaml

Go to http://localhost:8000/ to see the metrics.

-------------
Configuration
-------------

A sample configuration can be found at
`samples/config.yaml.template <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/samples/config.yaml.template>`_

---------
Dashboard
---------

A sample Grafana Dashboard can be found at
`samples/grafana.json <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/samples/grafana.json>`_

.. image:: samples/dashboard.jpeg
    :width: 80%
    :align: center
    :alt: Grafana Dashboard

--------
Alerting
--------

A sample of prometheus alert can be found at
`samples/prometheus.yaml <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/samples/prometheus.yaml>`_

------------
Contributing
------------

Please refer to the `CONTRIBUTING <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/CONTRIBUTING.md>`_
file for information about how to get involved. We welcome issues, questions, and pull requests.

----
Note
----

This project has been set up using PyScaffold 4.5. For details and usage
information on PyScaffold see https://pyscaffold.org/.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/freenowtech/tableau-prometheus-exporter/",
    "name": "tableau-prometheus-exporter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "sergioasantiago",
    "author_email": "sergio.a.santiago@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b3/f2/c7cd19db597c791d730e692f5e1c3e3ebcad06d005ab5cbbbe92426f1f15/tableau-prometheus-exporter-0.3.2.tar.gz",
    "platform": "any",
    "description": ".. image:: https://static.pepy.tech/badge/tableau-prometheus-exporter\n    :alt: Monthly Downloads\n    :target: https://pepy.tech/project/tableau-prometheus-exporter\n\n.. image:: https://img.shields.io/pypi/v/tableau-prometheus-exporter.svg\n    :alt: PyPI-Server\n    :target: https://pypi.org/project/tableau-prometheus-exporter/\n\n.. image:: https://coveralls.io/repos/github/freenowtech/tableau-prometheus-exporter/badge.svg?branch=main\n    :target: https://coveralls.io/github/freenowtech/tableau-prometheus-exporter?branch=main\n\n.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold\n    :alt: Project generated with PyScaffold\n    :target: https://pyscaffold.org/\n\n|\n\n===========================\nTableau Prometheus Exporter\n===========================\n\n\n    Tableau Server Manager Prometheus Exporter\n\n\nThis repository contains the codebase to expose the Tableau Server Manager metrics to prometheus and visualize them in grafana.\n\n---------------\nMetrics Example\n---------------\n\n.. code-block::\n\n    # HELP tableau_service_status Tableau services statuses\n    # TYPE tableau_service_status gauge\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"filestore\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"authnservice\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"databasemaintenance\",state=\"Disabled\",status=\"Stopped\"} 0.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"dataserver\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"1\",node_id=\"node2\",service_name=\"dataserver\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"cacheserver\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"1\",node_id=\"node2\",service_name=\"cacheserver\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"interactive\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"searchserver\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"statsservice\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"vizportal\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"1\",node_id=\"node2\",service_name=\"vizportal\",state=\"Enabled\",status=\"Active\"} 1.0\n    tableau_service_status{instance_id=\"0\",node_id=\"node2\",service_name=\"backuprestore\",state=\"Disabled\",status=\"Stopped\"} 0.0\n\n\n--------------------\nInstall it from PyPI\n--------------------\n\n.. code-block:: bash\n\n    $ pip install tableau-prometheus-exporter\n\n-----\nUsage\n-----\n\n**Python**\n\n.. code-block:: python\n\n    from tableau_prometheus_exporter.server import Server\n\n    Server(config).start_and_run_forever()\n\n**Command Line**\n\n.. code-block:: bash\n\n    $ python -m tableau_prometheus_exporter --h\n\n**Docker**\n\n.. code-block:: bash\n\n    $ docker run --rm -p 8000:8000 -v ${PWD}/config.yaml:/app/config.yaml tableau-prometheus-exporter --config-file config.yaml\n\nGo to http://localhost:8000/ to see the metrics.\n\n-------------\nConfiguration\n-------------\n\nA sample configuration can be found at\n`samples/config.yaml.template <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/samples/config.yaml.template>`_\n\n---------\nDashboard\n---------\n\nA sample Grafana Dashboard can be found at\n`samples/grafana.json <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/samples/grafana.json>`_\n\n.. image:: samples/dashboard.jpeg\n    :width: 80%\n    :align: center\n    :alt: Grafana Dashboard\n\n--------\nAlerting\n--------\n\nA sample of prometheus alert can be found at\n`samples/prometheus.yaml <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/samples/prometheus.yaml>`_\n\n------------\nContributing\n------------\n\nPlease refer to the `CONTRIBUTING <https://github.com/freenowtech/tableau-prometheus-exporter/blob/main/CONTRIBUTING.md>`_\nfile for information about how to get involved. We welcome issues, questions, and pull requests.\n\n----\nNote\n----\n\nThis project has been set up using PyScaffold 4.5. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Tableau Server Manager Prometheus Exporter",
    "version": "0.3.2",
    "project_urls": {
        "Documentation": "https://github.com/freenowtech/tableau-prometheus-exporter/",
        "Homepage": "https://github.com/freenowtech/tableau-prometheus-exporter/",
        "Source": "https://github.com/freenowtech/tableau-prometheus-exporter/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5071eba155101d8ccd4e8e6c542472535f4611a4f34caae5f2e89dc23ee08d1c",
                "md5": "c90fc363de092b8a7cc19f73edc08f06",
                "sha256": "89140807d2f838c9c21273f2f8bccd994e572f40308412c576f61836ffe76385"
            },
            "downloads": -1,
            "filename": "tableau_prometheus_exporter-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c90fc363de092b8a7cc19f73edc08f06",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12310,
            "upload_time": "2023-08-23T10:50:43",
            "upload_time_iso_8601": "2023-08-23T10:50:43.145752Z",
            "url": "https://files.pythonhosted.org/packages/50/71/eba155101d8ccd4e8e6c542472535f4611a4f34caae5f2e89dc23ee08d1c/tableau_prometheus_exporter-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3f2c7cd19db597c791d730e692f5e1c3e3ebcad06d005ab5cbbbe92426f1f15",
                "md5": "556ad07e0df39ca616ef59fc78a61505",
                "sha256": "e7793b1af7446291f88b98cae3e0bc4ed30609e79fab3e68624e592c71c72c68"
            },
            "downloads": -1,
            "filename": "tableau-prometheus-exporter-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "556ad07e0df39ca616ef59fc78a61505",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 163559,
            "upload_time": "2023-08-23T10:50:44",
            "upload_time_iso_8601": "2023-08-23T10:50:44.812988Z",
            "url": "https://files.pythonhosted.org/packages/b3/f2/c7cd19db597c791d730e692f5e1c3e3ebcad06d005ab5cbbbe92426f1f15/tableau-prometheus-exporter-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-23 10:50:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "freenowtech",
    "github_project": "tableau-prometheus-exporter",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "tableau-prometheus-exporter"
}
        
Elapsed time: 0.14125s