List Log Sinks

GET

/observability/v1/workspaces/{workspace}/engines/{engine}/log-sinks

curl --request GET \
  --url https://example.com/observability/v1/workspaces/example/engines/example/log-sinks

Returns a paginated list of log sinks. A specific provider filters to that provider; - lists across all providers.

Parameters

Path Parameters

workspace

required

string

The workspace whose log sinks to list.

engine

required

string

The provider: qibdo, aws, gcp, or azure, or ’-’ to list across all providers.

Query Parameters

page_size

integer format: int32

The maximum number of sinks to return. The service may return fewer than this value. If unspecified, at most 20 items will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

A page token from a previous ListLogSinks call.

filter

string

AIP-160 filter expression.

order_by

string

AIP-132 order_by expression, e.g. ‘created desc’.

Responses

200

OK

Media type application/json

ListLogSinksResponse

Response for ListLogSinks. Keyset pagination intentionally omits total_size (AIP-158).

object

log_sinks

The list of log sinks.

Array<object>

A log sink routes a workspace’s matching log lines to a destination (an archive, a downstream stream, or an external endpoint), selecting which lines flow with inclusion/exclusion filters. The provider that operates the sink is reported by the read-only engine field.

object

id

The unique identifier of the log sink.

stringOutput only

workspace_id

The workspace this sink belongs to. Derived from the {workspace} path segment on create; reported read-only thereafter.

stringOutput only

location_id

required

Weak reference to a topology Location — where the telemetry resides. Immutable after create.

string

name

required

The sink’s handle: a DNS-label (lowercase alphanumerics and hyphens, up to 63 characters), unique within the workspace. Set on create, immutable thereafter.

string

engine

The provider that operates this sink.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE

created

Timestamp when the sink was created.

string format: date-time Output only

updated

Timestamp when the sink was last updated.

string format: date-time Output only

qibdo

Routing spec for a Qibdo-managed sink.

object

destination

required

Where the matched lines are delivered.

object

archive

Long-term object-archive delivery.

object

container

required

The object container (bucket) that receives the archived lines.

string

path

required

The object-key path prefix under which lines are written.

string

stream

Continuous delivery to a named downstream stream.

object

name

required

The downstream stream name.

string

external

Delivery to an external endpoint.

object

target

required

A free-form descriptor of the external delivery target.

string

reference

required

An opaque reference (endpoint, handle) for the external target.

string

inclusion_filter

required

AIP-160 filter expression selecting which log lines are routed (required).

string

exclusion_filter

Optional AIP-160 filter expression excluding lines from the routed set.

string

next_page_token

A token to retrieve the next page; empty when there are no further pages.

string

Example

{
  "log_sinks": [
    {
      "engine": "ENGINE_UNSPECIFIED"
    }
  ]
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}