io.opencensus.exporter.stats.stackdriver

Class StackdriverStatsExporter

java.lang.Object

io.opencensus.exporter.stats.stackdriver.StackdriverStatsExporter

public final class StackdriverStatsExporter
extends Object

Exporter to Stackdriver Monitoring Client API v3.

Example of usage on Google Cloud VMs:

   public static void main(String[] args) {
     StackdriverStatsExporter.createAndRegister(
         StackdriverStatsConfiguration
             .builder()
             .setProjectId("MyStackdriverProjectId")
             .setExportInterval(Duration.fromMillis(100000))
             .build());
     ... // Do work.
   }
 

Since:

0.9

Method Summary

Modifier and Type	Method and Description
static void	createAndRegister() Creates a Stackdriver Stats exporter with default settings.
static void	createAndRegister(io.opencensus.common.Duration exportInterval) Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).
static void	createAndRegister(StackdriverStatsConfiguration configuration) Creates a Stackdriver Stats exporter with a StackdriverStatsConfiguration.
static void	createAndRegisterWithCredentialsAndProjectId(com.google.auth.Credentials credentials, String projectId, io.opencensus.common.Duration exportInterval) Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).
static void	createAndRegisterWithMonitoredResource(io.opencensus.common.Duration exportInterval, com.google.api.MonitoredResource monitoredResource) Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).
static void	createAndRegisterWithProjectId(String projectId, io.opencensus.common.Duration exportInterval) Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).
static void	createAndRegisterWithProjectIdAndMonitoredResource(String projectId, io.opencensus.common.Duration exportInterval, com.google.api.MonitoredResource monitoredResource) Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).

Methods inherited from class java.lang.Object

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

Method Detail

createAndRegisterWithCredentialsAndProjectId

@Deprecated
public static void createAndRegisterWithCredentialsAndProjectId(com.google.auth.Credentials credentials,
                                                                            String projectId,
                                                                            io.opencensus.common.Duration exportInterval)
                                                                     throws IOException

Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).

Creates a StackdriverStatsExporter for an explicit project ID and using explicit credentials, with default Monitored Resource.

Only one Stackdriver exporter can be created.

Parameters:

credentials - a credentials used to authenticate API calls.

projectId - the cloud project id.

exportInterval - the interval between pushing stats to StackDriver.

Throws:

IllegalStateException - if a Stackdriver exporter already exists.

IOException

Since:

0.9

createAndRegisterWithProjectId

@Deprecated
public static void createAndRegisterWithProjectId(String projectId,
                                                              io.opencensus.common.Duration exportInterval)
                                                       throws IOException

Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).

Creates a Stackdriver Stats exporter for an explicit project ID, with default Monitored Resource.

Only one Stackdriver exporter can be created.

This uses the default application credentials. See GoogleCredentials.getApplicationDefault().

This is equivalent with:

 StackdriverStatsExporter.createWithCredentialsAndProjectId(
     GoogleCredentials.getApplicationDefault(), projectId);
 

Parameters:

projectId - the cloud project id.

exportInterval - the interval between pushing stats to StackDriver.

Throws:

IllegalStateException - if a Stackdriver exporter is already created.

IOException

Since:

0.9

createAndRegister

public static void createAndRegister(StackdriverStatsConfiguration configuration)
                              throws IOException

Creates a Stackdriver Stats exporter with a StackdriverStatsConfiguration.

Only one Stackdriver exporter can be created.

If credentials of the configuration is not set, the exporter will use the default application credentials. See GoogleCredentials.getApplicationDefault().

If projectId of the configuration is not set, the exporter will use the default project ID configured. See ServiceOptions.getDefaultProjectId().

If exportInterval of the configuration is not set, the exporter will use the default interval of one minute.

If monitoredResources of the configuration is not set, the exporter will try to create an appropriate monitoredResources based on the environment variables. In addition, please refer to cloud.google.com/monitoring/custom-metrics/creating-metrics#which-resource for a list of valid MonitoredResources.

If metricNamePrefix of the configuration is not set, the exporter will use the default prefix "OpenCensus".

Parameters:

configuration - the StackdriverStatsConfiguration.

Throws:

IllegalStateException - if a Stackdriver exporter is already created.

IOException

Since:

0.11.0

createAndRegister

public static void createAndRegister()
                              throws IOException

Creates a Stackdriver Stats exporter with default settings.

Only one Stackdriver exporter can be created.

This is equivalent with:

 StackdriverStatsExporter.createAndRegister(StackdriverStatsConfiguration.builder().build());
 

This method uses the default application credentials. See GoogleCredentials.getApplicationDefault().

This method uses the default project ID configured. See ServiceOptions.getDefaultProjectId().

This method uses the default interval of one minute.

This method uses the default resource created from the environment variables.

This method uses the default display name prefix "OpenCensus".

Throws:

IllegalStateException - if a Stackdriver exporter is already created.

IOException

Since:

0.11.0

createAndRegister

@Deprecated
public static void createAndRegister(io.opencensus.common.Duration exportInterval)
                                          throws IOException

Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).

Creates a Stackdriver Stats exporter with default Monitored Resource.

Only one Stackdriver exporter can be created.

This uses the default application credentials. See GoogleCredentials.getApplicationDefault().

This uses the default project ID configured see ServiceOptions.getDefaultProjectId().

This is equivalent with:

 StackdriverStatsExporter.createWithProjectId(ServiceOptions.getDefaultProjectId());
 

Parameters:

exportInterval - the interval between pushing stats to StackDriver.

Throws:

IllegalStateException - if a Stackdriver exporter is already created.

IOException

Since:

0.9

createAndRegisterWithProjectIdAndMonitoredResource

@Deprecated
public static void createAndRegisterWithProjectIdAndMonitoredResource(String projectId,
                                                                                  io.opencensus.common.Duration exportInterval,
                                                                                  com.google.api.MonitoredResource monitoredResource)
                                                                           throws IOException

Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).

Creates a Stackdriver Stats exporter with an explicit project ID and a custom Monitored Resource.

Only one Stackdriver exporter can be created.

Please refer to cloud.google.com/monitoring/custom-metrics/creating-metrics#which-resource for a list of valid MonitoredResources.

This uses the default application credentials. See GoogleCredentials.getApplicationDefault().

Parameters:

projectId - the cloud project id.

exportInterval - the interval between pushing stats to StackDriver.

monitoredResource - the Monitored Resource used by exporter.

Throws:

IllegalStateException - if a Stackdriver exporter is already created.

IOException

Since:

0.10

createAndRegisterWithMonitoredResource

@Deprecated
public static void createAndRegisterWithMonitoredResource(io.opencensus.common.Duration exportInterval,
                                                                      com.google.api.MonitoredResource monitoredResource)
                                                               throws IOException

Deprecated. in favor of createAndRegister(StackdriverStatsConfiguration).

Creates a Stackdriver Stats exporter with a custom Monitored Resource.

Only one Stackdriver exporter can be created.

Please refer to cloud.google.com/monitoring/custom-metrics/creating-metrics#which-resource for a list of valid MonitoredResources.

This uses the default application credentials. See GoogleCredentials.getApplicationDefault().

This uses the default project ID configured see ServiceOptions.getDefaultProjectId().

Parameters:

exportInterval - the interval between pushing stats to StackDriver.

monitoredResource - the Monitored Resource used by exporter.

Throws:

IllegalStateException - if a Stackdriver exporter is already created.

IOException

Since:

0.10