1. class
  2. OpenCensus
  3. \
  4. Tags
  5. \
  6. TagValue

TagValue

class TagValue

A key to a value stored in a TagContext

Each TagValue has a string value. Values have a maximum length of 255 and contain only printable ASCII characters.

Traits

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

Constants

MAX_LENGTH

The maximum length for a tag value.

Methods

static TagValue
create(string $value)

Constructs a TagValue with the given string payload.

string
getValue()

Returns the payload of the TagValue.

Details

at line 54
static TagValue create(string $value)

Constructs a TagValue with the given string payload.

The name must meet the following requirements:

  1. It cannot be longer than TagValue::MAX_LENGTH
  2. It can only contain printable ASCII characters.

Parameters

string $value the value payload.

Return Value

TagValue

Exceptions

Exception if name is not valid.

at line 67
final string getValue()

Returns the payload of the TagValue.

Return Value

string