io.opencensus.exporter.stats.stackdriver

Class StackdriverStatsConfiguration.Builder

java.lang.Object

io.opencensus.exporter.stats.stackdriver.StackdriverStatsConfiguration.Builder

Enclosing class:

StackdriverStatsConfiguration

public abstract static class StackdriverStatsConfiguration.Builder
extends Object

Builder for StackdriverStatsConfiguration.

Since:

0.11

Method Summary

Modifier and Type	Method and Description
StackdriverStatsConfiguration	build() Builds a new StackdriverStatsConfiguration with current settings.
abstract StackdriverStatsConfiguration.Builder	setConstantLabels(Map<io.opencensus.metrics.LabelKey,io.opencensus.metrics.LabelValue> constantLabels) Sets the constant labels that will be applied to every Stackdriver metric.
abstract StackdriverStatsConfiguration.Builder	setCredentials(com.google.auth.Credentials credentials) Sets the given Credentials.
abstract StackdriverStatsConfiguration.Builder	setDeadline(io.opencensus.common.Duration deadline) Sets the deadline for exporting to Stackdriver Monitoring backend.
abstract StackdriverStatsConfiguration.Builder	setExportInterval(io.opencensus.common.Duration exportInterval) Sets the export interval.
abstract StackdriverStatsConfiguration.Builder	setMetricNamePrefix(String prefix) Sets the the name prefix for Stackdriver metrics.
abstract StackdriverStatsConfiguration.Builder	setMetricServiceStub(com.google.cloud.monitoring.v3.stub.MetricServiceStub stub) Sets the MetricServiceStub to be used to make calls to Stackdriver Monitoring v3 APIs.
abstract StackdriverStatsConfiguration.Builder	setMonitoredResource(com.google.api.MonitoredResource monitoredResource) Sets the MonitoredResource.
abstract StackdriverStatsConfiguration.Builder	setProjectId(String projectId) Sets the given project id.

Methods inherited from class java.lang.Object

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

Method Detail

setCredentials

public abstract StackdriverStatsConfiguration.Builder setCredentials(com.google.auth.Credentials credentials)

Sets the given Credentials.

Parameters:

credentials - the Credentials.

Returns:

this.

Since:

0.11

setProjectId

public abstract StackdriverStatsConfiguration.Builder setProjectId(String projectId)

Sets the given project id.

Parameters:

projectId - the cloud project id.

Returns:

this.

Since:

0.11

setExportInterval

public abstract StackdriverStatsConfiguration.Builder setExportInterval(io.opencensus.common.Duration exportInterval)

Sets the export interval.

Parameters:

exportInterval - the export interval between pushes to StackDriver.

Returns:

this.

Since:

0.11

setMonitoredResource

public abstract StackdriverStatsConfiguration.Builder setMonitoredResource(com.google.api.MonitoredResource monitoredResource)

Sets the MonitoredResource.

Parameters:

monitoredResource - the Stackdriver MonitoredResource.

Returns:

this.

Since:

0.11

setMetricNamePrefix

public abstract StackdriverStatsConfiguration.Builder setMetricNamePrefix(String prefix)

Sets the the name prefix for Stackdriver metrics.

It is suggested to use prefix with custom or external domain name, for example "custom.googleapis.com/myorg/" or "external.googleapis.com/prometheus/". If the given prefix doesn't start with a valid domain, we will add "custom.googleapis.com/" before the prefix.

Parameters:

prefix - the metric name prefix.

Returns:

this.

Since:

0.16

setConstantLabels

public abstract StackdriverStatsConfiguration.Builder setConstantLabels(Map<io.opencensus.metrics.LabelKey,io.opencensus.metrics.LabelValue> constantLabels)

Sets the constant labels that will be applied to every Stackdriver metric. This default ensures that the set of labels together with the default resource (global) are unique to this process, as required by stackdriver.

If not set, the exporter will use the "opencensus_task" label.

If you set constant labels, make sure that the monitored resource together with these labels is unique to the current process. This is to ensure that there is only a single writer to each time series in Stackdriver.

Set constant labels to empty to avoid getting the default "opencensus_task" label. You should only do this if you know that the monitored resource uniquely identifies this process.

Parameters:

constantLabels - constant labels that will be applied to every Stackdriver metric.

Returns:

this

Since:

0.21

setDeadline

public abstract StackdriverStatsConfiguration.Builder setDeadline(io.opencensus.common.Duration deadline)

Sets the deadline for exporting to Stackdriver Monitoring backend.

If both MetricServiceStub and Deadline are set, MetricServiceStub takes precedence and Deadline will not be respected.

Parameters:

deadline - the export deadline.

Returns:

this

Since:

0.22

setMetricServiceStub

public abstract StackdriverStatsConfiguration.Builder setMetricServiceStub(com.google.cloud.monitoring.v3.stub.MetricServiceStub stub)

Sets the MetricServiceStub to be used to make calls to Stackdriver Monitoring v3 APIs. This is for for advanced usage.

Parameters:

stub - the MetricServiceStub.

Returns:

this

Since:

0.22

build

public StackdriverStatsConfiguration build()

Builds a new StackdriverStatsConfiguration with current settings.

Returns:

a StackdriverStatsConfiguration.

Since:

0.11