You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/content/how-to/monitoring/troubleshooting.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This topic describes possible issues users might encounter when using NGINX Gate
14
14
15
15
When investigating a problem or requesting help, there are important data points that can be collected to help understand what issues may exist.
16
16
17
-
#####Resource status
17
+
#### Resource status
18
18
19
19
To check the status of a resource, use `kubectl describe`. This example checks the status of the `coffee` HTTPRoute, which has an error:
20
20
@@ -52,7 +52,7 @@ If a resource has errors relating to its configuration or relationship to other
52
52
53
53
If no `Status` is written on the resource, further debug by checking if the referenced resources exists and belong to NGINX Gateway Fabric.
54
54
55
-
#####Events
55
+
#### Events
56
56
57
57
Events created by NGINX Gateway Fabric or other Kubernetes components could indicate system or configuration issues. To see events:
58
58
@@ -68,15 +68,15 @@ LAST SEEN TYPE REASON OBJECT
68
68
5s Warning ResourceDeleted nginxgateway/ngf-config NginxGateway configuration was deleted; using defaults
69
69
```
70
70
71
-
#####Get shell access to NGINX container
71
+
#### Get shell access to NGINX container
72
72
73
73
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`:
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.
82
82
@@ -136,7 +136,7 @@ You can see logs for a crashed or killed container by adding the `-p` flag to th
136
136
137
137
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.
138
138
139
-
### Understanding the generated NGINX config
139
+
####Understanding the generated NGINX config
140
140
141
141
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).
0 commit comments