"Fossies" - the Fresh Open Source Software Archive
Member "apache-zookeeper-3.8.1/zookeeper-contrib/zookeeper-contrib-zooinspector/README.txt" (25 Jan 2023, 5894 Bytes) of package /linux/misc/apache-zookeeper-3.8.1.tar.gz:
As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard
) with prefixed line numbers.
Alternatively you can here view
the uninterpreted source code file.
See also the last Fossies "Diffs"
side-by-side code changes report for "README.txt": 3.6.2_vs_3.7.0
2 ZooInspector - Browser and Editor for ZooKeeper Instances
3 Author: Colin Goodheart-Smithe
4 Date: February 2010
7 ZooInspector is a Java Swing based application for browsing and editing ZooKeeper instances.
11 - Features
12 - Pre-requisites
13 - Build Instructions
14 - Using ZooInspector
15 - Creating and Using Plugins
19 Below is a list of features in the current release of ZooInspector.
20 - Load connection settings from a zookeeper properties file
21 - Pluggable DataEncryptionManagers to specify how data should be encrypted and decrypted in the Zookeeper instance
22 - Browsable tree view of the ZooKeeper instance
23 - View the data in a node
24 - View the ACLs currently applied to a node
25 - View the metadata for a node (Version, Number of Children, Last modified Time, etc.)
26 - Pluggable NodeViewers interface
27 - Ability to save/load and set default Node Viewers
29 Maven Build Instructions
31 0. Pre-requisites
32 - Run "mvn install" in the root directory of the Zookeeper project
33 1. Open a command line
34 2. cd into this directory
35 3. mvn install
36 4. To run ZooInspector run zooInspector.cmd (on Windows) or zooInspector.sh (on Linux) (these scripts will
37 find the built JAR automatically in the "target" directory as long as you don't move it)
39 Ant Build Instructions
41 0. Pre-requisites
42 - The main zookeeper build script must have been run before building this module
43 1. Open a command line.
44 2. cd into this directory
45 3. Run command: ant
46 4. ZooInspector will be built to ../../../build/contrib/ZooInspector
47 5. Copy zookeeper-3.x.x.jar into the lib sub-directory (if you are using zookeeper-3.3.0.jar it will have been
48 copied to this directory during the build
49 6. By default the zookeeper.cmd and zookeeper.sh files expect zookeeper-3.3.0.jar. If you are using another version
50 you will need to change these files to point to the zookeeper-3.x.x.jar you copied to the lib directory
51 7. To run ZooInspector run zooInspector.cmd (on Windows) or zooInspector.sh (on Linux). If you are using
52 zookeeper-3.3.0.jar and do not require any classpath changes you can run the zookeeper-dev-ZooInspector.jar
55 Using ZooInspector
57 To start ZooInspector run zooInspector.cmd (on Windows) or zooInspector.sh (on Linux). If you are using
58 zookeeper-3.3.0.jar and do not require any classpath changes you can run the zookeeper-dev-ZooInspector.jar
61 Click the play button on the toolbar to bring up the connection dialog. From here you can enter connection
62 information for your zookeeper instance. You can also load the connection properties from a file. This file can
63 have the format as a normal zookeeper properties file (i.e. hosts and timeout key-value pairs) and van optional have
64 an encryptionManager key-value pair to specify the DataEncryptionManager to use for this connection
65 (DataEncryptionManagers are explained in further detail in the 'Creating and Using Plugins' section below). You can
66 also set the entered information as the defaults so that when you first start ZooInspector these settings are
67 automatically loaded into this dialog. Pressing the OK button with connect to your ZooKeeper instance and show the
68 current node tree on the left of the main panel.
70 Clicking a node in the node tree will load the data for that node into the node viewers. Three node viewers are
71 currently distributed with ZooInspector:
72 1. Node Data - This enables you to see the data current stored on that node. This data can be modified and
73 saved. The data is decrypted and encrypted using the DataEncryptionManager specified on the connection
75 2. Node Metadata - This enables you to see the metadata associated with this node. This is essentially the data
76 obtained from the Stat object for this node.
77 3. Node ACLs - This allows you to see the ACLs currently applied to this node. Currently there is no ability
78 to change the ACLs on a node, but it is a feature I would like to add.
79 Other custom Node Viewers can be added, this is explained in the 'Creating and Using Plugins' section below.
82 Creating and Using Plugins
84 There are two types of plugin which can be used with ZooInspector:
85 1. DataEncryptionManager - This specifies how data should be encrypted and decrypted when working with a
86 zookeeper instance.
87 2. ZooInspectorNodeViewer - This is a GUI panel which provides a view of visualisation on a node.
88 More information on these interfaces can be found in the javadocs for this module.
90 To use a plugin in ZooInspector, build the plugin to a jar and copy the jar to the lib sub-directory. Edit the
91 zooInspector.cmd and/or zooInspector.sh files to include your new jar on the classpath and run ZooInspector.
93 For DataEncryptionManagers, click the play button to open the connection dialog and enter the full class name of
94 your DataEncryptionManager in the 'Data Encryption Manager' field. You can make this Data Encryption Manager the
95 default by clicking 'Set As Default'. Click the 'OK' button to instantiate and use your plugin.
97 For ZooInspectorNodeViewers, Click the 'Change Node Viewers' button on the toolbar (looks like a tree with a pencil)
98 and enter the full classname for your Node Viewer in the field left of the 'Add' button, then click the 'Add'
99 button. The Node Viewer will be instantiated and should appear in the list. You can change the order of the Node
100 viewers by clicking the up and down buttons and delete a Node Viewer by clicking the delete button. You can save
101 to configuration to a file or set it as the default if necessary. Then click the 'OK' button and your Node Viewer
102 should appear in the tabs on the right of the main panel.