Count cloud gateway logs for an organization

Count logs for all cloud gateways in the organization with filtering capabilities

post

Body

application/json

Request body for searching cloud gateway logs globally. Accepts controlPlaneIds and all CGWLogSearchRequest attributes.

OrgScopedCGWLogSearchRequestSchema

Schema for searching cloud gateway logs globally, extending base CGW search with control plane filtering.

startstring(date-time)required

The start time for the log search query. Must be in RFC-3339 format.

endstring(date-time)required

The end time for the log search query. Must be in RFC-3339 format.

node_idarray[string](uuid)unique-items

A list of data plane node IDs to filter logs.

order_byobject

Specifies the sorting order for the logs in the response.

Show Child Parameters
control_plane_idarray[string](uuid)unique-items

A list of control plane IDs to filter logs.

Response

application/json

Count of matching OTel CGW data plane logs

LogCountResponse

Represents the count response for log search queries.

countinteger(int64)required

The total number of logs matching the search criteria.

post/o11y/cgw-logs/count

Body

{ "start": "2025-04-22T00:00:00Z", "end": "2025-04-22T23:59:59Z", "control_plane_id": [ "456e7890-e89b-12d3-a456-426614174002", "789e1234-e89b-12d3-a456-426614174005" ], "node_id": [ "d32d905a-ed33-46a3-a093-d8f536af9a8a", "ae853602-23c7-4218-9071-82fdef3a1efe" ], "order_by": { "field": "timestamp", "direction": "desc" } }
 
application/json

Download cloud gateway logs

Download logs for all cloud gateways in the organization with filtering capabilities

post

Body

application/json

Request body for searching cloud gateway logs globally. Accepts controlPlaneIds and all CGWLogSearchRequest attributes.

OrgScopedCGWLogSearchRequestSchema

Schema for searching cloud gateway logs globally, extending base CGW search with control plane filtering.

startstring(date-time)required

The start time for the log search query. Must be in RFC-3339 format.

endstring(date-time)required

The end time for the log search query. Must be in RFC-3339 format.

node_idarray[string](uuid)unique-items

A list of data plane node IDs to filter logs.

order_byobject

Specifies the sorting order for the logs in the response.

Show Child Parameters
control_plane_idarray[string](uuid)unique-items

A list of control plane IDs to filter logs.

Response

text/csv

CSV file containing matching OTel CGW data plane logs

string

CSV formatted log data

post/o11y/cgw-logs/download

Body

{ "start": "2025-04-22T00:00:00Z", "end": "2025-04-22T23:59:59Z", "control_plane_id": [ "456e7890-e89b-12d3-a456-426614174002", "789e1234-e89b-12d3-a456-426614174005" ], "node_id": [ "d32d905a-ed33-46a3-a093-d8f536af9a8a", "ae853602-23c7-4218-9071-82fdef3a1efe" ], "order_by": { "field": "timestamp", "direction": "desc" } }
 
text/csv

DebugSession

object
idstring(uuid)read-only

Contains a unique identifier used for this resource.

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

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

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
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)read-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)

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
Example

TargetStatus

object

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

target_idstring(uuid)required

Unique identifier of the data plane node.

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

versionstringrequired

Version of the node instance

Example:3.11

compatible_featuresarray[string]requiredunique-items

List of debugger features that are compatible

Allowed values:logstracespayload_sanitization

Example:logs, traces

incompatible_featuresarray[string]requiredunique-items

List of debugger features that are incompatible

Allowed values:logstracespayload_sanitization

Example:logs

Example

DebuggerFeatures

string

Allowed values:logstracespayload_sanitization