org.apache.beam.it.gcp.monitoring

Class MonitoringClient

java.lang.Object

org.apache.beam.it.gcp.monitoring.MonitoringClient

public final class MonitoringClient
extends java.lang.Object

Client for working with Google Cloud Monitoring.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitoringClient.Builder Builder for MonitoringClient.

Method Summary

Modifier and Type	Method and Description
static MonitoringClient.Builder	builder(com.google.api.gax.core.CredentialsProvider credentialsProvider)
void	cleanupAll()
java.util.List<java.lang.Double>	getCpuUtilization(java.lang.String project, java.lang.String jobId, com.google.monitoring.v3.TimeInterval timeInterval) Gets the CPU Utilization time series data for a given Job.
java.util.List<java.lang.Double>	getDataFreshness(java.lang.String project, java.lang.String jobId, com.google.monitoring.v3.TimeInterval timeInterval) Gets the Data freshness time series data for a given Job.
java.lang.Double	getDataProcessed(java.lang.String project, org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo, java.lang.String pCollection) Get data processed for a job.
java.lang.Double	getElapsedTime(java.lang.String project, org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo) Get elapsed time for a job.
java.lang.Long	getNumMessagesInSubscription(java.lang.String project, java.lang.String subscriptionName) Gets the number of undelivered messages in a given Pub/Sub subscription.
java.util.List<java.lang.Double>	getSystemLatency(java.lang.String project, java.lang.String jobId, com.google.monitoring.v3.TimeInterval timeInterval) Gets the System Latency time series data for a given Job.
java.util.List<java.lang.Double>	getThroughputBytesPerSecond(java.lang.String project, java.lang.String jobId, java.lang.String pcollection, com.google.monitoring.v3.TimeInterval timeInterval) Gets the output throughput in bytes per second from a particular PCollection during job run interval.
java.util.List<java.lang.Double>	getThroughputElementsPerSecond(java.lang.String project, java.lang.String jobId, java.lang.String pcollection, com.google.monitoring.v3.TimeInterval timeInterval) Gets the output throughput in elements per second from a particular PCollection during job run interval.
java.util.List<java.lang.Double>	listTimeSeriesAsDouble(com.google.monitoring.v3.ListTimeSeriesRequest request) Lists time series that match a filter.
java.util.List<java.lang.Long>	listTimeSeriesAsLong(com.google.monitoring.v3.ListTimeSeriesRequest request) Lists time series that match a filter.
static MonitoringClient	withMonitoringClient(com.google.cloud.monitoring.v3.MetricServiceClient metricServiceClient)

Methods inherited from class java.lang.Object

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

Method Detail

withMonitoringClient

public static MonitoringClient withMonitoringClient(com.google.cloud.monitoring.v3.MetricServiceClient metricServiceClient)

builder

public static MonitoringClient.Builder builder(com.google.api.gax.core.CredentialsProvider credentialsProvider)

listTimeSeriesAsDouble

public java.util.List<java.lang.Double> listTimeSeriesAsDouble(com.google.monitoring.v3.ListTimeSeriesRequest request)

Lists time series that match a filter.

Parameters:

request - time series request to execute

Returns:

list of Double values of time series

listTimeSeriesAsLong

public java.util.List<java.lang.Long> listTimeSeriesAsLong(com.google.monitoring.v3.ListTimeSeriesRequest request)

Lists time series that match a filter.

Parameters:

request - time series request to execute

Returns:

list of Long values of time series

getNumMessagesInSubscription

@Nullable
public java.lang.Long getNumMessagesInSubscription(java.lang.String project,
                                                             java.lang.String subscriptionName)

Gets the number of undelivered messages in a given Pub/Sub subscription.

Parameters:

project - the project that the job is running under

subscriptionName - name of the Pub/Sub subscription

Returns:

number of undelivered messages in the subscription

getCpuUtilization

@Nullable
public java.util.List<java.lang.Double> getCpuUtilization(java.lang.String project,
                                                                    java.lang.String jobId,
                                                                    com.google.monitoring.v3.TimeInterval timeInterval)

Gets the CPU Utilization time series data for a given Job.

Parameters:

project - the project that the job is running under

jobId - dataflow job id

timeInterval - interval for the monitoring query

Returns:

CPU Utilization time series data for the given job.

getSystemLatency

@Nullable
public java.util.List<java.lang.Double> getSystemLatency(java.lang.String project,
                                                                   java.lang.String jobId,
                                                                   com.google.monitoring.v3.TimeInterval timeInterval)

Gets the System Latency time series data for a given Job.

Parameters:

project - the project that the job is running under

jobId - dataflow job id

timeInterval - interval for the monitoring query

Returns:

System Latency time series data for the given job.

getDataFreshness

@Nullable
public java.util.List<java.lang.Double> getDataFreshness(java.lang.String project,
                                                                   java.lang.String jobId,
                                                                   com.google.monitoring.v3.TimeInterval timeInterval)

Gets the Data freshness time series data for a given Job.

Parameters:

project - the project that the job is running under

jobId - dataflow job id

timeInterval - interval for the monitoring query

Returns:

Data freshness time series data for the given job.

getThroughputBytesPerSecond

@Nullable
public java.util.List<java.lang.Double> getThroughputBytesPerSecond(java.lang.String project,
                                                                              java.lang.String jobId,
                                                                              java.lang.String pcollection,
                                                                              com.google.monitoring.v3.TimeInterval timeInterval)

Gets the output throughput in bytes per second from a particular PCollection during job run interval.

Parameters:

project - the project that the job is running under

jobId - dataflow job id

pcollection - name of the pcollection

timeInterval - interval for the monitoring query

Returns:

output throughput from a particular PCollection during job run interval

getThroughputElementsPerSecond

@Nullable
public java.util.List<java.lang.Double> getThroughputElementsPerSecond(java.lang.String project,
                                                                                 java.lang.String jobId,
                                                                                 java.lang.String pcollection,
                                                                                 com.google.monitoring.v3.TimeInterval timeInterval)

Gets the output throughput in elements per second from a particular PCollection during job run interval.

Parameters:

project - the project that the job is running under

jobId - dataflow job id

pcollection - name of the pcollection

timeInterval - interval for the monitoring query

Returns:

output throughput from a particular PCollection during job run interval

getElapsedTime

@Nullable
public java.lang.Double getElapsedTime(java.lang.String project,
                                                 org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo)
                                          throws java.text.ParseException

Get elapsed time for a job.

Parameters:

project - the project that the job is running under

launchInfo - information about the job

Returns:

elapsed time

Throws:

java.text.ParseException - if timestamp is inaccurate

getDataProcessed

@Nullable
public java.lang.Double getDataProcessed(java.lang.String project,
                                                   org.apache.beam.it.common.PipelineLauncher.LaunchInfo launchInfo,
                                                   java.lang.String pCollection)
                                            throws java.text.ParseException

Get data processed for a job.

Parameters:

project - the project that the job is running under

launchInfo - information about the job

Returns:

data processed

Throws:

java.text.ParseException - if timestamp is inaccurate

cleanupAll

public void cleanupAll()