Create Log Sink

POST

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

const url = 'https://example.com/observability/v1/workspaces/example/engines/example/log-sinks';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"location_id":"example","name":"example","qibdo":{"destination":{"archive":{"container":"example","path":"example"},"stream":{"name":"example"},"external":{"target":"example","reference":"example"}},"inclusion_filter":"example","exclusion_filter":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/observability/v1/workspaces/example/engines/example/log-sinks \
  --header 'Content-Type: application/json' \
  --data '{ "location_id": "example", "name": "example", "qibdo": { "destination": { "archive": { "container": "example", "path": "example" }, "stream": { "name": "example" }, "external": { "target": "example", "reference": "example" } }, "inclusion_filter": "example", "exclusion_filter": "example" } }'

Creates a log sink in the workspace on the given provider. A specific provider is required.

Parameters

Path Parameters

workspace

required

string

The workspace to create the log sink in.

engine

required

string

The provider: qibdo, aws, gcp, or azure (a specific provider is required for create).

Request Body^required

application/json

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

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

create_time

Timestamp when the sink was created.

string format: date-time Output only

update_time

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

Responses

200

application/json

Observability Operation

An acknowledgment of a config-plane mutation request (retention, sink, or ingestion), carrying tracking metadata, errors, and warnings. Engine-neutral: operations carry no engine axis. Follows GCP’s Operations pattern (AIP-151).

object

Operation ID

Unique identifier for this operation.

stringOutput only

resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only

resource_type

Resource Type

The type of resource (e.g., “com.qibdo.cloud.observability:alertrule”).

stringOutput only

operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only

Allowed values: OBSERVABILITY_OPERATION_TYPE_UNSPECIFIED OBSERVABILITY_OPERATION_TYPE_CREATE OBSERVABILITY_OPERATION_TYPE_UPDATE OBSERVABILITY_OPERATION_TYPE_DELETE

status

Status

Current lifecycle state of the operation.

string format: enum Output only

Allowed values: OBSERVABILITY_OPERATION_STATUS_UNSPECIFIED OBSERVABILITY_OPERATION_STATUS_PENDING OBSERVABILITY_OPERATION_STATUS_RUNNING OBSERVABILITY_OPERATION_STATUS_DONE OBSERVABILITY_OPERATION_STATUS_ERROR

insert_time

Insert Time

When the operation was first created.

string format: date-time Output only

start_time

Start Time

When the operation started executing.

string format: date-time Output only

end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only

errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object

code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the error.

stringOutput only

reason

Reason

Machine-readable error identifier in UPPER_SNAKE form — the same dispatch key google.rpc.ErrorInfo.reason carries on the synchronous error plane.

stringOutput only

warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object

code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the warning.

stringOutput only

progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only

scope_type

Scope Type

The category of scope the operation ran in or was triggered from. OBSERVABILITY_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.

string format: enum Output only

Allowed values: OBSERVABILITY_SCOPE_TYPE_UNSPECIFIED OBSERVABILITY_SCOPE_TYPE_PLATFORM OBSERVABILITY_SCOPE_TYPE_ORGANISATION OBSERVABILITY_SCOPE_TYPE_WORKSPACE OBSERVABILITY_SCOPE_TYPE_GROUP

scope_id

Scope ID

The resource this operation was scoped to — for example, when scope_type is OBSERVABILITY_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for OBSERVABILITY_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.

stringOutput only

principal_id

Principal ID

Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.

stringOutput only

trace_id

Trace ID

W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.

stringOutput only

Example

{
  "operation_type": "OBSERVABILITY_OPERATION_TYPE_UNSPECIFIED",
  "status": "OBSERVABILITY_OPERATION_STATUS_UNSPECIFIED",
  "scope_type": "OBSERVABILITY_SCOPE_TYPE_UNSPECIFIED"
}

default

Default error response

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"
    }
  ]
}

Create Log Sink

Parameters

Path Parameters

Request Body required

Responses

200

Example

default

Example generated

Request Body^required

Example ^generated