1. class
  2. OpenCensus
  3. \
  4. Stats
  5. \
  6. NoopMeasurementMap

NoopMeasurementMap

class NoopMeasurementMap implements MeasurementInterface

NoopMeasurementMap is a Noop implementation for Measurement recording.

Methods

MeasurementInterface
put(Measurement $measurement)

Add a Measurement to our map.

MeasurementInterface
putAttachment(string $key, string $value)

Add an Exemplar Attachment to our map. If the key already exists, the existing Attachment in the map will be overriden with the new value.

bool
record(Context $ctx = null, TagContext $tags = null)

Record the Measurements, Attachments and Tags found in the map.

Details

at line 28
MeasurementInterface put(Measurement $measurement)

Add a Measurement to our map.

Parameters

Measurement $measurement The Measurement to add to our map.

Return Value

MeasurementInterface

at line 33
MeasurementInterface putAttachment(string $key, string $value)

Add an Exemplar Attachment to our map. If the key already exists, the existing Attachment in the map will be overriden with the new value.

Parameters

string $key The Attachment key.
string $value The Attachment value.

Return Value

MeasurementInterface

at line 38
bool record(Context $ctx = null, TagContext $tags = null)

Record the Measurements, Attachments and Tags found in the map.

If Context is not explicitly provided, the current Context is used. If a TagContext object is explicitly provided, all tags found are inserted into the TagContext object found in Context. If a Tag with the same key already exists in the implicit TagContext object, the explicit Tag key value pair is used.

Parameters

Context $ctx The Explicit Context object to use. Defaults to current Context.
TagContext $tags The TagContext of Tags to add to the recorded Measurements.

Return Value

bool Returns true on success.