Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/adubkov/py-zabbix

Python modules for zabbix.
https://github.com/adubkov/py-zabbix

Last synced: 3 months ago
JSON representation

Python modules for zabbix.

Host: GitHub
URL: https://github.com/adubkov/py-zabbix
Owner: adubkov
License: gpl-2.0
Created: 2015-02-11T08:01:04.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2023-11-09T14:09:38.000Z (8 months ago)
Last Synced: 2024-03-24T11:42:58.757Z (3 months ago)
Language: TSQL
Homepage:
Size: 1.19 MB
Stars: 403
Watchers: 31
Forks: 155
Open Issues: 40
Metadata Files:
- Readme: README.rst
- License: LICENSE

Lists

awesome-zabbix - py-zabbix - Zabbix module for Python. (API)
awesome - py-zabbix - Python modules for zabbix. (TSQL)

README

        |Build Status| |Coverage| |PyPi status| |PyPi version|

Zabbix module for Python

========================

Install

-------

You can install Zabbix modules for Python with pip:

::

    pip install py-zabbix

Official documentation for `py-zabbix `__

--------------------------------------------------------------------------------------

Examples

--------

ZabbixAPI

~~~~~~~~~

.. code:: python

    from pyzabbix.api import ZabbixAPI

    # Create ZabbixAPI class instance

    zapi = ZabbixAPI(url='https://localhost/zabbix/', user='Admin', password='zabbix')

    # Get all monitored hosts

    result1 = zapi.host.get(monitored_hosts=1, output='extend')

    # Get all disabled hosts

    result2 = zapi.do_request('host.get',

                              {

                                  'filter': {'status': 1},

                                  'output': 'extend'

                              })

    # Filter results

    hostnames1 = [host['host'] for host in result1]

    hostnames2 = [host['host'] for host in result2['result']]

    # Logout from Zabbix

    zapi.user.logout()

Or use 'with' statement to logout automatically:

.. code:: python

    from pyzabbix.api import ZabbixAPI

    # Create ZabbixAPI class instance

    with ZabbixAPI(url='https://localhost/zabbix/', user='Admin', password='zabbix') as zapi:

        # Get all monitored hosts

        result1 = zapi.host.get(monitored_hosts=1, output='extend')

Enable logging:

.. code:: python

    import sys

    import logging

    from pyzabbix.api import ZabbixAPI

    # Create ZabbixAPI class instance

    logger = logging.getLogger("pyzabbix")

    logger.setLevel(logging.DEBUG)

    handler = logging.StreamHandler(sys.stdout)

    logger.addHandler(handler)

    zapi = ZabbixAPI(url='http://localhost', user='Admin', password='zabbix')

Note that passwords and auth tokens are hidden when raw messages are logged or raised in exceptions ( but not hidden if print() is used):

.. code:: python

    ZabbixAPI.login(Admin,********)

    Call user.login method

    urllib2.Request(http://localhost/api_jsonrpc.php, {"jsonrpc": "2.0", "method": "user.login", "params": {"user": "Admin", "password": "********"}, "id": "1"})

    Response Body: {

        "jsonrpc": "2.0",

        "result": "********",

        "id": "1"

    }

ZabbixSender

~~~~~~~~~~~~

.. code:: python

    from pyzabbix import ZabbixMetric, ZabbixSender

    # Send metrics to zabbix trapper

    packet = [

      ZabbixMetric('hostname1', 'test[cpu_usage]', 2),

      ZabbixMetric('hostname1', 'test[system_status]', "OK"),

      ZabbixMetric('hostname1', 'test[disk_io]', '0.1'),

      ZabbixMetric('hostname1', 'test[cpu_usage]', 20, 1411598020),

    ]

    result = ZabbixSender(use_config=True).send(packet)

.. |Build Status| image:: https://travis-ci.org/adubkov/py-zabbix.svg?branch=master

   :target: https://travis-ci.org/adubkov/py-zabbix

.. |Coverage| image:: https://coveralls.io/repos/github/adubkov/py-zabbix/badge.svg?branch=master

   :target: https://coveralls.io/github/adubkov/py-zabbix?branch=master

.. |PyPi status| image:: https://img.shields.io/pypi/status/py-zabbix.svg

   :target: https://pypi.python.org/pypi/py-zabbix/

.. |PyPi version| image:: https://img.shields.io/pypi/v/py-zabbix.svg

   :target: https://pypi.python.org/pypi/py-zabbix/