setStatsdConfiguration

Summary

Change the statsd configuration.

enabled

Booleanoptional

True if metrics should be sent to the configured statsd server.

flushRate

Stringoptional

Sets the rate at which the client will flush the pending metric values to the network. E.g. if the rate is 0.1, 1 in 10 writes will flush the pending metrics. Must be between 0 and 1. The default is 0.01, flushing 1 in 100 writes.

hostName

Stringoptional

The host name of the statsd server to which metrics are sent.

includeHostName

Booleanoptional

True to include the CD server hostname in the name of statsd metrics.

port

Integeroptional

The port on the statsd server to which metrics are sent; defaults to port 8125.

prefix

Stringoptional

Prefix added to all statsd metric names; defaults to CloudBeesCD.

sampleRate

Stringoptional

Sets the sample rate of elements that will be actually sent. E.g. if rate is 0.75, more or less 75% of items will be sent (and the @0.75 suffix will be added to the metrics). Must be between 0 and 1. The default is 1, sending all samples.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.setStatsdConfiguration(
  /* optional arguments */
)▼