[{"_1":2,"_197":-5,"_198":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_172":173},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":21,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_89":90,"_112":113,"_161":-5,"_162":11,"_163":21,"_164":11,"_165":-5,"_166":11,"_167":-5,"_168":169,"_170":114,"_171":-7},"canonicalUrl","https://hub.docker.com/r/nextdoor/zkmonitor/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","nextdoor","reponame","zkmonitor","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_58":35,"_32":33,"_59":60,"_61":-5,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":33,"_74":75,"_80":21,"_81":82,"_86":33,"_87":88},"categories",[],"content_types",[44],"image","date_registered","2016-01-29T19:54:14.864566Z","description","Zookeeper Node Monitoring Daemon","is_private","last_updated","2016-09-23T17:11:58.277683Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56,57],"application/vnd.docker.container.image.v1+json","application/vnd.docker.distribution.manifest.v1+prettyjws","name","pull_count",1706,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Zookeeper Node Monitoring Daemon\n\n[![Build Status](https://travis-ci.org/Nextdoor/zkmonitor.svg?branch=master)](https://travis-ci.org/Nextdoor/zkmonitor)\n[![pypy version](https://badge.fury.io/py/zk_monitor.png)](https://pypi.python.org/pypi/zk\\_monitor)\n[![Docker Layers](https://images.microbadger.com/badges/image/nextdoor/zkmonitor.svg)](https://hub.docker.com/r/nextdoor/zkmonitor/)\n\n\nThis is a simple daemon for monitoring particular Zookeeper nodes for\ncompliance with a given set of specifications (ie, minimum number of\nregistered nodes). In the event that a path changes and becomes out of\nspec, (too few nodes, for example), an alert is fired off to let you know.\n\n## Clustered Design\n\n*zk_monitor* is designed to operate in clustered mode with multiple redundant\nagents running on multiple servers. The agents talk to eachother through\nZookeeper using a common path and a series of locks/znodes. You can run as\nmany agents as you want, but only one will ever handle sending off alerts.\n\n## Configuration\n\nMost of the connection and *zk_monitor* specific settings are managed via\nCLI arguments:\n\n $ python runserver.py --help\n Usage: runserver.py \n \n Options:\n --version show program's version number and exit\n -h, --help show this help message and exit\n -z ZOOKEEPER, --zookeeper=ZOOKEEPER\n Zookeeper Server (def: localhost:2181)\n --zookeeper_user=ZOOKEEPER_USER\n Zookeeper ACL Username\n --zookeeper_pass=ZOOKEEPER_PASS\n Zookeeper ACL Password\n -c CLUSTER_NAME, --cluster_name=CLUSTER_NAME\n Unique cluster name (ie, prod-zookeeper-monitor)\n --cluster_prefix=CLUSTER_PREFIX\n Prefix path in Zookeeper for all zk_monitor clusters\n -f FILE, --file=FILE Path to YAML file with znodes to monitor.\n -p PORT, --port=PORT Port to listen to (def: 8080)\n -l LEVEL, --level=LEVEL\n Set logging level (INFO|WARN|DEBUG|ERROR)\n -s SYSLOG, --syslog=SYSLOG\n Log to syslog. Supply facility name. (ie \"local0\")\n\nThe list of paths that you want to monitor are supplied via a YAML\nformatted configuration file. Here's an example file:\n\n /services/foo/min_1:\n alerter:\n email: you@home.com\n children: 1\n /services/foo/min_0:\n alerter:\n email: your_buddy@home.com\n children: 0\n /services/foo/min_3:\n children: 3\n\n### Alerter Configuration\n\nIn the above example, you'll see that two of the paths have an 'alerter/email'\nparameter configured. With this in place, any path spec violations will result\nin an email fired off to that address. The third path does not have any\nsettings, which means that no alert will actually be sent off in the event of\na spec violation.\n\n### Simple Execution\n\n $ python runserver.py -l INFO -z localhost:2181 -f test.yaml\n 2014-05-31 16:20:25,862 [35661] [nd_service_registry] [__init__]: (INFO) Initializing ServiceRegistry object\n 2014-05-31 16:20:25,863 [35661] [nd_service_registry] [_connect]: (INFO) Connecting to Zookeeper Service (localhost:2181)\n 2014-05-31 16:20:25,867 [35661] [nd_service_registry] [_state_listener]: (INFO) Zookeeper connection state changed: CONNECTED\n 2014-05-31 16:20:25,868 [35661] [nd_service_registry] [__init__]: (INFO) Initialization Done!\n 2014-05-31 16:20:25,868 [35661] [zk_monitor.monitor] [_stateListener]: (INFO) Service registry connection state: True\n\n## REST Interface\n\nThough not necessary for alerting purposes, you can access the a JSON-formatted\nREST interface for the intentionally inspecting the status of the app, and\nthe current compliance of your watched Zookeeper nodes.\n\n### /status\n\nThis page provides a simple live status of the app and its monitors.\n\n $ curl --silent http://localhost:8080/status\n {\n \"monitor\": {\n \"alerter\": {\n \"alerting\": true\n },\n \"compliance\": {\n \"/services/foo/min_0\": true,\n \"/services/foo/min_1\": \"Found children (0) less than minimum (1)\",\n \"/services/foo/min_3\": \"Found children (2) less than minimum (3)\"\n }\n },\n \"version\": \"0.0.1\",\n \"zookeeper\": {\n \"connected\": true\n }\n }\n\n## Development\n\n### Class/Object Architecture\n\n runserver\n |\n +-- nd_service_registry.KazooServiceRegistry\n | | Connection to Zookeeper\n |\n +-- alert.Dispatcher\n | | Handles dispatching of all alerts to Alerter objects\n | |\n | +-- alerts.email.EmailAlerter\n | | | Sends Email-Based Alerts Asynchronously\n | | |\n | | +-- tornadomail.backends.smtp.EmailBackend()\n | |\n | +-- alerts.hipchat.HipChatAlerter\n | | | Sends Hipchat Alerts Asynchronously\n | |\n | +-- alerts.slack.SlackAlerter\n | | Sends Slack Alerts Asynchronously\n |\n +-- cluster.State\n | | Handles node-to-node communication via Zookeeper\n | |\n | +-- Registers /zk_monitor/agent/\n |\n +-- monitor.Monitor\n | | Monitors all configured paths\n | |\n | +-- Obj Ref -> alerts.Dispatcher\n | | Alerts are fired off to the Dispatcher, the Dispatcher\n | | handles determining whether or not the alert is a dup, a shift\n | | from in-compliance to out-of-compliance (or vice versa),\n | | and which Alerters to fire off (Hipchat, Email, etc).\n |\n +-- tornado.Application\n | | Handles all web requests\n | |\n | +-- web.app.getApplication()\n | |\n | +-- root.RootHandler\n | | URL: /\n | |\n | +-- state.StateHandler\n | | URL: /state\n | | Obj Ref -> nd_service_registry.KazooServiceRegistry\n | | Obj Ref -> monitor.Monitor\n\n### Setup\n\n # Create a dedicated Python virtual environment and source it\n virtualenv --no-site-packages .venv\n unset PYTHONPATH\n source .venv/bin/activate\n\n # Install the dependencies\n make build\n\n # Run the tests\n make test\n\n\n### Postfix on Mac OSX\n\nIf you want to develop on a Mac OSX host, you need to enable email the\n*postfix* daemon on your computer. Here's how!\n\nModify */Syatem/Library/LaunchDaemons/org.postfix.master.plist*:\n\n --- /System/Library/LaunchDaemons/org.postfix.master.plist.bak\t2014-06-02 11:45:24.000000000 -0700\n +++ /System/Library/LaunchDaemons/org.postfix.master.plist\t2014-06-02 11:47:07.000000000 -0700\n @@ -9,8 +9,6 @@\n ProgramArguments\n \n master\n - -e\n - 60\n \n QueueDirectories\n \n @@ -18,5 +16,8 @@\n \n AbandonProcessGroup\n \n +\n + KeepAlive\n + \n \n \n\nRestart the service:\n\n cd /System/Library/LaunchDaemons\n sudo launchctl unload org.postfix.master.plist \n sudo launchctl load org.postfix.master.plist\n","has_starred","hub_user","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":21,"_84":11,"_85":11},"read","write","admin","user","storage_size",279205969,"orgData",{"_91":92,"_93":94,"_95":96,"_97":33,"_98":99,"_100":101,"_102":99,"_103":104,"_105":106,"_107":108,"_109":108,"_110":108,"_111":21},"id","34f4d87161dd4d669379e8e888d07086","uuid","34f4d871-61dd-4d66-9379-e8e888d07086","type","organization","orgname","full_name","Nextdoor","location","San Francisco, CA","company","profile_url","https://nextdoor.com/","date_joined","2015-07-24T04:15:28.008685Z","gravatar_url","","gravatar_email","badge","is_active","recentTags",[114,150],{"_115":44,"_116":117,"_118":119,"_91":120,"_121":122,"_50":139,"_140":117,"_141":33,"_142":56,"_58":143,"_144":145,"_146":130,"_147":139,"_148":67,"_149":21},"content_type","creator",380608,"full_size",19952667,2022522,"images",[123],{"_124":125,"_126":127,"_128":108,"_129":130,"_131":132,"_133":134,"_135":108,"_136":-5,"_137":119,"_64":67,"_138":-5},"architecture","amd64","digest","sha256:0d16b732ef2f54d5f2d7214cfd66631e98987deb4be2943652618d58274b8372","features","last_pulled","2026-10-03T06:06:50.09965048Z","last_pushed","2016-09-23T17:10:58Z","os","linux","os_features","os_version","size","variant","2016-09-23T17:10:58.194643Z","last_updater","last_updater_username","media_type","latest","repository",504253,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_115":44,"_116":117,"_118":151,"_91":152,"_121":153,"_50":159,"_140":117,"_141":33,"_142":57,"_58":160,"_144":145,"_146":156,"_147":159,"_148":67,"_149":21},19703320,1868154,[154],{"_124":125,"_126":155,"_128":108,"_129":156,"_131":157,"_133":108,"_135":108,"_136":-5,"_137":158,"_64":67,"_138":-5},"sha256:75ed1542c739ae032f2c9c4f0d3f498d487e782c9301ce2b6042679a92aa65fa","2026-10-02T16:22:19.186188176Z","2016-02-16T20:58:49Z",19703703,"2016-02-16T20:58:48.588774Z","experimental","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":174,"_181":182,"_168":195,"_196":11},{"_40":175,"_42":176,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":177,"_58":35,"_32":33,"_59":60,"_61":-5,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":33,"_74":178,"_80":21,"_81":180,"_86":33,"_87":88},[],[44],[56,57],{"_76":11,"_77":179},[79],{"_83":21,"_84":11,"_85":11},"tags",{"_183":184,"_185":-5,"_186":-5,"_187":188},"count",2,"next","previous","results",[189,192],{"_115":44,"_116":117,"_118":119,"_91":120,"_121":190,"_50":139,"_140":117,"_141":33,"_142":56,"_58":143,"_144":145,"_146":130,"_147":139,"_148":67,"_149":21},[191],{"_124":125,"_126":127,"_128":108,"_129":130,"_131":132,"_133":134,"_135":108,"_136":-5,"_137":119,"_64":67,"_138":-5},{"_115":44,"_116":117,"_118":151,"_91":152,"_121":193,"_50":159,"_140":117,"_141":33,"_142":57,"_58":160,"_144":145,"_146":156,"_147":159,"_148":67,"_149":21},[194],{"_124":125,"_126":155,"_128":108,"_129":156,"_131":157,"_133":108,"_135":108,"_136":-5,"_137":158,"_64":67,"_138":-5},[],"canDeleteTags","actionData","errors"]

nextdoor/zkmonitor

Tags for nextdoor/zkmonitor