org.apache.giraph.utils

Class MasterLoggingAggregator

java.lang.Object

org.apache.giraph.utils.MasterLoggingAggregator

public class MasterLoggingAggregator
extends Object

Helper class for using aggregator which gathers log messages from workers and prints them on master. If you want to track what's going on in your application, and want to have all those logs accessible in a single place in the end of each superstep, you can use option from this class. If you use a lot of log messages this might slow down your application, but it can easily be turned on/off without changing your code just by switching the option.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MASTER_LOGGING_AGGREGATOR_NAME Name of aggregator which will be gathering the logs
static String	USE_MASTER_LOGGING_AGGREGATOR Whether or not to use master logging aggregator
static boolean	USE_MASTER_LOGGING_AGGREGATOR_DEFAULT Default is not using master logging aggregator

Method Summary

Modifier and Type	Method and Description
static void	aggregate(String message, WorkerAggregatorUsage workerAggregatorUsage, org.apache.hadoop.conf.Configuration conf) Aggregate some message to master logging aggregator, if the option for using it is set in the configuration.
static void	logAggregatedValue(MasterAggregatorUsage masterAggregatorUsage, org.apache.hadoop.conf.Configuration conf) Print value of master logging aggregator on the master log, if the option for using it is set in the configuration.
static void	registerAggregator(MasterAggregatorUsage masterAggregatorUsage, org.apache.hadoop.conf.Configuration conf) Register master logging aggregator, if the option for using it is set in the configuration.
static void	setUseMasterLoggingAggregator(boolean useMasterLoggingAggregator, org.apache.hadoop.conf.Configuration conf) Set whether or not master logging aggregator should be used
static boolean	useMasterLoggingAggregator(org.apache.hadoop.conf.Configuration conf) Check if master logging aggregator is used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USE_MASTER_LOGGING_AGGREGATOR

public static final String USE_MASTER_LOGGING_AGGREGATOR

Whether or not to use master logging aggregator

See Also:

Constant Field Values

USE_MASTER_LOGGING_AGGREGATOR_DEFAULT

public static final boolean USE_MASTER_LOGGING_AGGREGATOR_DEFAULT

Default is not using master logging aggregator

See Also:

Constant Field Values

MASTER_LOGGING_AGGREGATOR_NAME

public static final String MASTER_LOGGING_AGGREGATOR_NAME

Name of aggregator which will be gathering the logs

See Also:

Constant Field Values

Method Detail

useMasterLoggingAggregator

public static boolean useMasterLoggingAggregator(org.apache.hadoop.conf.Configuration conf)

Check if master logging aggregator is used.

Parameters:

conf - Configuration

Returns:

True iff master logging aggregator is used

setUseMasterLoggingAggregator

public static void setUseMasterLoggingAggregator(boolean useMasterLoggingAggregator,
                                                 org.apache.hadoop.conf.Configuration conf)

Set whether or not master logging aggregator should be used

Parameters:

useMasterLoggingAggregator - Whether or not we want master logging aggregator to be used

conf - Configuration

aggregate

public static void aggregate(String message,
                             WorkerAggregatorUsage workerAggregatorUsage,
                             org.apache.hadoop.conf.Configuration conf)

Aggregate some message to master logging aggregator, if the option for using it is set in the configuration. This is the method application implementation should use in order to add message to the aggregator.

Parameters:

message - Message to log

workerAggregatorUsage - Worker aggregator usage (can be Vertex, WorkerContext, etc)

conf - Configuration

registerAggregator

public static void registerAggregator(MasterAggregatorUsage masterAggregatorUsage,
                                      org.apache.hadoop.conf.Configuration conf)

Register master logging aggregator, if the option for using it is set in the configuration. This method will be called by Giraph infrastructure on master.

Parameters:

masterAggregatorUsage - Master aggregator usage

conf - Configuration

logAggregatedValue

public static void logAggregatedValue(MasterAggregatorUsage masterAggregatorUsage,
                                      org.apache.hadoop.conf.Configuration conf)

Print value of master logging aggregator on the master log, if the option for using it is set in the configuration. This method will be called by Giraph infrastructure on master.

Parameters:

masterAggregatorUsage - Master aggregator usage

conf - Configuration