Count cloud gateway logs for an organization
Count logs for all cloud gateways in the organization with filtering capabilities
Body
application/json
Body
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.
The start time for the log search query. Must be in RFC-3339 format.
The end time for the log search query. Must be in RFC-3339 format.
A list of data plane node IDs to filter logs.
Specifies the sorting order for the logs in the response.
Show Child Parameters
A list of control plane IDs to filter logs.
Response
application/json
Response
Count of matching OTel CGW data plane logs
LogCountResponse
Represents the count response for log search queries.
The total number of logs matching the search criteria.
Authentication
Body
Download cloud gateway logs
Download logs for all cloud gateways in the organization with filtering capabilities
Body
application/json
Body
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.
The start time for the log search query. Must be in RFC-3339 format.
The end time for the log search query. Must be in RFC-3339 format.
A list of data plane node IDs to filter logs.
Specifies the sorting order for the logs in the response.
Show Child Parameters
A list of control plane IDs to filter logs.
Response
text/csv
Response
CSV file containing matching OTel CGW data plane logs
CSV formatted log data
Authentication
Body
DebugSession
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The optional session name.
The maximum amount of samples to collect per data plane.
Default:200
>= 1<= 200
Example:10
An expression used to filter the requests to sample.
Example:http.path == "/my-path"
The duration of the debug session in seconds.
Default:300
>= 10<= 1800
Example:300
Allowed values:headersbody
Allowed values:erroraccess
Determines if Traces should be captured for this session.
Default:true
Example:true
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
An ISO-8601 timestamp representation of start date.
Example:2024-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of stop date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of completion date.
Example:2022-11-04T20:10:06.927Z
Determines whether the target did not respond in time before the sampling time elapsed.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Unique identifier of the data plane node.
>= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Configuration for sanitizing sensitive data in captured payloads
Show Child Parameters
TargetStatus
objectRepresents the status of supported features for a node instance based on its version
Unique identifier of the data plane node.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Version of the node instance
Example:3.11
List of debugger features that are compatible
Allowed values:logstracespayload_sanitization
Example:logs, traces
List of debugger features that are incompatible
Allowed values:logstracespayload_sanitization
Example:logs
DebuggerFeatures
stringAllowed values:logstracespayload_sanitization