Skip to main content
logoTetrate Service ExpressVersion: Latest

tctl debug

tctl debug

Commands to interact with the debug endpoint in TSB components

Options

  -t, --context string      The name of the kubeconfig context to use
-h, --help help for debug
-k, --kubeconfig string Kubernetes configuration file

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-p, --profile string Use specific profile (default "default")

tctl debug dashboard

Opens the debug dashboard for a TSB component

tctl debug dashboard <component> [flags]

Examples


# Open the debug dashboard for the MPC component
tctl debug dashboard management/mpc

Options

      --admin-server-port int    Port where the admin server is listening in the TSB component (default 5555)
--browser When --browser is supplied as false, the browser will not be opened; the URL of the admin dashboard will just be printed (default true)
-n, --controlplane string The namespace where the control plane is deployed (default "istio-system")
-d, --dataplane string The namespace where the data plane is deployed (default "istio-gateway")
-h, --help help for dashboard
-m, --managementplane string The namespace where the management plane is deployed (default "tsb")

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
-t, --context string The name of the kubeconfig context to use
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-k, --kubeconfig string Kubernetes configuration file
-p, --profile string Use specific profile (default "default")

tctl debug health

Check for health of TSB components

tctl debug health <component> [flags]

Examples

tctl debug health mp/mpc
tctl debug health cp/tsb-operator

Options

  -n, --controlplane string      The namespace where the control plane is deployed (default "istio-system")
-d, --dataplane string The namespace where the data plane is deployed (default "istio-gateway")
-h, --help help for health
-m, --managementplane string The namespace where the management plane is deployed (default "tsb")
-o, --output-type string Response output type: table, yaml, json (default "yaml")
--port int Port where the health server is listening in the TSB component (default 9082)

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
-t, --context string The name of the kubeconfig context to use
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-k, --kubeconfig string Kubernetes configuration file
-p, --profile string Use specific profile (default "default")

tctl debug list-components

Lists the TSB components available in the current kubernetes context

tctl debug list-components [flags]

Examples


# List all the components and their plane association in the current kubectl context
tctl debug list-components

# List all the components and their plane association in the the cluster for which the
# kubectl configuration is stored in a specific context of a different file
tctl debug list-components --kubeconfig /tmp/some-config.yaml --context clusterA

# List all the components and their plane association in the the cluster for which the
# kubectl configuration is stored the default kubeconfig file, in a context different
# that the active one
tctl debug list-components --context clusterB

# If TSB is installed in non-standard namespaces, you can also provide the namespace names
# to use for each plane:
tctl debug list-components --managementplane my-managementplane-ns
tctl debug list-components --controlplane my-controlplane-ns
tctl debug list-components --dataplane my-dataplane-ns

# You can specify more than one namespace in the same command.
tctl debug list-components \
--managementplane my-managementplane-ns \
--controlplane my-controlplane-ns \
--dataplane my-dataplane-ns

Options

  -n, --controlplane string      The namespace where the control plane is deployed (default "istio-system")
-d, --dataplane string The namespace where the data plane is deployed (default "istio-gateway")
-h, --help help for list-components
-m, --managementplane string The namespace where the management plane is deployed (default "tsb")

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
-t, --context string The name of the kubeconfig context to use
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-k, --kubeconfig string Kubernetes configuration file
-p, --profile string Use specific profile (default "default")

tctl debug log-level

Checks or sets the log level for TSB components

tctl debug log-level <component> [flags]

Examples


# Check the current log levels for the IAM component
tctl debug log-level managementplane/iamserver
# or
tctl debug log-level management/iamserver
# or
tctl debug log-level mp/iamserver

# Set the log for the IAM component in the management plane to debug
tctl debug log-level management/iamserver --level debug

# Set the logger q from the API server to debug
tctl debug log-level management/apiserver --level q:debug

# Set multiple specific loggers at once
tctl debug log-level management/apiserver --level q:debug,pdp:debug

# Set all loggers to error and then some specific loggers, all at once
tctl debug log-level management/apiserver --level all:error,q:debug,pdp:debug

# Data plane commands work the same for IngressGateway, Tier1Gateway and EgressGateway.

# Check loggers for a given TSB gateway
tctl debug log-level data/bookinfo-gateway

# Set all loggers to trace for a given TSB gateway
tctl debug log-level data/bookinfo-gateway --level trace

# Set the router and http loggers to debug for a given TSB gateway
tctl debug log-level data/bookinfo-gateway --level router:debug,http:debug

Options

      --admin-server-port int     Port where the admin server is listening in the TSB component (default 5555)
-n, --controlplane string The namespace where the control plane is deployed (default "istio-system")
-d, --dataplane string The namespace where the data plane is deployed (default "istio-gateway")
-f, --file string A file containing TSB or Isito resources that will be parsed to infer the workloads that will get the log level adjusted
-h, --help help for log-level
-l, --level strings log level to set, might include a logger name.
In the form [logger:]level. If logger is omitted, the specified level
will be set for all loggers of the given component.

-m, --managementplane string The namespace where the management plane is deployed (default "tsb")
-o, --output-directory string If wait is provided, the directory where to store the log files. It will be created if it does not exist
-w, --wait Whether or not to wait for logs until Ctrl+C is pressed. Resulting logs will be written to separate files per pod.
-y, --yes With yes, the process will not wait for user confirmation at all

Options inherited from parent commands

  -c, --config string               Path to the config file to use. Can also be
specified via TCTL_CONFIG env variable. This flag
takes precedence over the env variable.
-t, --context string The name of the kubeconfig context to use
--debug Print debug messages for all requests and responses
--disable-tctl-version-warn If set, disable the outdated tctl version warning. Can also be
specified via TCTL_DISABLE_VERSION_WARN env variable.
-k, --kubeconfig string Kubernetes configuration file
-p, --profile string Use specific profile (default "default")