Package org.apache.hadoop.yarn.server.timeline

Class EntityGroupFSTimelineStore

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.CompositeService

org.apache.hadoop.yarn.server.timeline.EntityGroupFSTimelineStore

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.service.Service, org.apache.hadoop.yarn.server.timeline.TimelineReader, org.apache.hadoop.yarn.server.timeline.TimelineStore, org.apache.hadoop.yarn.server.timeline.TimelineWriter

public class EntityGroupFSTimelineStore
extends org.apache.hadoop.service.CompositeService
implements org.apache.hadoop.yarn.server.timeline.TimelineStore

Plugin timeline storage to support timeline server v1.5 API. This storage uses a file system to store timeline entities in their groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntityGroupFSTimelineStore.AppState	Application states,

Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService

org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Nested classes/interfaces inherited from interface org.apache.hadoop.yarn.server.timeline.TimelineReader

org.apache.hadoop.yarn.server.timeline.TimelineReader.Field

Nested classes/interfaces inherited from interface org.apache.hadoop.yarn.server.timeline.TimelineStore

org.apache.hadoop.yarn.server.timeline.TimelineStore.SystemFilter

Field Summary

Fields inherited from class org.apache.hadoop.service.CompositeService

STOP_ONLY_STARTED_SERVICES

Fields inherited from interface org.apache.hadoop.yarn.server.timeline.TimelineReader

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor	Description
EntityGroupFSTimelineStore()

Method Summary

Modifier and Type	Method	Description
protected org.apache.hadoop.yarn.client.api.YarnClient	createAndInitYarnClient(org.apache.hadoop.conf.Configuration conf)	Create and initialize the YARN Client.
protected EntityGroupFSTimelineStore.AppState	getAppState(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Get the application state.
org.apache.hadoop.yarn.api.records.timeline.TimelineDomain	getDomain(java.lang.String domainId)
org.apache.hadoop.yarn.api.records.timeline.TimelineDomains	getDomains(java.lang.String owner)
org.apache.hadoop.yarn.api.records.timeline.TimelineEntities	getEntities(java.lang.String entityType, java.lang.Long limit, java.lang.Long windowStart, java.lang.Long windowEnd, java.lang.String fromId, java.lang.Long fromTs, org.apache.hadoop.yarn.server.timeline.NameValuePair primaryFilter, java.util.Collection<org.apache.hadoop.yarn.server.timeline.NameValuePair> secondaryFilters, java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field> fieldsToRetrieve, org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl checkAcl)
org.apache.hadoop.yarn.api.records.timeline.TimelineEntity	getEntity(java.lang.String entityId, java.lang.String entityType, java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field> fieldsToRetrieve)
org.apache.hadoop.yarn.api.records.timeline.TimelineEvents	getEntityTimelines(java.lang.String entityType, java.util.SortedSet<java.lang.String> entityIds, java.lang.Long limit, java.lang.Long windowStart, java.lang.Long windowEnd, java.util.Set<java.lang.String> eventTypes)
protected java.util.List<org.apache.hadoop.yarn.server.timeline.TimelineStore>	getTimelineStoresForRead(java.lang.String entityId, java.lang.String entityType, java.util.List<EntityCacheItem> cacheItems)
void	put(org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain)
org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse	put(org.apache.hadoop.yarn.api.records.timeline.TimelineEntities data)
protected void	serviceInit(org.apache.hadoop.conf.Configuration conf)
protected void	serviceStart()
protected void	serviceStop()

Methods inherited from class org.apache.hadoop.service.CompositeService

addIfService, addService, getServices, removeService

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Constructor Detail

EntityGroupFSTimelineStore

public EntityGroupFSTimelineStore()

Method Detail

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws java.lang.Exception

Overrides:

serviceInit in class org.apache.hadoop.service.CompositeService

Throws:

java.lang.Exception

serviceStart

protected void serviceStart()
                     throws java.lang.Exception

Overrides:

serviceStart in class org.apache.hadoop.service.CompositeService

Throws:

java.lang.Exception

serviceStop

protected void serviceStop()
                    throws java.lang.Exception

Overrides:

serviceStop in class org.apache.hadoop.service.CompositeService

Throws:

java.lang.Exception

createAndInitYarnClient

@VisibleForTesting
protected org.apache.hadoop.yarn.client.api.YarnClient createAndInitYarnClient(org.apache.hadoop.conf.Configuration conf)

Create and initialize the YARN Client. Tests may override/mock this. If they return null, then getAppState(ApplicationId) MUST also be overridden

Parameters:

conf - configuration

Returns:

the yarn client, or null.

getAppState

@VisibleForTesting
protected EntityGroupFSTimelineStore.AppState getAppState(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                   throws java.io.IOException

Get the application state.

Parameters:

appId - application ID

Returns:

the state or EntityGroupFSTimelineStore.AppState.UNKNOWN if it could not be determined

Throws:

java.io.IOException - on IO problems

getTimelineStoresForRead

protected java.util.List<org.apache.hadoop.yarn.server.timeline.TimelineStore> getTimelineStoresForRead(java.lang.String entityId,
                                                                                                        java.lang.String entityType,
                                                                                                        java.util.List<EntityCacheItem> cacheItems)
                                                                                                 throws java.io.IOException

Throws:

java.io.IOException

getEntities

public org.apache.hadoop.yarn.api.records.timeline.TimelineEntities getEntities(java.lang.String entityType,
                                                                                java.lang.Long limit,
                                                                                java.lang.Long windowStart,
                                                                                java.lang.Long windowEnd,
                                                                                java.lang.String fromId,
                                                                                java.lang.Long fromTs,
                                                                                org.apache.hadoop.yarn.server.timeline.NameValuePair primaryFilter,
                                                                                java.util.Collection<org.apache.hadoop.yarn.server.timeline.NameValuePair> secondaryFilters,
                                                                                java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field> fieldsToRetrieve,
                                                                                org.apache.hadoop.yarn.server.timeline.TimelineDataManager.CheckAcl checkAcl)
                                                                         throws java.io.IOException

Specified by:

getEntities in interface org.apache.hadoop.yarn.server.timeline.TimelineReader

Throws:

java.io.IOException

getEntity

public org.apache.hadoop.yarn.api.records.timeline.TimelineEntity getEntity(java.lang.String entityId,
                                                                            java.lang.String entityType,
                                                                            java.util.EnumSet<org.apache.hadoop.yarn.server.timeline.TimelineReader.Field> fieldsToRetrieve)
                                                                     throws java.io.IOException

Specified by:

getEntity in interface org.apache.hadoop.yarn.server.timeline.TimelineReader

Throws:

java.io.IOException

getEntityTimelines

public org.apache.hadoop.yarn.api.records.timeline.TimelineEvents getEntityTimelines(java.lang.String entityType,
                                                                                     java.util.SortedSet<java.lang.String> entityIds,
                                                                                     java.lang.Long limit,
                                                                                     java.lang.Long windowStart,
                                                                                     java.lang.Long windowEnd,
                                                                                     java.util.Set<java.lang.String> eventTypes)
                                                                              throws java.io.IOException

Specified by:

getEntityTimelines in interface org.apache.hadoop.yarn.server.timeline.TimelineReader

Throws:

java.io.IOException

getDomain

public org.apache.hadoop.yarn.api.records.timeline.TimelineDomain getDomain(java.lang.String domainId)
                                                                     throws java.io.IOException

Specified by:

getDomain in interface org.apache.hadoop.yarn.server.timeline.TimelineReader

Throws:

java.io.IOException

getDomains

public org.apache.hadoop.yarn.api.records.timeline.TimelineDomains getDomains(java.lang.String owner)
                                                                       throws java.io.IOException

Specified by:

getDomains in interface org.apache.hadoop.yarn.server.timeline.TimelineReader

Throws:

java.io.IOException

put

public org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse put(org.apache.hadoop.yarn.api.records.timeline.TimelineEntities data)
                                                                    throws java.io.IOException

Specified by:

put in interface org.apache.hadoop.yarn.server.timeline.TimelineWriter

Throws:

java.io.IOException

put

public void put(org.apache.hadoop.yarn.api.records.timeline.TimelineDomain domain)
         throws java.io.IOException

Specified by:

put in interface org.apache.hadoop.yarn.server.timeline.TimelineWriter

Throws:

java.io.IOException