{"id":21327361,"url":"https://github.com/wanadev/zabbix-agent-extension-couchdb3","last_synced_at":"2025-07-16T18:05:19.473Z","repository":{"id":62590893,"uuid":"280366556","full_name":"wanadev/zabbix-agent-extension-couchdb3","owner":"wanadev","description":"Zabbix extension to monitor CouchDB 3","archived":false,"fork":false,"pushed_at":"2020-09-03T14:17:32.000Z","size":159,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-07-12T07:32:08.581Z","etag":null,"topics":["couchdb","couchdb3","zabbix","zabbix-agent","zabbix-templates"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wanadev.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-17T08:11:09.000Z","updated_at":"2022-06-20T13:58:31.000Z","dependencies_parsed_at":"2022-11-04T02:49:37.919Z","dependency_job_id":null,"html_url":"https://github.com/wanadev/zabbix-agent-extension-couchdb3","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/wanadev/zabbix-agent-extension-couchdb3","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fzabbix-agent-extension-couchdb3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fzabbix-agent-extension-couchdb3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fzabbix-agent-extension-couchdb3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fzabbix-agent-extension-couchdb3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wanadev","download_url":"https://codeload.github.com/wanadev/zabbix-agent-extension-couchdb3/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wanadev%2Fzabbix-agent-extension-couchdb3/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265528953,"owners_count":23782790,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["couchdb","couchdb3","zabbix","zabbix-agent","zabbix-templates"],"created_at":"2024-11-21T21:16:57.122Z","updated_at":"2025-07-16T18:05:19.455Z","avatar_url":"https://github.com/wanadev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Zabbix Agent extension to monitor CouchDB 3\n===========================================\n\nThis is an extension (user parameter + trapper item and a template) for\nZabbix 4.x (should work on Zabbix 5.x too) to monitor CouchDB 3 servers.\n\n\nRequirements\n------------\n\n* Zabbix 4.0+\n* Python 3.5+\n* `py-zabbix \u003chttps://github.com/adubkov/py-zabbix\u003e`_\n\n\nInstallation (Agent side)\n-------------------------\n\nYou first have to install the extension on the server that runs the Zabbix\nAgent.\n\n\nFrom PyPI\n~~~~~~~~~\n\nRun the following command (as root)::\n\n    pip3 install zabbix-agent-extension-couchdb3\n\nThen copy the ``zabbix-agent-extension-couchdb3.conf`` file from this\nrepository to the ``/etc/zabbix/zabbix_agentd.conf.d/`` folder on the server.\n\nAnd finally, restart the Zabbix Agent (with systemd: ``systemctl restart\nzabbix-agent``).\n\n\nInstallation (Zabbix side)\n--------------------------\n\n1. Import the template\n~~~~~~~~~~~~~~~~~~~~~~\n\n* Go to ``Configuration`` -\u003e ``Templates``,\n* and click on the ``Import`` button.\n\n.. figure:: ./screenshots/zabbix_import_template_01.png\n   :alt: Screenshot\n\n* Now select the template (``zabbix-agent-extension-couchdb3.template.xml``),\n* and click on the ``Import`` button.\n\n.. figure:: ./screenshots/zabbix_import_template_02.png\n   :alt: Screenshot\n\n\n2. Add the template to a host\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Go to the host configuration,\n* and link the ``Template CouchDB 3`` tempate to it.\n\nDoc: https://www.zabbix.com/documentation/4.0/manual/config/hosts/host\n\n.. figure:: ./screenshots/zabbix_add_template.png\n   :alt: Screenshot\n\n\n3. Configure connection information using macros\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Go to the host configuration page,\n* open the ``Macros`` tab,\n* configure required parameters.\n\nThe following parameters are available:\n\n* ``{$COUCHDB_HOST}``: the CouchDB host (optional, default: ``localhost``)\n* ``{$COUCHDB_PASSWORD}``: the password to connect to CouchDB (required)\n* ``{$COUCHDB_PORT}``: the CouchDB port (optional, default: ``5984``)\n* ``{$COUCHDB_PROTO}``: the protocol to use to connect to CouchDB (``http`` or\n  ``https``, optional, default: ``http``)\n* ``{$COUCHDB_USER}``: the user to connect to CouchDB (optional, default:\n  ``admin``)\n\n**At least the** ``{$COUCHDB_PASSWORD}`` **macro must be defined!**\n\n.. figure:: ./screenshots/zabbix_config_macros.png\n   :alt: Screenshot\n\n\nAbout polling interval\n----------------------\n\nThe default polling interval of this probe in Zabbix is ``30s``. In order to\nhave accurate stats, you must configure the \"stats interval\" setting of your\nCouchDB to twice this value (``60s``)::\n\n    [stats]\n    interval = 60\n\nRead more `in the CouchDB documentation\n\u003chttps://docs.couchdb.org/en/stable/api/server/common.html#node-node-name-stats\u003e`_.\n\n\nCLI Usage\n---------\n\nThis extension also provides a CLI to simplify debugging.\n\n::\n\n    usage: zabbix-agent-extension-couchdb3\n    [-h] [--host HOST] [--port PORT] [--user USER] --password PASSWORD\n                       [--proto PROTO] [--show-json] [--show-stats] [--generate-template]\n\n    optional arguments:\n      -h, --help           show this help message and exit\n      --host HOST          The CouchDB server host (default: localhost)\n      --port PORT          The CouchDB server port (default: 5984)\n      --user USER          The username to use for the connexion (default: admin)\n      --password PASSWORD  The password to use for the connexion (mandatory)\n      --proto PROTO        The protocol to use (default: http)\n      --show-json          Display the raw JSON stats from CouchDB and exit (no stats will be\n                           sent to Zabbix)\n      --show-stats         Display the available stats with their values and description and exit\n                           (no stats will be sent to Zabbix)\n      --generate-template  Generates a Zabbix 4 template with all supported keys and exit (no\n                       stats will be sent to Zabbix)\n\n\nExample: dumping CouchDB stats as JSON::\n\n    zabbix-agent-extension-couchdb3 --password=XXXXX --show-json\n\nExample: displaying CouchDB stats in a more friendly format::\n\n    zabbix-agent-extension-couchdb3 --password=XXXXX --show-stats\n\nExample: generating the Zabbix template::\n\n    zabbix-agent-extension-couchdb3 --password=XXXXX --generate-template \u003e zabbix-agent-extension-couchdb3.template.xml\n\n\nChangelog\n---------\n\n* **v1.0.1:** Send credential to CouchDB at first request instead of waiting\n  for a 401 first\n* **v1.0.0:**\n\n  * Adds a command to generate the template from the available CouchDB stats\n  * Adds a template for Zabbix 4.0\n  * Adds documentation\n\n* **v0.2.0:** Handles histogram-type values\n* **v0.1.1:** Fixes an issue with the entry point\n* **v0.1.0:** Initial release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwanadev%2Fzabbix-agent-extension-couchdb3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwanadev%2Fzabbix-agent-extension-couchdb3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwanadev%2Fzabbix-agent-extension-couchdb3/lists"}