chukwa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ey...@apache.org
Subject svn commit: r765724 - in /hadoop/chukwa: branches/chukwa-0.1/conf/README trunk/conf/README
Date Thu, 16 Apr 2009 19:22:22 GMT
Author: eyang
Date: Thu Apr 16 19:22:22 2009
New Revision: 765724

URL: http://svn.apache.org/viewvc?rev=765724&view=rev
Log:
CHUKWA-112.  Updated README file.  (Corinne Chandel via Eric Yang)

Modified:
    hadoop/chukwa/branches/chukwa-0.1/conf/README
    hadoop/chukwa/trunk/conf/README

Modified: hadoop/chukwa/branches/chukwa-0.1/conf/README
URL: http://svn.apache.org/viewvc/hadoop/chukwa/branches/chukwa-0.1/conf/README?rev=765724&r1=765723&r2=765724&view=diff
==============================================================================
--- hadoop/chukwa/branches/chukwa-0.1/conf/README (original)
+++ hadoop/chukwa/branches/chukwa-0.1/conf/README Thu Apr 16 19:22:22 2009
@@ -1,18 +1,122 @@
-Check for an updated copy of this README at http://wiki.apache.org/hadoop/Chukwa_Configuration
-
-Chukwa comes with templates for all configuration files. These files are in the conf directory
and are named <conf file name>.template. You should be able to just make a copy of each
of these files, removing the ".template" suffix.
-
-'''Required configuration files'''
-
- * conf/collectors - new line delimited list of collectors. This file is used by startup
and shutdown scripts to determine where to run Chukwa  
- * collectors and is also used by Chukwa agents to find collectors to send their data to.
- * conf/chukwa-agents - a list of hosts in the cluster on which to run the Chukwa agent daemon.
- * conf/chukwa-env.sh - environment variables required to run Chukwa.
- * conf/chukwa-collectors-conf.xml - collector specific settings (e.g. port number to listen
for agents on, which file system to store data in, etc.)
- * conf/chukwa-agents-conf.xml - agent specific settings.
-
-'''Optional configuration files'''
-
- * conf/alert.conf - a list of e-mail addresses to which chukwa alerts should be sent.
- * conf/initial_adaptors - a list of adaptors to add to all agents at startup time.
-
+================================================================================
+README
+================================================================================
+
+Chukwa includes configuration files for components installed on:
+
+> The Chukwa hadoop cluster (CC) 
+> The monitored source nodes (SN) 
+> The monitored source nodes set up as a hadoop cluster (SN-C)
+
+To modify a configuration file, copy, rename, and edit the *.template file.
+For example:
+> Copy chukwa-collector-conf.xml.template to a file named 
+  chukwa-collector-conf.xml
+> Edit chukwa-collector-conf.xml to include the cluster/group name for the 
+  source nodes
+
+See the Chukwa Administration Guide for more information.
+
+================================================================================
+Configuration File (CC)
+================================================================================
+alert.template  
+> Modify? yes, optional    
+> The email address for Chukwa alerts.
+--------------------------------------------
+chukwa-collector-conf.xml.template 
+> Modify? yes   
+> The name node address, used by collectors to write data to HDFS 
+> (eg: write.hdf.filesystem = hdfs://localhost:9000/)
+--------------------------------------------
+jdbc.conf.template
+> Modify? yes, optional      			
+> URL for the MySQL database 
+> eg: jdbc:mysql://localhost:3306?user-root
+---------------------------------------------
+nagios.properties.template
+> Modify? yes, optional   	
+> Nagio server that receives NSCA alert 
+> eg: log4j.appender.NAGIOS.Host=nagios.example.com
+--------------------------------------------
+aggregator.sql
+> Modify? no 
+> SQL load scripts.
+--------------------------------------------
+chukwa-demux-conf.xml
+> Modify? no (When available, check the Programmers Guide for more info)		
+> Chukwa demux settings 
+--------------------------------------------
+chukwa-log4j.properties
+> Modify? no			
+> Logging for Chukwa cluster (Data Processor nodes).
+--------------------------------------------
+commons-logging.properties
+> Modify? no			
+> Internal log properties.
+--------------------------------------------
+database_create_tables.sql	
+> Modify? no				
+> SQL load scripts.
+--------------------------------------------
+log4j.properties
+> Modify? no (When available, check the Programmers Guide for more info)	
+> Logging for streaming, bundle with your streaming program. 
+--------------------------------------------
+mdl.xml
+> Modify? no (When available, check the Programmers Guide for more info)			
+> Chukwa metrics data loader (MDL) settings. 
+
+
+================================================================================
+Configuration File (CC, SN)
+================================================================================
+chukwa-env.sh.template
+> Modify? yes			
+> Environment variables.
+
+
+================================================================================
+Configuration File (SN)
+================================================================================
+agents.template
+> Modify? yes				
+> A list of hosts running the Chukwa agent.
+--------------------------------------------
+chukwa-agent-conf.xml.template
+> Modify? yes				
+> The cluster/group name for the source nodes 
+> eg: chukwaAgent.tags, cluster="xyz"
+--------------------------------------------
+collectors.template
+> Modify? yes				
+> A list of hosts running the Chukwa collector 
+> eg: http://locahost:8080/
+--------------------------------------------
+initial_adaptors.template
+> Modify? yes, optional (When available,check the Programmers Guide for 
+  more info)		
+> A list of adaptors. 
+--------------------------------------------
+system-data-loader.properties
+> Modify? no					
+> Metrics for streaming.
+
+
+================================================================================
+Configuration File (CC, SN-C)
+================================================================================
+hadoop-log4j.properties			
+> Modify? no
+> Logging for Chukwa cluster (Name Node, Task Tracker, Job Tracker nodes).  
+> Logging for source nodes, if set up as a Hadoop cluster (same as above).
+--------------------------------------------
+hadoop-metrics-log4j.properties
+> Modify? no
+> Metrics logging for Chukwa cluster.	
+> Metrics logging for source nodes, if set up as a Hadoop cluster.
+--------------------------------------------
+hadoop-metrics.properties
+> Modify? no	
+> Sample metrics for Chukwa cluster.  
+> Sample metrics for source nodes, if set up as a Hadoop cluster.
\ No newline at end of file

Modified: hadoop/chukwa/trunk/conf/README
URL: http://svn.apache.org/viewvc/hadoop/chukwa/trunk/conf/README?rev=765724&r1=765723&r2=765724&view=diff
==============================================================================
--- hadoop/chukwa/trunk/conf/README (original)
+++ hadoop/chukwa/trunk/conf/README Thu Apr 16 19:22:22 2009
@@ -1,18 +1,122 @@
-Check for an updated copy of this README at http://wiki.apache.org/hadoop/Chukwa_Configuration
-
-Chukwa comes with templates for all configuration files. These files are in the conf directory
and are named <conf file name>.template. You should be able to just make a copy of each
of these files, removing the ".template" suffix.
-
-'''Required configuration files'''
-
- * conf/collectors - new line delimited list of collectors. This file is used by startup
and shutdown scripts to determine where to run Chukwa  
- * collectors and is also used by Chukwa agents to find collectors to send their data to.
- * conf/chukwa-agents - a list of hosts in the cluster on which to run the Chukwa agent daemon.
- * conf/chukwa-env.sh - environment variables required to run Chukwa.
- * conf/chukwa-collectors-conf.xml - collector specific settings (e.g. port number to listen
for agents on, which file system to store data in, etc.)
- * conf/chukwa-agents-conf.xml - agent specific settings.
-
-'''Optional configuration files'''
-
- * conf/alert.conf - a list of e-mail addresses to which chukwa alerts should be sent.
- * conf/initial_adaptors - a list of adaptors to add to all agents at startup time.
-
+================================================================================
+README
+================================================================================
+
+Chukwa includes configuration files for components installed on:
+
+> The Chukwa hadoop cluster (CC) 
+> The monitored source nodes (SN) 
+> The monitored source nodes set up as a hadoop cluster (SN-C)
+
+To modify a configuration file, copy, rename, and edit the *.template file.
+For example:
+> Copy chukwa-collector-conf.xml.template to a file named 
+  chukwa-collector-conf.xml
+> Edit chukwa-collector-conf.xml to include the cluster/group name for the 
+  source nodes
+
+See the Chukwa Administration Guide for more information.
+
+================================================================================
+Configuration File (CC)
+================================================================================
+alert.template  
+> Modify? yes, optional    
+> The email address for Chukwa alerts.
+--------------------------------------------
+chukwa-collector-conf.xml.template 
+> Modify? yes   
+> The name node address, used by collectors to write data to HDFS 
+> (eg: write.hdf.filesystem = hdfs://localhost:9000/)
+--------------------------------------------
+jdbc.conf.template
+> Modify? yes, optional      			
+> URL for the MySQL database 
+> eg: jdbc:mysql://localhost:3306?user-root
+---------------------------------------------
+nagios.properties.template
+> Modify? yes, optional   	
+> Nagio server that receives NSCA alert 
+> eg: log4j.appender.NAGIOS.Host=nagios.example.com
+--------------------------------------------
+aggregator.sql
+> Modify? no 
+> SQL load scripts.
+--------------------------------------------
+chukwa-demux-conf.xml
+> Modify? no (When available, check the Programmers Guide for more info)		
+> Chukwa demux settings 
+--------------------------------------------
+chukwa-log4j.properties
+> Modify? no			
+> Logging for Chukwa cluster (Data Processor nodes).
+--------------------------------------------
+commons-logging.properties
+> Modify? no			
+> Internal log properties.
+--------------------------------------------
+database_create_tables.sql	
+> Modify? no				
+> SQL load scripts.
+--------------------------------------------
+log4j.properties
+> Modify? no (When available, check the Programmers Guide for more info)	
+> Logging for streaming, bundle with your streaming program. 
+--------------------------------------------
+mdl.xml
+> Modify? no (When available, check the Programmers Guide for more info)			
+> Chukwa metrics data loader (MDL) settings. 
+
+
+================================================================================
+Configuration File (CC, SN)
+================================================================================
+chukwa-env.sh.template
+> Modify? yes			
+> Environment variables.
+
+
+================================================================================
+Configuration File (SN)
+================================================================================
+agents.template
+> Modify? yes				
+> A list of hosts running the Chukwa agent.
+--------------------------------------------
+chukwa-agent-conf.xml.template
+> Modify? yes				
+> The cluster/group name for the source nodes 
+> eg: chukwaAgent.tags, cluster="xyz"
+--------------------------------------------
+collectors.template
+> Modify? yes				
+> A list of hosts running the Chukwa collector 
+> eg: http://locahost:8080/
+--------------------------------------------
+initial_adaptors.template
+> Modify? yes, optional (When available,check the Programmers Guide for 
+  more info)		
+> A list of adaptors. 
+--------------------------------------------
+system-data-loader.properties
+> Modify? no					
+> Metrics for streaming.
+
+
+================================================================================
+Configuration File (CC, SN-C)
+================================================================================
+hadoop-log4j.properties			
+> Modify? no
+> Logging for Chukwa cluster (Name Node, Task Tracker, Job Tracker nodes).  
+> Logging for source nodes, if set up as a Hadoop cluster (same as above).
+--------------------------------------------
+hadoop-metrics-log4j.properties
+> Modify? no
+> Metrics logging for Chukwa cluster.	
+> Metrics logging for source nodes, if set up as a Hadoop cluster.
+--------------------------------------------
+hadoop-metrics.properties
+> Modify? no	
+> Sample metrics for Chukwa cluster.  
+> Sample metrics for source nodes, if set up as a Hadoop cluster.
\ No newline at end of file



Mime
View raw message