Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Get Ingestion Config

GET
/observability/v1/workspaces/{workspace}/engines/{engine}/ingestion-configs/{id}
 
curl --request GET \
  --url https://example.com/observability/v1/workspaces/example/engines/example/ingestion-configs/example

Returns an ingestion config by unique id. Use - to look it up regardless of provider.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace the ingestion config belongs to.

engine
required
string

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

id
required
string

The unique identifier of the ingestion config to retrieve.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

An ingestion config governs how telemetry is collected for a workspace: which sources the pipeline scrapes, and how aggressively traces are head-sampled. One config exists per workspace. The provider that runs the pipeline is reported by the read-only engine field.

object
id

The unique identifier of the ingestion config.

stringOutput only
workspace_id

The workspace this config governs. 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 is collected. Immutable after create.

string
engine

The provider that runs this workspace’s ingestion pipeline.

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE
created

Timestamp when the config was created.

string format: date-time Output only
updated

Timestamp when the config was last updated.

string format: date-time Output only
qibdo

Ingestion settings for a Qibdo-managed workspace.

object
sampling
required

The trace head-sampling configuration.

object
mode
required

The trace head-sampling mode (a specific mode is required).

string format: enum
Allowed values: SAMPLING_MODE_UNSPECIFIED SAMPLING_MODE_HEAD_PARENT_BASED
ratio
required

The fraction of traces retained, in the half-open range (0, 1]. 1.0 keeps every trace.

number format: double
sources
required

The enabled telemetry sources. At least one source must be enabled.

Array<string>
Allowed values: TELEMETRY_SOURCE_UNSPECIFIED TELEMETRY_SOURCE_K8S TELEMETRY_SOURCE_CEPH TELEMETRY_SOURCE_KUBEVIRT TELEMETRY_SOURCE_HARBOR TELEMETRY_SOURCE_OPENBAO TELEMETRY_SOURCE_APP
Example 
{
  "engine": "ENGINE_UNSPECIFIED",
  "qibdo": {
    "sampling": {
      "mode": "SAMPLING_MODE_UNSPECIFIED"
    },
    "sources": [
      "TELEMETRY_SOURCE_UNSPECIFIED"
    ]
  }
}

default

Section titled “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"
    }
  ]
}