1. interface
  2. OpenCensus
  3. \
  4. Stats
  5. \
  6. Exporter
  7. \
  8. ExporterInterface

ExporterInterface

interface ExporterInterface

The ExporterInterface allows you to swap out the Stats reporting mechanism.

Methods

static bool
createMeasure(Measure $measure)

Register a new Measure.

static bool
setReportingPeriod(float $interval)

Adjust the stats reporting period of the Daemom.

static bool
registerView(View ...$views)

Register views.

static bool
unregisterView(View ...$views)

Unregister views.

static bool
recordStats(TagContext $tagContext, array $attachments, Measurement ...$ms)

Record the provided Measurements, Attachments and Tags.

Details

at line 36
static bool createMeasure(Measure $measure)

Register a new Measure.

Parameters

Measure $measure The measure to register.

Return Value

bool Returns true on successful send operation.

at line 44
static bool setReportingPeriod(float $interval)

Adjust the stats reporting period of the Daemom.

Parameters

float $interval Reporting interval of the daemon in seconds.

Return Value

bool Returns true on successful send operation.

at line 52
static bool registerView(View ...$views)

Register views.

Parameters

View ...$views One or more Views to register.

Return Value

bool Returns true on successful send operation.

at line 60
static bool unregisterView(View ...$views)

Unregister views.

Parameters

View ...$views Views to unregister.

Return Value

bool Returns true on successful send operation.

at line 70
static bool recordStats(TagContext $tagContext, array $attachments, Measurement ...$ms)

Record the provided Measurements, Attachments and Tags.

Parameters

TagContext $tagContext TagContext to record with our Measurements.
array $attachments Key-value pairs to use for exemplar annotation.
Measurement ...$ms One or more measurements to record.

Return Value

bool Returns true on successful send operation.