Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
CHUKWA-406. Improve readme, add material to license and notices files.
git-svn-id: https://svn.apache.org/repos/asf/hadoop/chukwa/trunk@829959 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
Ariel Shemaiah Rabkin committed Oct 26, 2009
1 parent c29545d commit 7f376d63163b71160cdf0deda6be2ca236f23f34
Show file tree
Hide file tree
Showing 5 changed files with 141 additions and 13 deletions.
@@ -200,3 +200,89 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.




APPENDIX II: Licenses for Incorporated Works.



Script.aculo.us
Copyright © 2005-2008 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
“Software”), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

--------
YUI
Copyright Yahoo inc, 2009
Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------
IUI
Copyright (c) 2007-2009, iUI Project Members

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the iUI Project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-------
jChronic

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

@@ -4,25 +4,28 @@ Copyright 2009 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

Chukwa incorporates a number of components, not copyright by the Apache
Foundation, and under permissive licenses.

While Chukwa is licensed to you under the Apache license, a number of components and dependencies
are governed by other licenses.
Script.aculo.us is Copyright © 2005-2008 Thomas Fuchs, under a BSD License
* http://script.aculo.us/

JUnit is under the Common Public License - v 1.0
* Available from http://junit.sourceforge.net/
YUI is copyright 2009 by Yahoo, Inc, and distributed under a BSD license.
* Available from http://developer.yahoo.com/yui/

HTMLFilter was written by Joseph O'Connell and is licensed under a Creative Commons Attribution-ShareAlike 2.5 License
* Available from http://josephoconnell.com/java/xss-html-filter/
The Prototype AJAX library is freely redistributable.
* http://www.prototypejs.org/

The NagiosAppender library was written by Jar Lyons and is under the Apache License, version 2.0
* Available from http://sourceforge.net/projects/nagiosappender/

Prefuse is under BSD License
Prefuse is under BSD License.
* Available from http://prefuse.org/.

iUI is under a BSD license, with media portions under a Creative Commons Attribution-Share Alike 3.0 License.
iUI is under a BSD license, with media portions under a Creative Commons Attribution-Share Alike 3.0 License.
Copyright is held by its developers.
* Available from http://code.google.com/p/iui/

JChronic is under an MIT license.
JChronic is under an MIT license, copyright is held by the developers.
* Available from https://jchronic.dev.java.net/

@@ -1,3 +1,40 @@
This is the first formal release of Chukwa, an Apache Hadoop subproject dedicated to scalable log collection and processing. If you have large volumes of log data generated across a cluster, and you need to process them with MapReduce, Chukwa may be the tool for you.
Chukwa 0.3 -- November 2009

This is the first formal release of Chukwa, an Apache Hadoop subproject
dedicated to scalable log collection and processing. If you have large
volumes of log data generated across a cluster, and you need to process
them with MapReduce, Chukwa may be the tool for you.

The notes for this release are in docs/releasenotes.html

BUILDING CHUKWA

To build chukwa from source:
In the Chukwa root directory, say 'ant', and then 'cp build/*.jar build/*.war .'

To check that things are ok, run 'ant test'. It should take roughly fifteen minutes.

RUNNING CHUKWA

If you are unfamiliar with Chukwa, you should start by reading the design
overview, in docs/design.html. This will tell you what each piece of Chukwa
does.

If you're impatient, the following is the 30-second explanation:

The minimum you need to run Chukwa are agents on each machine you're
monitoring, and a collector to write the collected data to HDFS. The
basic command to start an agent is bin/agent.sh. The base command to
start a collector is bin/jettyCollector.sh.

If you want to start a bunch of agents, you can use the
bin/start-agents.sh script. This just uses ssh to start agents on a
list of machines, given in conf/agents. It's exactly parallel to
Hadoop's start-hdfs and start-mapred scripts. There's also a
bin/start-collectors.sh that does the same to start collectors, on
machines listed in conf/collectors. One hostname per line.

There are stop scripts that do the exact opposite of the start commands.

Full installation instructions are in docs/admin.html.

Installation instruction are in docs/admin.html. The release notes are in docs/releasenotes.html
@@ -27,6 +27,8 @@ <h3>Overall status</h3>

HICC, the visualization component, is "beta" quality. It's been used succesfully at multiple sites, but it's still brittle. Work is ongoing. Documentation is still sparse, and error reporting isn't always sufficiently clear.

Chukwa has not been extensively audited for security vulnerabilities. Do not run it except in trusted environments. Never run Chukwa as root: By default, the ExecAdaptor allows arbitrary remote execution.

<h3>Requirements</h3>
Chukwa relies on Java 1.6
The back-end processing requires Hadoop 0.18+.
@@ -58,7 +58,7 @@
<code>chukwaCollector.writerClass</code> specifies a Java class to instantiate
and use as a writer. See the <code>ChukwaWriter</code> javadoc for details.
</p> <p>
One particularly useful Writer class is <code>PipelineWriter</code>, which
One particularly useful Writer class is <code>PipelineStageWriter</code>, which
lets you string together a series of <code>PipelineableWriters</code>
for pre-processing or post-processing incoming data.
As an example, the SocketTeeWriter class allows other programs to get incoming chunks
@@ -124,4 +124,4 @@ while(true) {

</section>
</body>
</document>
</document>

0 comments on commit 7f376d6

Please sign in to comment.