You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@chukwa.apache.org by ey...@apache.org on 2011/12/11 22:59:17 UTC
svn commit: r1213088 - in /incubator/chukwa/trunk: CHANGES.txt pom.xml
src/site/apt/hicc.apt src/site/resources/images/hicc-dashboard.png
src/site/resources/images/hicc-widget.png src/site/site.xml
Author: eyang
Date: Sun Dec 11 21:59:16 2011
New Revision: 1213088
URL: http://svn.apache.org/viewvc?rev=1213088&view=rev
Log:
CHUKWA-522. Added HICC User guide. (Eric Yang)
Added:
incubator/chukwa/trunk/src/site/apt/hicc.apt
incubator/chukwa/trunk/src/site/resources/images/hicc-dashboard.png (with props)
incubator/chukwa/trunk/src/site/resources/images/hicc-widget.png (with props)
Modified:
incubator/chukwa/trunk/CHANGES.txt
incubator/chukwa/trunk/pom.xml
incubator/chukwa/trunk/src/site/site.xml
Modified: incubator/chukwa/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/incubator/chukwa/trunk/CHANGES.txt?rev=1213088&r1=1213087&r2=1213088&view=diff
==============================================================================
--- incubator/chukwa/trunk/CHANGES.txt (original)
+++ incubator/chukwa/trunk/CHANGES.txt Sun Dec 11 21:59:16 2011
@@ -36,6 +36,8 @@ Trunk (unreleased changes)
IMPROVEMENTS
+ CHUKWA-522. Added HICC User guide. (Eric Yang)
+
CHUKWA-615. Changed HICC default view to monitor Hadoop. (Eric Yang)
CHUKWA-612. Convert Chukwa document from forrest format to apt format. (Eric Yang)
Modified: incubator/chukwa/trunk/pom.xml
URL: http://svn.apache.org/viewvc/incubator/chukwa/trunk/pom.xml?rev=1213088&r1=1213087&r2=1213088&view=diff
==============================================================================
--- incubator/chukwa/trunk/pom.xml (original)
+++ incubator/chukwa/trunk/pom.xml Sun Dec 11 21:59:16 2011
@@ -51,7 +51,7 @@
<TODO_DEMUX_IO_SORT_MB>64</TODO_DEMUX_IO_SORT_MB>
<TODO_DEMUX_FS_INMEMORY_SIZE_MB>64</TODO_DEMUX_FS_INMEMORY_SIZE_MB>
<TODO_DEMUX_IO_SORT_FACTOR>10</TODO_DEMUX_IO_SORT_FACTOR>
- <CHUKWA_DIR>/tmp/chukwa</CHUKWA_DIR>
+ <CHUKWA_DIR>/chukwa</CHUKWA_DIR>
<JAVA_HOME>${java.home}</JAVA_HOME>
</properties>
@@ -595,9 +595,6 @@
<copy file="${basedir}/conf/chukwa-common.xml" tofile="${test.build.dir}/conf/chukwa-common.xml">
<filterchain>
<expandproperties/>
-<!-- <replacetokens>
- <token key="CHUKWA_DIR" value="/tmp/chukwa" />
- </replacetokens> -->
</filterchain>
</copy>
<copy file="${basedir}/conf/chukwa-agent-conf.xml" tofile="${test.build.dir}/conf/chukwa-agent-conf.xml">
Added: incubator/chukwa/trunk/src/site/apt/hicc.apt
URL: http://svn.apache.org/viewvc/incubator/chukwa/trunk/src/site/apt/hicc.apt?rev=1213088&view=auto
==============================================================================
--- incubator/chukwa/trunk/src/site/apt/hicc.apt (added)
+++ incubator/chukwa/trunk/src/site/apt/hicc.apt Sun Dec 11 21:59:16 2011
@@ -0,0 +1,149 @@
+~~ Licensed to the Apache Software Foundation (ASF) under one or more
+~~ contributor license agreements. See the NOTICE file distributed with
+~~ this work for additional information regarding copyright ownership.
+~~ The ASF licenses this file to You under the Apache License, Version 2.0
+~~ (the "License"); you may not use this file except in compliance with
+~~ the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ 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.
+~~
+
+Overview
+
+ HICC stands for Hadoop Infrastructure Care Center. It is the central dashboard
+for visualize and monitoring of metrics collected by Chukwa.
+
+How HICC is organized
+
+ To get started with HICC, you should get to know the menus and tools of the
+dashboard, and learn how widgets and information are organized.
+
+* Dashboard
+
+ When you login to HICC, the dashboard appears. You'll see a menu bar along
+the top of the browser window, and widgets in rows and columns. In between
+the menu bar and the widgets is the tabs. In the upper right corner of dashboard
+are the icons for HICC global options.
+
+[./images/hicc-dashboard.png]
+
+* How widgets are organized
+
+ HICC organizes widgets in Widgets Catalog where information are organized in
+a tree structure. Some of the categories are described below.
+
+[./images/hicc-widget.png]
+
+ * <<Developer>> A list of utility widgets for exploring metrics stored on HBase
+ and debugging tools to help developer to develope new widgets.
+
+ * <<Global>> A list of utility widgets for user to control time, cluster, or
+ host selection.
+
+ * <<Hadoop>> Hadoop related metrics and job summary are organized in this
+ category.
+
+ * <<System Metrics>> System related metrics such as cpu, disk, network or
+ memory utilization are organized in this category.
+
+* Navigating HICC
+
+ The items stored on HICC -- including applications, utilities and widgets --
+are organized in a hierarchy of widget category that you can browse by accessing
+menu bar "Options". The dashboard has columns and rows and you can rearrange
+the layout of the widgets by drag and drop. Rearranging widgets on the dashboard
+is only saved when "Save Dashboard" is click.
+
+Menu, tabs and dashboards
+
+* Menu basics
+
+ Menus contain options that perform actions. For example, to create an extra
+column on the dashboard, you choose the add column command from the Options
+menu (Options > Add Column).
+
+** Opening menus:
+
+ * To open a menu in the menu bar across the top of the dashboard, hover over
+the menu item.
+
+ * Many menu item is also a toggle. For example, choose Dashboard Builder will
+open the view for a list of available dashboards. Choose Dashboard Builder a
+second time will close Dashboard list view.
+
+** Choosing menu options:
+
+ Click the option you want to use.
+
+ * If the option has an ellipsis (...) next to it, a dialog opens where you can
+make additional choices or provide any necessary information.
+
+ * If an option is dimmed, it is not available. For example, you can not edit
+name of the dashboard, if you are not the owner of the dashboard.
+
+* Tab basics
+
+ Tab provides a way to organize related information together. As you create widgets,
+manange cluster and do other work on HICC, you can create new tabs to keep your
+information organized.
+
+ * To create a new tab:
+
+ [[1]] Select "Add New Tab" from menu bar (Options > Add New Tab).
+
+ [[2]] Enter a new name for the tab and press Return.
+
+ []
+
+ * To remove a tab:
+
+ [[1]] Select the tab that you wish to delete.
+
+ [[2]] Select delete current tab from menu bar (Options > Delete Current Tab).
+
+ []
+
+ * To rename a tab:
+
+ [[1]] Double click on the tab to change tab to edit mode.
+
+ [[2]] Enter a new name for the tab and press Return.
+
+* Dashboard basics
+
+ Each dashboard can have multiple tabs and each tab is divided into row and columns.
+You can add more widgets by selecting Options > choose a widget > click Add.
+To remove a widgets by clicking on Close button on the top right hand corner of
+the widget.
+
+User accounts
+
+ You should set up an account for each person who uses HICC on a regular basis.
+
+* Create a new user account
+
+ [[1]] Edit CHUKWA_CONF_DIR/auth.conf
+
+ [[2]] Authentication and authorization information is stored in a properties file.
+Eacho line in the file contains a username, a password and 0 or more role assignment.
+The format is:
+
+---
+username: password[,rolename ...]
+---
+
+* What is an administrator account?
+
+ Administrator account has privileges to modify all dashboard layout and change
+read/write permission of the dashboards.
+
+* What is a user account?
+
+ User account has privileges to modify user's own dashboard layout and change
+read/write permission of his/her own dashboard.
Added: incubator/chukwa/trunk/src/site/resources/images/hicc-dashboard.png
URL: http://svn.apache.org/viewvc/incubator/chukwa/trunk/src/site/resources/images/hicc-dashboard.png?rev=1213088&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/chukwa/trunk/src/site/resources/images/hicc-dashboard.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/chukwa/trunk/src/site/resources/images/hicc-widget.png
URL: http://svn.apache.org/viewvc/incubator/chukwa/trunk/src/site/resources/images/hicc-widget.png?rev=1213088&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/chukwa/trunk/src/site/resources/images/hicc-widget.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/chukwa/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/chukwa/trunk/src/site/site.xml?rev=1213088&r1=1213087&r2=1213088&view=diff
==============================================================================
--- incubator/chukwa/trunk/src/site/site.xml (original)
+++ incubator/chukwa/trunk/src/site/site.xml Sun Dec 11 21:59:16 2011
@@ -47,6 +47,7 @@
<menu name="Chukwa 0.5">
<item name="Overview" href="index.html"/>
<item name="Quick Start Guide" href="Quick_Start_Guide.html"/>
+ <item name="HICC User Guide" href="hicc.html"/>
<item name="Configuration" href="admin.html">
<item name="Agent" href="agent.html"/>
<item name="Collector" href="collector.html"/>