Start a debug bundle collection

POST /v1/debug/bundle

Start a debug bundle collection.

application/json

Body Required

Request to start a debug bundle collection.

job_id string

UUID for the debug bundle job.
config object

Optional configuration for debug bundle collection.
Hide config attributes Show config attributes object
- authentication object
  
  Authentication object
  Hide authentication attributes Show authentication attributes object
  
  mechanism string
  
  SCRAM mechanism
  
  username string
  
  username used by RPK to authenticate against Kafka and Admin API
  
  password string
  
  password used by RPK to authenticate against Kafka and Admin API
- controller_logs_size_limit_bytes integer
  
  Size limit for controller logs in bytes
- cpu_profiler_wait_seconds integer
  
  Time to wait for CPU profiling in seconds
- logs_since string
  
  Include logs dated from the specified date onward (journalctl date format YYYY-MM-DD, 'yesterday', or 'today')
- logs_size_limit_bytes integer
  
  Size limit for logs in bytes
- logs_until string
  
  Include logs older than the specified date (journalctl date format YYYY-MM-DD, 'yesterday', or 'today')
- metrics_interval_seconds integer
  
  Interval for metrics collection in seconds
- metrics_samples integer
  
  Number of metric samples to collect
- partition string
  
  Partition identifier for which logs are collected
- tls_enabled boolean
  
  Enables TLS for the connection
- tls_insecure_skip_verify boolean
  
  Skip verification of the server's certificate chain and hostname
- namespace string
  
  Kubernetes namespace for filtering Kubernetes resources
- label_selector array[object]
  
  Label selection to filter Kubernetes resources in the debug bundle response
  Hide label_selector attributes Show label_selector attributes object
  
  key string
  
  The resource label key
  
  value string
  
  The resource label value

Responses

200 application/json

Successfully started the debug bundle collection.
Hide response attribute Show response attribute object
- job_id string
  
  UUID of the job started.
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- code integer
  
  The error code.
- message string
  
  Error message describing what went wrong.
403 application/json

Forbidden
Hide response attributes Show response attributes object
- code integer
  
  The error code.
- message string
  
  Error message describing what went wrong.
409 application/json

Debug bundle process already running.
Hide response attributes Show response attributes object
- code integer
  
  The error code.
- message string
  
  Error message describing what went wrong.
422 application/json

Invalid input, could not start the debug bundle collection.
Hide response attributes Show response attributes object
- code integer
  
  The error code.
- message string
  
  Error message describing what went wrong.
500 application/json

Internal server error
Hide response attributes Show response attributes object
- code integer
  
  The error code.
- message string
  
  Error message describing what went wrong.

POST /v1/debug/bundle

curl \
 --request POST 'http://localhost:9644/v1/debug/bundle' \
 --header "Content-Type: application/json" \
 --data '{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "config": {
    "authentication": {
      "mechanism": "string",
      "username": "string",
      "password": "string"
    },
    "controller_logs_size_limit_bytes": 42,
    "cpu_profiler_wait_seconds": 42,
    "logs_since": "string",
    "logs_size_limit_bytes": 42,
    "logs_until": "string",
    "metrics_interval_seconds": 42,
    "metrics_samples": 42,
    "partition": "string",
    "tls_enabled": true,
    "tls_insecure_skip_verify": true,
    "namespace": "string",
    "label_selector": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'

Request examples

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "config": {
    "authentication": {
      "mechanism": "string",
      "username": "string",
      "password": "string"
    },
    "controller_logs_size_limit_bytes": 42,
    "cpu_profiler_wait_seconds": 42,
    "logs_since": "string",
    "logs_size_limit_bytes": 42,
    "logs_until": "string",
    "metrics_interval_seconds": 42,
    "metrics_samples": 42,
    "partition": "string",
    "tls_enabled": true,
    "tls_insecure_skip_verify": true,
    "namespace": "string",
    "label_selector": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

Response examples (200)

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response examples (401)

{
  "code": 42,
  "message": "string"
}

Response examples (403)

{
  "code": 42,
  "message": "string"
}

Response examples (409)

{
  "code": 42,
  "message": "string"
}

Response examples (422)

{
  "code": 42,
  "message": "string"
}

Response examples (500)

{
  "code": 42,
  "message": "string"
}