1. class
  2. OpenCensus
  3. \
  4. Stats
  5. \
  6. View
  7. \
  8. View

View

class View

View allows users to aggregate the recorded stats.Measurements.

Views need to be passed to the Stats::registerView function before data will be collected and sent to Exporters.

Traits

PrintableTrait
Internal utility methods for working with tag keys, tag values, and metric names.

Methods

__construct(string $name, string $description, Measure $measure, Aggregation $aggregation, TagKey ...$tagKeys)

Creates a new View.

string
getName()

Retrieves the name of the view.

string
getDescription()

Retrieves the description of the view.

array
getTagKeys()

Retrieves the TagKeys used by the view.

Measure
getMeasure()

Return the Measure this View aggregates.

Aggregation
getAggregation()

Returns the Aggregation of the View.

Details

at line 55
final __construct(string $name, string $description, Measure $measure, Aggregation $aggregation, TagKey ...$tagKeys)

Creates a new View.

Parameters

string $name The unique name of the View.
string $description The human readable description of the view.
Measure $measure The measure this View aggregates.
Aggregation $aggregation The Aggregation used for this view.
TagKey ...$tagKeys The TagKeys that describe the grouping of this view.

at line 84
string getName()

Retrieves the name of the view.

Return Value

string

at line 94
string getDescription()

Retrieves the description of the view.

Return Value

string

at line 104
array getTagKeys()

Retrieves the TagKeys used by the view.

Return Value

array Array of TagKey.

at line 114
Measure getMeasure()

Return the Measure this View aggregates.

Return Value

Measure

at line 124
Aggregation getAggregation()

Returns the Aggregation of the View.

Return Value

Aggregation