Skip to content

Commit f2e3b72

Browse files
committed
fix structure of the document
1 parent a871c8f commit f2e3b72

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Diff for: site/content/how-to/monitoring/troubleshooting.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This topic describes possible issues users might encounter when using NGINX Gate
1414

1515
When investigating a problem or requesting help, there are important data points that can be collected to help understand what issues may exist.
1616

17-
##### Resource status
17+
#### Resource status
1818

1919
To check the status of a resource, use `kubectl describe`. This example checks the status of the `coffee` HTTPRoute, which has an error:
2020

@@ -52,7 +52,7 @@ If a resource has errors relating to its configuration or relationship to other
5252

5353
If no `Status` is written on the resource, further debug by checking if the referenced resources exists and belong to NGINX Gateway Fabric.
5454

55-
##### Events
55+
#### Events
5656

5757
Events created by NGINX Gateway Fabric or other Kubernetes components could indicate system or configuration issues. To see events:
5858

@@ -68,15 +68,15 @@ LAST SEEN TYPE REASON OBJECT
6868
5s Warning ResourceDeleted nginxgateway/ngf-config NginxGateway configuration was deleted; using defaults
6969
```
7070

71-
##### Get shell access to NGINX container
71+
#### Get shell access to NGINX container
7272

7373
Getting shell access to containers allows developers and operators to view the environment of a running container, see its logs or diagnose any problems. To get shell access to the NGINX container, use `kubectl exec`:
7474

7575
```shell
7676
kubectl exec -it -n nginx-gateway <ngf-pod-name> -c nginx /bin/sh
7777
```
7878

79-
##### Logs
79+
#### Logs
8080

8181
Logs from the NGINX Gateway Fabric control plane and data plane can contain information that isn't available to status or events. These can include errors in processing or passing traffic.
8282

@@ -136,7 +136,7 @@ You can see logs for a crashed or killed container by adding the `-p` flag to th
136136

137137
To see debug logs for control plane in NGINX Gateway Fabric, enable verbose logging by editing the `NginxGateway` configuration. This can be done either before or after deploying NGINX Gateway Fabric. Refer to this [guide](https://docs.nginx.com/nginx-gateway-fabric/how-to/configuration/control-plane-configuration) to do so.
138138

139-
### Understanding the generated NGINX config
139+
#### Understanding the generated NGINX config
140140

141141
Understanding the NGINX configuration is key for fixing issues because it shows how NGINX handles requests. This helps tweak settings to make sure NGINX behaves the way you want it to for your application. To see your current configuration, you can open a shell in the _nginx_ container by following these [steps](#get-shell-access-to-nginx-container) and run `nginx -T`. To understand the usage of NGINX directives in the configuration file, consult this list of [NGINX directives](https://nginx.org/en/docs/dirindex.html).
142142

0 commit comments

Comments
 (0)