viam.gen.opentelemetry.proto.common.v1.common_pb2

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Attributes

`DESCRIPTOR`
`global___AnyValue`
`global___ArrayValue`
`global___KeyValueList`
`global___KeyValue`
`global___InstrumentationScope`
`global___EntityRef`

Classes

`AnyValue`	Represents any type of attribute value. AnyValue may contain a
`ArrayValue`	ArrayValue is a list of AnyValue messages. We need ArrayValue as a message
`KeyValueList`	KeyValueList is a list of KeyValue messages. We need KeyValueList as a message
`KeyValue`	Represents a key-value pair that is used to store Span attributes, Link
`InstrumentationScope`	InstrumentationScope is a message representing the instrumentation scope information
`EntityRef`	A reference to an Entity.

Module Contents

viam.gen.opentelemetry.proto.common.v1.common_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.opentelemetry.proto.common.v1.common_pb2.AnyValue(*, string_value: str = ..., bool_value: bool = ..., int_value: int = ..., double_value: float = ..., array_value: global___ArrayValue | None = ..., kvlist_value: global___KeyValueList | None = ..., bytes_value: bytes = ...)

Bases: google.protobuf.message.Message

Represents any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.

string_value: str

bool_value: bool

int_value: int

double_value: float

bytes_value: bytes

property array_value: global___ArrayValue

property kvlist_value: global___KeyValueList

HasField(field_name: Literal['array_value', b'array_value', 'bool_value', b'bool_value', 'bytes_value', b'bytes_value', 'double_value', b'double_value', 'int_value', b'int_value', 'kvlist_value', b'kvlist_value', 'string_value', b'string_value', 'value', b'value']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['value', b'value']) → Literal['string_value', 'bool_value', 'int_value', 'double_value', 'array_value', 'kvlist_value', 'bytes_value'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.opentelemetry.proto.common.v1.common_pb2.global___AnyValue

class viam.gen.opentelemetry.proto.common.v1.common_pb2.ArrayValue(*, values: collections.abc.Iterable[global___AnyValue] | None = ...)

Bases: google.protobuf.message.Message

ArrayValue is a list of AnyValue messages. We need ArrayValue as a message since oneof in AnyValue does not allow repeated fields.

property values: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AnyValue]: Array of values. The array may be empty (contain 0 elements).

viam.gen.opentelemetry.proto.common.v1.common_pb2.global___ArrayValue

class viam.gen.opentelemetry.proto.common.v1.common_pb2.KeyValueList(*, values: collections.abc.Iterable[global___KeyValue] | None = ...)

Bases: google.protobuf.message.Message

KeyValueList is a list of KeyValue messages. We need KeyValueList as a message since oneof in AnyValue does not allow repeated fields. Everywhere else where we need a list of KeyValue messages (e.g. in Span) we use repeated KeyValue directly to avoid unnecessary extra wrapping (which slows down the protocol). The 2 approaches are semantically equivalent.

property values: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___KeyValue]

A collection of key/value pairs of key-value pairs. The list may be empty (may contain 0 elements).

The keys MUST be unique (it is not allowed to have more than one value with the same key). The behavior of software that receives duplicated keys can be unpredictable.

viam.gen.opentelemetry.proto.common.v1.common_pb2.global___KeyValueList

class viam.gen.opentelemetry.proto.common.v1.common_pb2.KeyValue(*, key: str = ..., value: global___AnyValue | None = ...)

Bases: google.protobuf.message.Message

Represents a key-value pair that is used to store Span attributes, Link attributes, etc.

key: str: The key name of the pair.

property value: global___AnyValue: The value of the pair.

HasField(field_name: Literal['value', b'value']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.opentelemetry.proto.common.v1.common_pb2.global___KeyValue

class viam.gen.opentelemetry.proto.common.v1.common_pb2.InstrumentationScope(*, name: str = ..., version: str = ..., attributes: collections.abc.Iterable[global___KeyValue] | None = ..., dropped_attributes_count: int = ...)

Bases: google.protobuf.message.Message

InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.

name: str: A name denoting the Instrumentation scope. An empty instrumentation scope name means the name is unknown.

version: str: Defines the version of the instrumentation scope. An empty instrumentation scope version means the version is unknown.

dropped_attributes_count: int: The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.

property attributes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___KeyValue]: Additional attributes that describe the scope. [Optional]. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key). The behavior of software that receives duplicated keys can be unpredictable.

viam.gen.opentelemetry.proto.common.v1.common_pb2.global___InstrumentationScope

class viam.gen.opentelemetry.proto.common.v1.common_pb2.EntityRef(*, schema_url: str = ..., type: str = ..., id_keys: collections.abc.Iterable[str] | None = ..., description_keys: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

A reference to an Entity. Entity represents an object of interest associated with produced telemetry: e.g spans, metrics, profiles, or logs.

Status: [Development]

schema_url: str

The Schema URL, if known. This is the identifier of the Schema that the entity data is recorded in. To learn more about Schema URL see https://opentelemetry.io/docs/specs/otel/schemas/#schema-url

This schema_url applies to the data in this message and to the Resource attributes referenced by id_keys and description_keys. TODO: discuss if we are happy with this somewhat complicated definition of what the schema_url applies to.

This field obsoletes the schema_url field in ResourceMetrics/ResourceSpans/ResourceLogs.

type: str: Defines the type of the entity. MUST not change during the lifetime of the entity. For example: “service” or “host”. This field is required and MUST not be empty for valid entities.

property id_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: Attribute Keys that identify the entity. MUST not change during the lifetime of the entity. The Id must contain at least one attribute. These keys MUST exist in the containing {message}.attributes.

property description_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: Descriptive (non-identifying) attribute keys of the entity. MAY change over the lifetime of the entity. MAY be empty. These attribute keys are not part of entity’s identity. These keys MUST exist in the containing {message}.attributes.

viam.gen.opentelemetry.proto.common.v1.common_pb2.global___EntityRef