{"id":21377713,"url":"https://github.com/quobject/zookeeper-commands","last_synced_at":"2025-07-14T17:39:40.892Z","repository":{"id":47984191,"uuid":"44770287","full_name":"Quobject/zookeeper-commands","owner":"Quobject","description":"A node.js client to run ZooKeeper Commands - the four letter words.","archived":false,"fork":false,"pushed_at":"2021-08-11T07:36:44.000Z","size":55,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T13:12:15.165Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Quobject.png","metadata":{"files":{"readme":"README.md","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":"2015-10-22T20:07:02.000Z","updated_at":"2019-07-31T02:20:55.000Z","dependencies_parsed_at":"2022-08-12T15:52:05.549Z","dependency_job_id":null,"html_url":"https://github.com/Quobject/zookeeper-commands","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Quobject/zookeeper-commands","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fzookeeper-commands","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fzookeeper-commands/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fzookeeper-commands/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fzookeeper-commands/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Quobject","download_url":"https://codeload.github.com/Quobject/zookeeper-commands/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fzookeeper-commands/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265327032,"owners_count":23747665,"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":[],"created_at":"2024-11-22T09:23:25.452Z","updated_at":"2025-07-14T17:39:40.701Z","avatar_url":"https://github.com/Quobject.png","language":"TypeScript","readme":"# zookeeper-commands\nA node.js client to run [ZooKeeper Commands](https://zookeeper.apache.org/doc/r3.4.6/zookeeperAdmin.html#sc_zkCommands) the four letter words.\n\n[![NPM](https://nodei.co/npm/zookeeper-commands.png?downloads=true\u0026downloadRank=true)](https://nodei.co/npm/zookeeper-commands/)\n[![NPM](https://nodei.co/npm-dl/zookeeper-commands.png?months=6\u0026height=3)](https://nodei.co/npm/zookeeper-commands/)\n\n[![NPM version][npm-image]][npm-url]\n[![NPM downloads][downloads-image]][downloads-url]\n\n## Installation\n\n   \n    npm install zookeeper-commands\n    \nThen:\n\n```js\nvar zookeeperCommands = require('zookeeper-commands');\nvar Options = zookeeperCommands.Options;\nvar Zookeeper = zookeeperCommands.Zookeeper;\n```\n\n## Usage\n\nWith promise\n\n```js\nvar options = new Options(\n    /* host */ 'localhost',\n    /* port */ 2181,\n    /* timeout_ms */ 1000\n   );    \n \nvar zookeeper = new Zookeeper(options);\n\nzookeeper.command('ruok').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data =  { command: 'ruok', raw: 'imok', ok: true }\n\n```\n\nWith callback:\n\n```js\n\nzookeeper.command( 'ruok', function (err, data) {\n  console.log('data = ', data);\n});\n\n```\n\nTypescript:\n\n```js\nimport { Zookeeper, Options } from 'zookeeper-commands';\n\nconst options = new Options(\n    /* host */ 'localhost',\n    /* port */ 2181,\n    /* timeout_ms */ 1000\n);\n\nconst zookeeper = new Zookeeper(options);\n\nzookeeper.command('ruok').then(function (data) {\n  console.log('data = ', data);\n});\n```\n\nstat\n\n```js\n\nzookeeper.command('stat').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data =  { command: 'stat', \n//  raw: 'Zookeeper version: 3.4.6-1569965, built on 02/20/2014 09:09 GMT\\nClients:\\n /203.219.47.249:46775[0](queued=0,recved=1,\n//sent=0)\\n /203.219.47.249:15285[1](queued=0,recved=5969,sent=5969)\\n\\nLatency min/avg/max: 0/0/20\\nReceived: 6040\\nSent: 6039\\n\n//Connections: 2\\nOutstanding: 0\\nZxid: 0x100000001\\nMode: follower\\nNode count: 4\\n',   \n//lines:    \n//[ 'Zookeeper version: 3.4.6-1569965, built on 02/20/2014 09:09 GMT', \n//  'Clients:', \n//  ' /203.219.47.249:46775[0](queued=0,recved=1,sent=0)',   \n//  ' /203.219.47.249:15285[1](queued=0,recved=5969,sent=5969)',  \n//  '',    \n//  'Latency min/avg/max: 0/0/20',  \n//  'Received: 6040',\n//  'Sent: 6039',    \n//  'Connections: 2',\n//  'Outstanding: 0',\n//  'Zxid: 0x100000001',  \n//  'Mode: follower',\n//  'Node count: 4', \n//  '' ],  \n//json:\n//{ clients:    \n//    [ { ip: '203.219.47.249', \n// port: '46775[0]',\n// queued: '0',\n// received: '1',   \n// sent: '0' },\n// { ip: '203.219.47.249', \n//   port: '15285[1]',\n//   queued: '0',\n//   received: '5969',\n//   sent: '5969' } ],\n//  latency: { minimum: '0', average: '0', maximum: '20' },  \n//  zookeeperVersion: '3.4.6-1569965',   \n//  buildDate: '02/20/2014 09:09 GMT',   \n//  reveiced: '6040',\n//  sent: '6039',    \n//  connections: '2',\n//  outstanding: '0',\n//  zxid: '0x100000001',  \n//  mode: 'follower',\n//  nodeCount: '4' } }   \n\n```\n\nconf\n\n```js\n\nzookeeper.command('conf').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data = {\n//  command: 'conf',\n//  raw: 'clientPort=2181\\ndataDir=/tmp/zookeeper/data/version-2\\ndataLogDir=/tmp/zookeeper/log/version-2\\ntickTime=2000\\nmaxClientCnxns=60\\nminSessionTimeout=4000\\nmaxSessionTimeout=40000\\nserverId=1\\ninitLimit=10\\nsyncLimit=5\\nelectionAlg=3\\nelectionPort=2223\\nquorumPort=2222\\npeerType=0\\n',\n//  lines:\n//   ['clientPort=2181',\n//     'dataDir=/tmp/zookeeper/data/version-2',\n//     'dataLogDir=/tmp/zookeeper/log/version-2',\n//     'tickTime=2000',\n//     'maxClientCnxns=60',\n//     'minSessionTimeout=4000',\n//     'maxSessionTimeout=40000',\n//     'serverId=1',\n//     'initLimit=10',\n//     'syncLimit=5',\n//     'electionAlg=3',\n//     'electionPort=2223',\n//     'quorumPort=2222',\n//     'peerType=0',\n//     ''],\n//  json:\n//   {\n//     clientPort: '2181',\n//     dataDir: '/tmp/zookeeper/data/version-2',\n//     dataLogDir: '/tmp/zookeeper/log/version-2',\n//     tickTime: '2000',\n//     maxClientCnxns: '60',\n//     minSessionTimeout: '4000',\n//     maxSessionTimeout: '40000',\n//     serverId: '1',\n//     initLimit: '10',\n//     syncLimit: '5',\n//     electionAlg: '3',\n//     electionPort: '2223',\n//     quorumPort: '2222',\n//     peerType: '0'\n//   }\n//}\n\n```\n\ncons\n\n```js\n\nzookeeper.command('cons').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data = {\n//  command: 'cons',\n//  raw: ' /203.219.47.249:55318[0](queued=0,recved=1,sent=0)\\n\\n',\n//  lines: [' /203.219.47.249:55318[0](queued=0,recved=1,sent=0)', '', ''],\n//  json:\n//   {\n//     clients:\n//      [{\n//        ip: '203.219.47.249',\n//        port: '55318[0]',\n//        queued: '0',\n//        received: '1',\n//        sent: '0'\n//      }],\n//     latency: {}\n//   }\n//}\n\n```\ncrst\n\n```js\n\nzookeeper.command('crst').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data = { command: 'crst', raw: 'Connection stats reset.\\n' }\n\n```\ndump\n\n```js\n\nzookeeper.command('dump').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data = {\n//  command: 'dump',\n//  raw: 'SessionTracker dump:\\nSession Sets (4):\\n0 expire at Sat Oct 24 05:56:22 UTC 2015:\\n0 expire at Sat Oct 24 05:56:24 UTC 2015:\\n0 expire at Sat Oct 24 05:56:28 UTC 2015:\\n2 expire at Sat Oct 24 05:56:30 UTC 2015:\\n\\t0x150982bb5b90001\\n\\t0x150982bb5b90000\\nephemeral nodes dump:\\nSessions with Ephemerals (2):\\n0x150982bb5b90001:\\n\\t/node3\\n0x150982bb5b90000:\\n\\t/node1\\n\\t/node2\\n',\n//  lines:\n//   ['SessionTracker dump:',\n//     'Session Sets (4):',\n//     '0 expire at Sat Oct 24 05:56:22 UTC 2015:',\n//     '0 expire at Sat Oct 24 05:56:24 UTC 2015:',\n//     '0 expire at Sat Oct 24 05:56:28 UTC 2015:',\n//     '2 expire at Sat Oct 24 05:56:30 UTC 2015:',\n//     '\\t0x150982bb5b90001',\n//     '\\t0x150982bb5b90000',\n//     'ephemeral nodes dump:',\n//     'Sessions with Ephemerals (2):',\n//     '0x150982bb5b90001:',\n//     '\\t/node3',\n//     '0x150982bb5b90000:',\n//     '\\t/node1',\n//     '\\t/node2',\n//     '']\n//}\n\n```\nenvi\n\n```js\n\nzookeeper.command('envi').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data = {\n//  command: 'envi',\n//  raw: 'Environment:\\nzookeeper.version=3.4.6-1569965, built on 02/20/2014 09:09 GMT\\nhost.name=0c18fd6765c0\\njava.version=1.7.0_79\\njava.vendor=Oracle Corporation\\njava.home=/usr/lib/jvm/java-7-openjdk-amd64/jre\\njava.class.path=/opt/zookeeper/bin/../build/classes:/opt/zookeeper/bin/../build/lib/*.jar:/opt/zookeeper/bin/../lib/slf4j-log4j12-1.6.1.jar:/opt/zookeeper/bin/../lib/slf4j-api-1.6.1.jar:/opt/zookeeper/bin/../lib/netty-3.7.0.Final.jar:/opt/zookeeper/bin/../lib/log4j-1.2.16.jar:/opt/zookeeper/bin/../lib/jline-0.9.94.jar:/opt/zookeeper/bin/../zookeeper-3.4.6.jar:/opt/zookeeper/bin/../src/java/lib/*.jar:/opt/zookeeper/bin/../conf:\\njava.library.path=/usr/java/packages/lib/amd64:/usr/lib/x86_64-linux-gnu/jni:/lib/x86_64-linux-gnu:/usr/lib/x86_64-linux-gnu:/usr/lib/jni:/lib:/usr/lib\\njava.io.tmpdir=/tmp\\njava.compiler=\u003cNA\u003e\\nos.name=Linux\\nos.arch=amd64\\nos.version=3.13.0-53-generic\\nuser.name=root\\nuser.home=/root\\nuser.dir=/\\n',\n//  lines:\n//   ['Environment:',\n//     'zookeeper.version=3.4.6-1569965, built on 02/20/2014 09:09 GMT',\n//     'host.name=0c18fd6765c0',\n//     'java.version=1.7.0_79',\n//     'java.vendor=Oracle Corporation',\n//     'java.home=/usr/lib/jvm/java-7-openjdk-amd64/jre',\n//     'java.class.path=/opt/zookeeper/bin/../build/classes:/opt/zookeeper/bin/../build/lib/*.jar:/opt/zookeeper/bin/../lib/slf4j-log4j12-1.6.1.jar:/opt/zookeeper/bin/../lib/slf4j-api-1.6.1.jar:/opt/zookeeper/bin/../lib/netty-3.7.0.Final.jar:/opt/zookeeper/bin/../lib/log4j-1.2.16.jar:/opt/zookeeper/bin/../lib/jline-0.9.94.jar:/opt/zookeeper/bin/../zookeeper-3.4.6.jar:/opt/zookeeper/bin/../src/java/lib/*.jar:/opt/zookeeper/bin/../conf:',\n//     'java.library.path=/usr/java/packages/lib/amd64:/usr/lib/x86_64-linux-gnu/jni:/lib/x86_64-linux-gnu:/usr/lib/x86_64-linux-gnu:/usr/lib/jni:/lib:/usr/lib',\n//     'java.io.tmpdir=/tmp',\n//     'java.compiler=\u003cNA\u003e',\n//     'os.name=Linux',\n//     'os.arch=amd64',\n//     'os.version=3.13.0-53-generic',\n//     'user.name=root',\n//     'user.home=/root',\n//     'user.dir=/',\n//     ''],\n//  json:\n//   {\n//     'Environment:': undefined,\n//     'zookeeper.version': '3.4.6-1569965, built on 02/20/2014 09:09 GMT',\n//     'host.name': '0c18fd6765c0',\n//     'java.version': '1.7.0_79',\n//     'java.vendor': 'Oracle Corporation',\n//     'java.home': '/usr/lib/jvm/java-7-openjdk-amd64/jre',\n//     'java.class.path': '/opt/zookeeper/bin/../build/classes:/opt/zookeeper/bin/../build/lib/*.jar:/opt/zookeeper/bin/../lib/slf4j-log4j12-1.6.1.jar:/opt/zookeeper/bin/../lib/slf4j-api-1.6.1.jar:/opt/zookeeper/bin/../lib/netty-3.7.0.Final.jar:/opt/zookeeper/bin/../lib/log4j-1.2.16.jar:/opt/zookeeper/bin/../lib/jline-0.9.94.jar:/opt/zookeeper/bin/../zookeeper-3.4.6.jar:/opt/zookeeper/bin/../src/java/lib/*.jar:/opt/zookeeper/bin/../conf:',\n//     'java.library.path': '/usr/java/packages/lib/amd64:/usr/lib/x86_64-linux-gnu/jni:/lib/x86_64-linux-gnu:/usr/lib/x86_64-linux-gnu:/usr/lib/jni:/lib:/usr/lib',\n//     'java.io.tmpdir': '/tmp',\n//     'java.compiler': '\u003cNA\u003e',\n//     'os.name': 'Linux',\n//     'os.arch': 'amd64',\n//     'os.version': '3.13.0-53-generic',\n//     'user.name': 'root',\n//     'user.home': '/root',\n//     'user.dir': '/'\n//   }\n//}\n\n```\nsrst\n\n```js\n\nzookeeper.command('srst').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data =  { command: 'srst', raw: 'Server stats reset.\\n' }\n\n```\nsrvr\n\n```js\n\nzookeeper.command('srvr').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data = {\n//  command: 'srvr',\n//  raw: 'Zookeeper version: 3.4.6-1569965, built on 02/20/2014 09:09 GMT\\nLatency min/avg/max: 0/0/0\\nReceived: 4\\nSent: 4\\nConnections: 1\\nOutstanding: 0\\nZxid: 0x10000000b\\nMode: leader\\nNode count: 7\\n',\n//  lines:\n//   ['Zookeeper version: 3.4.6-1569965, built on 02/20/2014 09:09 GMT',\n//     'Latency min/avg/max: 0/0/0',\n//     'Received: 4',\n//     'Sent: 4',\n//     'Connections: 1',\n//     'Outstanding: 0',\n//     'Zxid: 0x10000000b',\n//     'Mode: leader',\n//     'Node count: 7',\n//     ''],\n//  json:\n//   {\n//     zookeeperVersion: '3.4.6-1569965, built on 02/20/2014 09',\n//     latencyMinAvgMax: '0/0/0',\n//     received: '4',\n//     sent: '4',\n//     connections: '1',\n//     outstanding: '0',\n//     zxid: '0x10000000b',\n//     mode: 'leader',\n//     nodeCount: '7'\n//   }\n//}\n\n```\nwchs\n\n```js\n\nzookeeper.command('wchs').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data = {\n//  command: 'wchs',\n//  raw: '0 connections watching 0 paths\\nTotal watches:0\\n',\n//  lines: ['0 connections watching 0 paths', 'Total watches:0', ''],\n//  json: { totalWatches: '0' }\n//}\n\n```\nwchc\n\n```js\n\nzookeeper.command('wchc').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data =  { command: 'wchc', raw: '\\n' }\n\n```\nwchp\n\n```js\n\nzookeeper.command('wchp').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data =  { command: 'wchp', raw: '\\n' }\n\n```\nmntr\n\n```js\n\nzookeeper.command('mntr').then(function (data) {\n  console.log('data = ', data); \n});\n\n//data =  { command: 'mntr',                                                                                                     \n//  raw: 'zk_version\\t3.4.6-1569965, built on 02/20/2014 09:09 GMT\\nzk_avg_latency\\t0\\nzk_max_latency\\t0\\nzk_min_latency\\t0\\nzk_packets_received\\t13\\nzk_packets_sent\\t13\\nzk_num_alive_connections\\t1\\nzk_outstanding_requests\\t0\\nzk_server_state\\tleader\\nzk_znode_count\\t7\\nzk_watch_count\\t0\\nzk_ephemerals_count\\t3\\nzk_approximate_data_size\\t60\\nzk_open_file_descriptor_count\\t35\\nzk_max_file_descriptor_count\\t1048576\\nzk_followers\\t2\\nzk_synced_followers\\t2\\nzk_pending_syncs\\t0\\n',                           \n//lines:                                                                                                                       \n//[ 'zk_version\\t3.4.6-1569965, built on 02/20/2014 09:09 GMT',                                                               \n//  'zk_avg_latency\\t0',                                                                                                      \n//  'zk_max_latency\\t0',                                                                                                      \n//  'zk_min_latency\\t0',                                                                                                      \n//  'zk_packets_received\\t13',                                                                                                \n//  'zk_packets_sent\\t13',                                                                                                    \n//  'zk_num_alive_connections\\t1',                                                                                            \n//  'zk_outstanding_requests\\t0',                                                                                             \n//  'zk_server_state\\tleader',                                                                                                \n//  'zk_znode_count\\t7',                                                                                                      \n//  'zk_watch_count\\t0',                                                                                                      \n//  'zk_ephemerals_count\\t3',                                                                                                 \n//  'zk_approximate_data_size\\t60',                                                                                           \n//  'zk_open_file_descriptor_count\\t35',                                                                                      \n//  'zk_max_file_descriptor_count\\t1048576',                                                                                  \n//  'zk_followers\\t2',                                                                                                        \n//  'zk_synced_followers\\t2',                                                                                                 \n//  'zk_pending_syncs\\t0',                                                                                                    \n//  '' ],                                                                                                                     \n//json:                                                                                                                        \n//{ zkVersion: '3.4.6-1569965, built on 02/20/2014 09:09 GMT',                                                                \n//  zkAvgLatency: '0',                                                                                                        \n//  zkMaxLatency: '0',                                                                                                        \n//  zkMinLatency: '0',                                                                                                        \n//  zkPacketsReceived: '13',                                                                                                  \n//  zkPacketsSent: '13',                                                                                                      \n//  zkNumAliveConnections: '1',                                                                                               \n//  zkOutstandingRequests: '0',                                                                                               \n//  zkServerState: 'leader',                                                                                                  \n//  zkZnodeCount: '7',                                                                                                        \n//  zkWatchCount: '0',                                                                                                        \n//  zkEphemeralsCount: '3',                                                                                                   \n//  zkApproximateDataSize: '60',                                                                                              \n//  zkOpenFileDescriptorCount: '35',                                                                                          \n//  zkMaxFileDescriptorCount: '1048576',                                                                                      \n//  zkFollowers: '2',                                                                                                         \n//  zkSyncedFollowers: '2',                                                                                                   \n//  zkPendingSyncs: '0' } }               \n\n```\n\n\n## Usage Client \n\nsee [ClientREADME.md](ClientREADME.md)\n\n## License\n\nMIT\n\n[npm-image]: https://img.shields.io/npm/v/zookeeper-commands.svg?style=flat\n[npm-url]: https://npmjs.org/package/zookeeper-commands\n[downloads-image]: https://img.shields.io/npm/dm/zookeeper-commands.svg?style=flat\n[downloads-url]: https://npmjs.org/package/zookeeper-commands\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquobject%2Fzookeeper-commands","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquobject%2Fzookeeper-commands","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquobject%2Fzookeeper-commands/lists"}