├── .gitignore
├── LICENSE
├── README.md
├── pom.xml
└── src
└── main
├── java
└── com
│ └── brainlounge
│ └── zooterrain
│ ├── netty
│ ├── OutboundConnector.java
│ ├── WebSocketServer.java
│ ├── WebSocketServerInboundHandler.java
│ ├── WebSocketServerIndexPage.java
│ ├── WebSocketServerInitializer.java
│ └── WebSocketServerJSPage.java
│ └── zkclient
│ ├── ClientMessage.java
│ ├── ClientRequest.java
│ ├── ControlMessage.java
│ ├── DataMessage.java
│ ├── ZNodeMessage.java
│ ├── ZNodeState.java
│ ├── ZkStateListener.java
│ └── ZkStateObserver.java
└── resources
├── hexdump.js
└── index.html
/.gitignore:
--------------------------------------------------------------------------------
1 | *.class
2 |
3 | # Package Files #
4 | *.jar
5 | *.war
6 | *.ear
7 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | zooterrain
2 | ==========
3 |
4 | View ZooKeeper znode tree in a browser
5 |
6 | zooterrain is a small server every WebSocket-capable browser is able to connect to.
7 | It will display all the znodes from a running ZooKeeper ensemble.
8 | As znodes are deleted or new ones are created, this will be visualized in the browser.
9 |
10 | ## Features
11 |
12 | 1. Display changes to the tree as they happen (new, removed nodes)
13 | 1. Display changes to the data of each node
14 | 1. Filter nodes by name
15 | 1. Ignore nodes (and their children)
16 | 1. Watch nodes
17 | 1. Display a node's attached data, also as a hex dump
18 |
19 | ## Building
20 |
21 | git clone the repository and run Maven
22 |
23 | mvn install
24 |
25 | ## Running
26 |
27 | In order for zooterrain to connect to a ZooKeeper, you need to know the address of one
28 | ZooKeeper instance you want to track, which typically looks much like this:
29 |
30 | myzookeeper.mycomp.com:2181
31 |
32 | and then start the application the by running
33 |
34 | java -cp target/zooterrain-full.jar -Dzooterrain.conn=${ZOOKEEPER_HOST_PORT} com.brainlounge.zooterrain.netty.WebSocketServer 8080
35 |
36 | Be sure to always replace ${ZOOKEEPER_HOST_PORT} with your ZooKeeper address.
37 | or simply:
38 |
39 | java -Dzooterrain.conn=${ZOOKEEPER_HOST_PORT} -jar target/zooterrain-full.jar
40 |
41 | ## Connecting from Browser
42 |
43 | Open a browser and navigate to http://localhost:8080/
44 | You can run the server on other ports by changing the last parameter (here: 8080) in the java command line.
45 |
46 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
15 |
17 | 4.0.0
18 |
19 | com.brainlounge.zooterrain
20 | zooterrain-app
21 | jar
22 | 0.0.1-SNAPSHOT
23 |
24 |
25 |
26 | Bernd Fondermann
27 | bernd@brainlounge.de
28 |
29 |
30 |
31 |
32 | 1.7.5
33 | 4.0.14.Beta1
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 | io.netty
42 | netty-all
43 | ${netty.version}
44 |
45 |
46 |
47 | org.apache.zookeeper
48 | zookeeper
49 | 3.4.5
50 |
51 |
52 | com.sun.jmx
53 | jmxri
54 |
55 |
56 | com.sun.jdmk
57 | jmxtools
58 |
59 |
60 | javax.jms
61 | jms
62 |
63 |
64 |
65 |
66 |
67 | com.google.guava
68 | guava
69 | 13.0.1
70 |
71 |
72 |
73 | commons-io
74 | commons-io
75 | 2.0.1
76 |
77 |
78 | commons-codec
79 | commons-codec
80 | 1.4
81 |
82 |
83 | org.apache.commons
84 | commons-lang3
85 | 3.0.1
86 |
87 |
88 |
89 | com.fasterxml.jackson.core
90 | jackson-core
91 | 2.3.0
92 |
93 |
94 |
95 | com.fasterxml.jackson.core
96 | jackson-databind
97 | 2.3.0
98 |
99 |
100 |
101 |
102 | org.slf4j
103 | slf4j-api
104 | ${org.slf4j.version}
105 |
106 |
107 | org.slf4j
108 | slf4j-simple
109 | ${org.slf4j.version}
110 |
111 |
112 |
113 |
114 | junit
115 | junit
116 | 4.7
117 | test
118 |
119 |
120 |
121 |
122 |
123 | org.apache.maven.wagon
124 | wagon-ssh
125 |
126 |
127 |
128 |
129 |
130 | org.apache.maven.plugins
131 | maven-compiler-plugin
132 | 3.1
133 |
134 | 1.6
135 | 1.6
136 |
137 |
138 |
139 | org.apache.maven.plugins
140 | maven-jar-plugin
141 | 2.4
142 |
143 |
144 |
145 | com.brainlounge.zooterrain.Driver
146 |
147 |
148 |
149 |
150 |
151 | org.apache.maven.plugins
152 | maven-dependency-plugin
153 |
154 |
155 | install
156 | install
157 |
158 | sources
159 |
160 |
161 |
162 | install
163 |
164 | copy-dependencies
165 |
166 |
167 | ${project.build.directory}/lib
168 |
169 |
170 |
171 |
172 |
173 |
174 | maven-assembly-plugin
175 | 2.4
176 |
177 |
178 |
179 | com.brainlounge.zooterrain.netty.WebSocketServer
180 |
181 |
182 |
183 | jar-with-dependencies
184 |
185 | zooterrain-full
186 | false
187 |
188 |
189 |
190 | make-assembly
191 | package
192 |
193 | single
194 |
195 |
196 |
197 |
198 |
199 |
200 |
201 |
--------------------------------------------------------------------------------
/src/main/java/com/brainlounge/zooterrain/netty/OutboundConnector.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing, software
13 | * distributed under the License is distributed on an "AS IS" BASIS,
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | * See the License for the specific language governing permissions and
16 | * limitations under the License.
17 | */
18 | package com.brainlounge.zooterrain.netty;
19 |
20 | import com.brainlounge.zooterrain.zkclient.ClientMessage;
21 | import com.brainlounge.zooterrain.zkclient.ZkStateListener;
22 | import io.netty.channel.ChannelHandlerContext;
23 | import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
24 |
25 | /**
26 | */
27 | public class OutboundConnector implements ZkStateListener {
28 | protected ChannelHandlerContext context;
29 |
30 | public OutboundConnector(ChannelHandlerContext context) {
31 | this.context = context;
32 | }
33 |
34 | @Override
35 | public void zkNodeEvent(ClientMessage message) {
36 | try {
37 | context.channel().writeAndFlush(new TextWebSocketFrame(message.toJson()), context.newPromise());
38 | } catch (Throwable e) {
39 | e.printStackTrace(); //To change body of catch statement use File | Settings | File Templates.
40 | }
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/src/main/java/com/brainlounge/zooterrain/netty/WebSocketServer.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2012 The Netty Project
3 | *
4 | * The Netty Project licenses this file to you under the Apache License,
5 | * version 2.0 (the "License"); you may not use this file except in compliance
6 | * with the License. You may obtain a copy of the License at:
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 | * License for the specific language governing permissions and limitations
14 | * under the License.
15 | */
16 | package com.brainlounge.zooterrain.netty;
17 |
18 | import com.brainlounge.zooterrain.zkclient.ZkStateObserver;
19 | import io.netty.bootstrap.ServerBootstrap;
20 | import io.netty.channel.Channel;
21 | import io.netty.channel.EventLoopGroup;
22 | import io.netty.channel.nio.NioEventLoopGroup;
23 | import io.netty.channel.socket.nio.NioServerSocketChannel;
24 |
25 | /**
26 | * A HTTP server which serves Web Socket requests at:
27 | *
28 | * http://localhost:8080/websocket
29 | *
30 | * Open your browser at http://localhost:8080/, then the demo page will be loaded and a Web Socket connection will be
31 | * made automatically.
32 | *
33 | * This server illustrates support for the different web socket specification versions and will work with:
34 | *
35 | *