Create Debug Session

Create Debug Session

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

DebugSession

namestring

The optional session name.

max_samplesinteger

The maximum amount of samples to collect per data plane.

Default:200

>= 1<= 200

Example:10

sampling_rulestring | null

An expression used to filter the requests to sample.

Example:http.path == "/my-path"

duration_secsinteger

The duration of the debug session in seconds.

Default:300

>= 10<= 1800

Example:300

capture_contentarray[string]

Allowed values:headersbody

capture_logarray[string]

Allowed values:erroraccess

capture_tracesboolean

Determines if Traces should be captured for this session.

Default:true

Example:true

capture_profileobject

CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.

Show Child Parameters
targetsarray[string](uuid)

Unique identifier of the data plane node.

>= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

payload_sanitizationobject

Configuration for sanitizing sensitive data in captured payloads

Show Child Parameters

Response

application/json

Debug Session Response

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The optional session name.

max_samplesintegerrequired

The maximum amount of samples to collect per data plane.

Default:200

>= 1<= 200

Example:10

sampling_rulestring | null

An expression used to filter the requests to sample.

Example:http.path == "/my-path"

duration_secsintegerrequired

The duration of the debug session in seconds.

Default:300

>= 10<= 1800

Example:300

capture_contentarray[string]

Allowed values:headersbody

capture_logarray[string]

Allowed values:erroraccess

capture_tracesboolean

Determines if Traces should be captured for this session.

Default:true

Example:true

capture_profileobject

CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.

Show Child Parameters
started_atstring(date-time)read-only

An ISO-8601 timestamp representation of start date.

Example:2024-11-04T20:10:06.927Z

stopped_atstring(date-time)read-only

An ISO-8601 timestamp representation of stop date.

Example:2022-11-04T20:10:06.927Z

completed_atstring(date-time)read-only

An ISO-8601 timestamp representation of completion date.

Example:2022-11-04T20:10:06.927Z

timed_outbooleanread-only

Determines whether the target did not respond in time before the sampling time elapsed.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

targetsarray[string](uuid)required

Unique identifier of the data plane node.

>= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

payload_sanitizationobject

Configuration for sanitizing sensitive data in captured payloads

Show Child Parameters
target_statusarray[object]

Represents the status of supported features for a node instance based on its version

Show Child Parameters
post/control-planes/{controlPlaneId}/o11y/debug-sessions

Body

{ "name": "Debug Session 1", "max_samples": 10, "sampling_rule": "http.path == \"/my-path\"", "duration_secs": 300, "capture_content": [ "headers", "body" ], "capture_log": [ "error", "access" ], "capture_traces": true, "capture_profile": { "cpu": { "mode": "time", "sampling_interval": 1000 } }, "targets": [ "ae853602-23c7-4218-9071-82fdef3a1efe" ], "payload_sanitization": { "user_defined_rules": { "headers": [ { "header_name": "auth-token", "scope": [ "request", "response" ], "action": "mask" } ], "body": [ { "strategy": { "json_path": "$.user.email" }, "scope": [ "response" ], "action": "mask" } ] } } }
 
application/json

Get a Debug Session

Returns a Debug Session

get

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

Debug Session Response

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The optional session name.

max_samplesintegerrequired

The maximum amount of samples to collect per data plane.

Default:200

>= 1<= 200

Example:10

sampling_rulestring | null

An expression used to filter the requests to sample.

Example:http.path == "/my-path"

duration_secsintegerrequired

The duration of the debug session in seconds.

Default:300

>= 10<= 1800

Example:300

capture_contentarray[string]

Allowed values:headersbody

capture_logarray[string]

Allowed values:erroraccess

capture_tracesboolean

Determines if Traces should be captured for this session.

Default:true

Example:true

capture_profileobject

CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.

Show Child Parameters
started_atstring(date-time)read-only

An ISO-8601 timestamp representation of start date.

Example:2024-11-04T20:10:06.927Z

stopped_atstring(date-time)read-only

An ISO-8601 timestamp representation of stop date.

Example:2022-11-04T20:10:06.927Z

completed_atstring(date-time)read-only

An ISO-8601 timestamp representation of completion date.

Example:2022-11-04T20:10:06.927Z

timed_outbooleanread-only

Determines whether the target did not respond in time before the sampling time elapsed.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

targetsarray[string](uuid)required

Unique identifier of the data plane node.

>= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

payload_sanitizationobject

Configuration for sanitizing sensitive data in captured payloads

Show Child Parameters
target_statusarray[object]

Represents the status of supported features for a node instance based on its version

Show Child Parameters
get/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}
 
application/json

Delete a Debug Session

Deletes a Debug Session

delete

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

The debug session was deleted successfully.

delete/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}
 

Stops an active Debug Session

Stops an active Debug Session

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

Debug Session Stop Response

object
post/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/stop
 
application/json

Mark Target Completed

DEPRECATED

Marks the target as completed in an active debug session

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

targetIdstring(uuid)required

Unique identifier of the data plane node.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

Debug Session Done Response

object
post/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/targets/{targetId}/done
 
application/json