RemoteExecutionEventListener (Buck)

java.lang.Object
- com.facebook.buck.remoteexecution.event.listener.RemoteExecutionEventListener

All Implemented Interfaces:

BuckEventListener, RemoteExecutionStatsProvider, Closeable, AutoCloseable
```
public class RemoteExecutionEventListener
extends Object
implements BuckEventListener, RemoteExecutionStatsProvider
```
Remote execution events sent to the event bus.

Constructor Summary

Constructors
Constructor and Description

RemoteExecutionEventListener()

Constructors
Constructor and Description
`RemoteExecutionEventListener()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.common.collect.ImmutableMap<String,String>`	`exportFieldsToMap()` Export all the above metadata in a Map format
`com.google.common.collect.ImmutableMap<RemoteExecutionActionEvent.State,Integer>`	`getActionsPerState()` Current state of all remote execution Actions.
`int`	`getCasDownloads()` Total number of downloads.
`long`	`getCasDownloadSizeBytes()` Total number of downloaded bytes from CAS.
`int`	`getCasUploads()` Total number of downloads.
`long`	`getCasUploadSizeBytes()` Total of uploaded bytes to CAS.
`LocalFallbackStats`	`getLocalFallbackStats()` Fetches stats regarding the local fallback.
`long`	`getRemoteCpuTimeMs()` Metadata for total time spent executing actions remotely in millis.
`long`	`getRemoteQueueTimeMs()` Metadata for total time spent queued for executing actions in millis.
`LongAdder`	`getStateCount(RemoteExecutionActionEvent.State waiting)`
`long`	`getTotalRemoteTimeMs()` Metadata for total time spent running actions remotely.
`int`	`getTotalRulesBuilt()` Get the total number of BuildRules that are finished.
`void`	`onActionEventFinished(RemoteExecutionActionEvent.Finished event)` Event specific subscriber method.
`void`	`onActionEventStarted(RemoteExecutionActionEvent.Started event)` Event specific subscriber method.
`void`	`onActionEventTerminal(RemoteExecutionActionEvent.Terminal event)` Event specific subscriber method.
`void`	`onActionScheduled(RemoteExecutionActionEvent.Scheduled event)` Event specific subscriber method.
`void`	`onBuildRuleEvent(BuildRuleEvent.Finished event)` Event specific subscriber method.
`void`	`onCasDownloadEvent(CasBlobDownloadEvent.Finished event)` Event specific subscriber method.
`void`	`onCasUploadEvent(CasBlobUploadEvent.Finished event)` Event specific subscriber method.
`void`	`onLocalFallbackEventFinished(LocalFallbackEvent.Finished event)` Events from the LocalFallback stats.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.facebook.buck.event.BuckEventListener
close

- Constructor Detail
  - RemoteExecutionEventListener
```
public RemoteExecutionEventListener()
```
- Method Detail
  - onBuildRuleEvent
```
public void onBuildRuleEvent(BuildRuleEvent.Finished event)
```
    Event specific subscriber method.
  - onCasUploadEvent
```
public void onCasUploadEvent(CasBlobUploadEvent.Finished event)
```
    Event specific subscriber method.
  - onCasDownloadEvent
```
public void onCasDownloadEvent(CasBlobDownloadEvent.Finished event)
```
    Event specific subscriber method.
  - onActionScheduled
```
public void onActionScheduled(RemoteExecutionActionEvent.Scheduled event)
```
    Event specific subscriber method.
  - onActionEventTerminal
```
public void onActionEventTerminal(RemoteExecutionActionEvent.Terminal event)
```
    Event specific subscriber method.
  - onActionEventStarted
```
public void onActionEventStarted(RemoteExecutionActionEvent.Started event)
```
    Event specific subscriber method.
  - getStateCount
```
public LongAdder getStateCount(RemoteExecutionActionEvent.State waiting)
```
  - onActionEventFinished
```
public void onActionEventFinished(RemoteExecutionActionEvent.Finished event)
```
    Event specific subscriber method.
  - onLocalFallbackEventFinished
```
public void onLocalFallbackEventFinished(LocalFallbackEvent.Finished event)
```
    Events from the LocalFallback stats.
  - getActionsPerState
```
public com.google.common.collect.ImmutableMap<RemoteExecutionActionEvent.State,Integer> getActionsPerState()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Current state of all remote execution Actions.
    
    Specified by:
    
    getActionsPerState in interface RemoteExecutionStatsProvider
  - getCasDownloads
```
public int getCasDownloads()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Total number of downloads.
    
    Specified by:
    
    getCasDownloads in interface RemoteExecutionStatsProvider
  - getCasDownloadSizeBytes
```
public long getCasDownloadSizeBytes()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Total number of downloaded bytes from CAS.
    
    Specified by:
    
    getCasDownloadSizeBytes in interface RemoteExecutionStatsProvider
  - getCasUploads
```
public int getCasUploads()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Total number of downloads.
    
    Specified by:
    
    getCasUploads in interface RemoteExecutionStatsProvider
  - getCasUploadSizeBytes
```
public long getCasUploadSizeBytes()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Total of uploaded bytes to CAS.
    
    Specified by:
    
    getCasUploadSizeBytes in interface RemoteExecutionStatsProvider
  - getTotalRulesBuilt
```
public int getTotalRulesBuilt()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Get the total number of BuildRules that are finished. (both local and remote)
    
    Specified by:
    
    getTotalRulesBuilt in interface RemoteExecutionStatsProvider
  - getLocalFallbackStats
```
public LocalFallbackStats getLocalFallbackStats()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Fetches stats regarding the local fallback.
    
    Specified by:
    
    getLocalFallbackStats in interface RemoteExecutionStatsProvider
  - getRemoteCpuTimeMs
```
public long getRemoteCpuTimeMs()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Metadata for total time spent executing actions remotely in millis.
    
    Specified by:
    
    getRemoteCpuTimeMs in interface RemoteExecutionStatsProvider
  - getRemoteQueueTimeMs
```
public long getRemoteQueueTimeMs()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Metadata for total time spent queued for executing actions in millis.
    
    Specified by:
    
    getRemoteQueueTimeMs in interface RemoteExecutionStatsProvider
  - getTotalRemoteTimeMs
```
public long getTotalRemoteTimeMs()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Metadata for total time spent running actions remotely.
    
    Specified by:
    
    getTotalRemoteTimeMs in interface RemoteExecutionStatsProvider
  - exportFieldsToMap
```
public com.google.common.collect.ImmutableMap<String,String> exportFieldsToMap()
```
    Description copied from interface: RemoteExecutionStatsProvider
    
    Export all the above metadata in a Map format
    
    Specified by:
    
    exportFieldsToMap in interface RemoteExecutionStatsProvider

Class RemoteExecutionEventListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.facebook.buck.event.BuckEventListener

Constructor Detail

RemoteExecutionEventListener

Method Detail

onBuildRuleEvent

onCasUploadEvent

onCasDownloadEvent

onActionScheduled

onActionEventTerminal

onActionEventStarted

getStateCount

onActionEventFinished

onLocalFallbackEventFinished

getActionsPerState

getCasDownloads

getCasDownloadSizeBytes

getCasUploads

getCasUploadSizeBytes

getTotalRulesBuilt

getLocalFallbackStats

getRemoteCpuTimeMs

getRemoteQueueTimeMs

getTotalRemoteTimeMs

exportFieldsToMap