AttributeKeyModule

PackageAxial
Creates typed keys for application-defined telemetry attributes.

Summary

NameSignatureSynopsis
Representation
NameNameNo description available.
EncodeEncodeNo description available.
DecodeDecodeNo description available.
Operations
stringAttributeKey.string nameCreates a string-valued attribute key.
booleanAttributeKey.boolean nameCreates a Boolean-valued attribute key.
int64AttributeKey.int64 nameCreates a 64-bit integer-valued attribute key.
floatAttributeKey.float nameCreates a floating-point-valued attribute key.
stringsAttributeKey.strings nameCreates a string-array-valued attribute key.
booleansAttributeKey.booleans nameCreates a Boolean-array-valued attribute key.
integersAttributeKey.integers nameCreates a 64-bit integer-array-valued attribute key.
floatsAttributeKey.floats nameCreates a floating-point-array-valued attribute key.

Representation

kind:member

Name

Name
Member

Returns

string
kind:member

Encode

Encode
Member

Returns

'value -> AttributeValue
kind:member

Decode

Decode
Member

Returns

AttributeValue -> 'value option

Operations

kind:member

string

AttributeKey.string name
Member
Creates a string-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<string>
kind:member

boolean

AttributeKey.boolean name
Member
Creates a Boolean-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<bool>
kind:member

int64

AttributeKey.int64 name
Member
Creates a 64-bit integer-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<int64>
kind:member

float

AttributeKey.float name
Member
Creates a floating-point-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<float>
kind:member

strings

AttributeKey.strings name
Member
Creates a string-array-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<string list>
kind:member

booleans

AttributeKey.booleans name
Member
Creates a Boolean-array-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<bool list>
kind:member

integers

AttributeKey.integers name
Member
Creates a 64-bit integer-array-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<int64 list>
kind:member

floats

AttributeKey.floats name
Member
Creates a floating-point-array-valued attribute key.

Parameters

NameTypeDescription
namestring

Returns

AttributeKey<float list>