View Runtime Configurations
Overview
Note: This section is only necessary if you need to debug configuration issues. For regular usage, you can skip this section.
Higress has three main components related to runtime configurations:
- Controller: Generates the complete configuration
- Pilot: Retrieves configuration from the controller, filters it, and distributes it to the gateway
- Gateway: Receives configuration from pilot and applies it during request routing
Retrieving Configuration Information
Kubernetes Deployment
Prerequisites
First, get the names of all Higress pods:
kubectl get pods -n higress-system
Get Configuration Generated by Controller
# Replace 'higress-controller-xxxx-yyyy' with the actual Higress Controller pod name from the previous stepkubectl exec higress-controller-xxxx-yyyy -n higress-system -it -- bashcurl http://localhost:8888/debug/configz # Outputs compact JSONcurl http://localhost:8888/debug/configz?pretty # Outputs formatted JSON
Get Configuration Retrieved by Pilot
# Replace 'higress-controller-xxxx-yyyy' with the actual Higress Controller pod namekubectl exec higress-controller-xxxx-yyyy -n higress-system -it -- bashcurl http://localhost:15014/debug/configz # Outputs compact JSONcurl http://localhost:15014/debug/configz?pretty # Outputs formatted JSON
Get Configuration Pushed by Pilot
# Replace 'higress-controller-xxxx-yyyy' with the actual Higress Controller pod namekubectl exec higress-controller-xxxx-yyyy -n higress-system -it -- bashcurl http://localhost:15014/debug/connections# The above command will output JSON similar to:# {"totalClients":1,"clients":[{"connectionId":"higress-gateway-7f9f949d64-hmmg8.higress-system-1","connectedAt":"2025-05-12T04:52:23.63339838Z","address":"10.42.0.47:56862","labels":null}]}# Note one of the connectionId valuescurl http://localhost:15014/debug/config_dump?proxyID=higress-gateway-7f9f949d64-hmmg8.higress-system-1 # Replace with the connectionId from above
Get Configuration Retrieved by Gateway
# Replace 'higress-gateway-xxxx-yyyy' with the actual Higress Gateway pod namekubectl exec higress-gateway-xxxx-yyyy -n higress-system -it -- bashcurl http://localhost:15000/config_dump
Docker Compose Deployment
Get Configuration Generated by Controller
docker exec -it higress-controller-1 bashcurl http://localhost:8888/debug/configz # Outputs compact JSONcurl http://localhost:8888/debug/configz?pretty # Outputs formatted JSON
Get Configuration Retrieved by Pilot
docker exec -it higress-pilot-1 bashcurl http://localhost:15014/debug/configz # Outputs compact JSONcurl http://localhost:15014/debug/configz?pretty # Outputs formatted JSON
Get Configuration Pushed by Pilot
docker exec -it higress-pilot-1 bashcurl http://localhost:15014/debug/connections# The above command will output JSON similar to:# {"totalClients":1,"clients":[{"connectionId":"higress-gateway.higress-system-1","connectedAt":"2025-05-12T04:52:23.63339838Z","address":"10.42.0.47:56862","labels":null}]}# Note one of the connectionId valuescurl http://localhost:15014/debug/config_dump?proxyID=higress-gateway.higress-system-1 # Replace with the connectionId from above
Get Configuration Retrieved by Gateway
docker exec -it higress-gateway-1 bashcurl http://localhost:15000/config_dump
All-in-One Image Deployment
Prerequisites
First, confirm the name of your Higress all-in-one container:
docker ps
Get Configuration Generated by Controller
# Replace 'higress-container-name' with the actual Higress container name or IDdocker exec -it higress-container-name bashcurl http://localhost:8888/debug/configz # Outputs compact JSONcurl http://localhost:8888/debug/configz?pretty # Outputs formatted JSON
Get Configuration Retrieved by Pilot
# Replace 'higress-container-name' with the actual Higress container name or IDdocker exec -it higress-container-name bashcurl http://localhost:15014/debug/configz # Outputs compact JSONcurl http://localhost:15014/debug/configz?pretty # Outputs formatted JSON
Get Configuration Pushed by Pilot
# Replace 'higress-container-name' with the actual Higress container name or IDdocker exec -it higress-container-name bashcurl http://localhost:15014/debug/connections# The above command will output JSON similar to:# {"totalClients":1,"clients":[{"connectionId":"higress-gateway.higress-system-1","connectedAt":"2025-05-12T04:52:23.63339838Z","address":"10.42.0.47:56862","labels":null}]}# Note one of the connectionId valuescurl http://localhost:15014/debug/config_dump?proxyID=higress-gateway.higress-system-1 # Replace with the connectionId from above
Get Configuration Retrieved by Gateway
# Replace 'higress-container-name' with the actual Higress container name or IDdocker exec -it higress-container-name bashcurl http://localhost:15000/config_dump