Skip to main content
logoTetrate Service BridgeVersion: 1.12.x

Proxy Tools

This document explains how to troubleshoot issues with proxy tools in TSB. Proxy tools is a feature that allows you to get details information from workload proxies in your cluster. With proxy tools you can get Envoy proxy cluster stats, server stats, config dump and logs. Informations are shown as formatted table for to make it easier to read and also available as raw YAML and JSON. You can copy and download the raw data for further analysis.

Enable Proxy Tools​

To enable proxy tools, add remoteDiagnostic.enabled = true to the xcp component for both Management Plane and Control Plane CR or Helm values in each cluster.

spec:
  components:
    xcp:
      remoteDiagnostic:
        enabled: true

Using Proxy Tools​

To use proxy tools, go to the TSB UI and select Clusters. Select one of the clusters you have onboarded and click on the Proxy Tools tab. There you can select namespace and service instance (pod) to get the details information from the workload proxy.

Cluster Stats​

Provides detailed information about each cluster configured in the Envoy proxy. This information includes all discovered upstream hosts in each cluster along with per host statistics that include circuit breakers and outlier detection.

proxy cluster stats

Server Stats​

Provides a snapshot of the internal statistics and metrics maintained by Envoy proxy. Available as

proxy server stats

Proxy Config​

Provides a comprehensive snapshot of the current configuration of the Envoy proxy. This includes details about listeners, clusters, routes, endpoints, secrets and more. Each section of the configuration is displayed in a separate tab.

Proxy Config Clusters​

Show the list of clusters configured in the Envoy proxy.

proxy config clusters

Proxy Config Routes'​

Show the list of routes configured in the Envoy proxy.

proxy config routes

Proxy Config Listeners​

Show the list of listeners configured in the Envoy proxy.

proxy config listeners

Proxy Config Endpoints​

Show the list of endpoints configured in the Envoy proxy.

proxy config endpoints

Proxy Config Secrets​

Show the list of secrets configured in the Envoy proxy.

proxy config secrets

Proxy Config Dump​

Show the raw configuration of the Envoy proxy.

proxy config dump

Proxy Logs Level​

Shows Envoy proxy components logs streaming.

proxy logs level

Streaming Logs​

Shows logs from the Envoy proxy components.

proxy logs