Trace sessions

Trace sessions

GEThttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_sessions

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Response

200

OK

Headers

Body

application/json

id*string (uuid)

pipelineID*string (uuid)

plugins*array of string

List of Fluent-bit plugin IDs ar aliases to trace.

lifespan*string (duration)

For how long will this session be active and process records.

Example: "10m"

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_sessions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
    "plugins": [
      "dummy.0"
    ],
    "lifespan": "10m",
    "createdAt": "2024-09-08T02:27:37.680Z",
    "updatedAt": "2024-09-08T02:27:37.680Z"
  }
]

Create trace session

POSThttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_sessions

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Body

application/json

plugins*array of string

List of Fluent-bit plugin IDs ar aliases to trace.

lifespan*string (duration)

For how long will this session be active and process records.

Example: "10m"

Response

201

Created

Body

application/json

id*string (uuid)

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_sessions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "plugins": [
        "dummy.0"
      ],
      "lifespan": "10m"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-09-08T02:27:37.680Z"
}