Telemetry Source Service

Service to manage the Telemetry Sources.

Sources

The Sources service exposes methods to manage telemetry sources from resources.

GetSource

rpc GetSource (tetrateio.api.tsb.observability.telemetry.v2.GetSourceRequest) returns (tetrateio.api.tsb.observability.telemetry.v2.Source)

Get the details of an existing telemetry source.

ListSources

rpc ListSources (tetrateio.api.tsb.observability.telemetry.v2.ListSourcesRequest) returns (tetrateio.api.tsb.observability.telemetry.v2.ListSourcesResponse)

List the telemetry sources that are available for the requested parent. It will return telemetry sources that belong to the requested parent and from all its child resources.

GetSourceRequest

Request to retrieve a Telemetry Sources from a parent resource.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the Telemetry Sources.

TODO(marcnavarro): Add pagination information.

string = {
  min_len: 1
}

ListSourcesRequest

Request to retrieve the list of telemetry sources from a parent resource.

Field Description Validation Rule

parent

string
REQUIRED
Fully-qualified name of the parent resource to retrieve the telemetry sources.

string = {
  min_len: 1
}

scopeTypes

List of tetrateio.api.tsb.observability.telemetry.v2.SourceScopeType
The scope type that a telemetry source needs to match. Telemetry sources that matches any requested scope type will be returned.

belongTos

List of string
Which resources the telemetry sources must belong to. Telemetry sources that belongs to any requested resource will be returned.

existed

tetrateio.api.tsb.observability.telemetry.v2.ListSourcesRequest.TimeRange
Time range during which telemetry sources must have existed. If no existed time range is provided, only the actual available Telemetry sources will be returned. Otherwise, telemetry Sources that existed during the time range will be returned.

TimeRange

TimeRange is a closed time range. If since or until are not provided they will not be used to filter.

Field Description Validation Rule

since

google.protobuf.Timestamp
Moment in time since we retrieve Telemetry Sources.

until

google.protobuf.Timestamp
Moment in time until we retrieve Telemetry Sources.

ListSourcesResponse

List of telemetry sources from the resource.

Field Description Validation Rule

sources

List of tetrateio.api.tsb.observability.telemetry.v2.Source