@InterfaceAudience.Private
 @InterfaceStability.Unstable
public abstract class TimelineCollector
extends org.apache.hadoop.service.CompositeService
| Modifier and Type | Class and Description | 
|---|---|
| protected static class  | TimelineCollector.AggregationStatusTable | 
| Constructor and Description | 
|---|
| TimelineCollector(String name) | 
| Modifier and Type | Method and Description | 
|---|---|
| static org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity | aggregateEntities(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities,
                 String resultEntityId,
                 String resultEntityType,
                 boolean needsGroupIdInResult)Aggregate all metrics in given timeline entities with no predefined states. | 
| protected Map<String,TimelineCollector.AggregationStatusTable> | getAggregationGroups() | 
| protected Set<String> | getEntityTypesSkipAggregation()Method to decide the set of timeline entity types the collector should
 skip on aggregations. | 
| abstract TimelineCollectorContext | getTimelineEntityContext() | 
| protected boolean | isReadyToAggregate() | 
| org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse | putDomain(org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain domain,
         org.apache.hadoop.security.UserGroupInformation callerUgi)Add or update an domain. | 
| org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse | putEntities(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities,
           org.apache.hadoop.security.UserGroupInformation callerUgi)Handles entity writes. | 
| void | putEntitiesAsync(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities,
                org.apache.hadoop.security.UserGroupInformation callerUgi)Handles entity writes in an asynchronous manner. | 
| protected void | serviceInit(org.apache.hadoop.conf.Configuration conf) | 
| protected void | serviceStart() | 
| protected void | serviceStop() | 
| protected void | setReadyToAggregate() | 
| protected void | setWriter(TimelineWriter w) | 
addIfService, addService, getServices, removeServiceclose, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStoppublic static final String SEPARATOR
public TimelineCollector(String name)
protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws Exception
serviceInit in class org.apache.hadoop.service.CompositeServiceExceptionprotected void serviceStart()
                     throws Exception
serviceStart in class org.apache.hadoop.service.CompositeServiceExceptionprotected void serviceStop()
                    throws Exception
serviceStop in class org.apache.hadoop.service.CompositeServiceExceptionprotected void setWriter(TimelineWriter w)
protected Map<String,TimelineCollector.AggregationStatusTable> getAggregationGroups()
protected void setReadyToAggregate()
protected boolean isReadyToAggregate()
protected Set<String> getEntityTypesSkipAggregation()
public abstract TimelineCollectorContext getTimelineEntityContext()
public org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse putEntities(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities,
                                                                                            org.apache.hadoop.security.UserGroupInformation callerUgi)
                                                                                     throws IOException
putEntitiesAsync(TimelineEntities, UserGroupInformation).entities - entities to postcallerUgi - the caller UGIIOException - if there is any exception encountered while putting
     entities.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse putDomain(org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain domain,
                                                                                          org.apache.hadoop.security.UserGroupInformation callerUgi)
                                                                                   throws IOException
domain - domain to postcallerUgi - the caller UGIIOException - if there is any exception encountered while putting
                     domain.public void putEntitiesAsync(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities,
                             org.apache.hadoop.security.UserGroupInformation callerUgi)
                      throws IOException
entities - entities to postcallerUgi - the caller UGIIOException - if there is any exception encounted while putting
     entities.public static org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity aggregateEntities(org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities entities,
                                                                                                  String resultEntityId,
                                                                                                  String resultEntityType,
                                                                                                  boolean needsGroupIdInResult)
entities - Entities to aggregateresultEntityId - Id of the result entityresultEntityType - Type of the result entityneedsGroupIdInResult - Marks if we want the aggregation group id in
                             each aggregated metrics.Copyright © 2008–2023 Apache Software Foundation. All rights reserved.