Deploy GitHub Pages

user-guide/monitoring/index.html

@@ -114,7 +114,7 @@ prometheus-prometheus-node-exporter       ClusterIP   10.96.247.128    <none&
 </code></pre></div> prometheus-grafana is the service we want to port forward to. We can do so using the following command: <div class=highlight><pre><span></span><code>kubectl port-forward svc/prometheus-grafana  3000:80 -n prometheus
 </code></pre></div> When you run the above command, you should see something like: <div class=highlight><pre><span></span><code>Forwarding from 127.0.0.1:3000 -&gt; 3000
 Forwarding from [::1]:3000 -&gt; 3000
-</code></pre></div> - Open your browser and visit the following URL http://localhost:{port-forwarded-port} according to the above example it would be, http://localhost:3000 The default username/ password is admin/prom-operator - After the login you can import the Grafana dashboard from <a href=https://github.com/kubernetes/ingress-nginx/tree/main/deploy/grafana/dashboards>official dashboards</a>, by following steps given below :</p> <ul> <li>Navigate to lefthand panel of grafana</li> <li>Hover on the gearwheel icon for Configuration and click "Data Sources"</li> <li>Click "Add data source"</li> <li>Select "Prometheus"</li> <li>Enter the details (note: I used http://10.102.72.134:9090 which is the CLUSTER-IP for Prometheus service)</li> <li>Left menu (hover over +) -&gt; Dashboard</li> <li>Click "Import"</li> <li>Enter the copy pasted json from https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/grafana/dashboards/nginx.json</li> <li>Click Import JSON</li> <li>Select the Prometheus data source</li> <li>Click "Import"</li> </ul> <p><img alt="Grafana Dashboard" src=../../images/grafana-dashboard1.png></p> <h2 id=exposed-metrics>Exposed metrics<a class=headerlink href=#exposed-metrics title="Permanent link"> ¶</a></h2> <p>Prometheus metrics are exposed on port 10254.</p> <h3 id=request-metrics>Request metrics<a class=headerlink href=#request-metrics title="Permanent link"> ¶</a></h3> <ul> <li><code>nginx_ingress_controller_request_duration_seconds</code> Histogram</li> </ul> <p>The request processing time in milliseconds (affected by client speed)</p> <p>nginx var: <code>request_time</code></p> <ul> <li><code>nginx_ingress_controller_response_duration_seconds</code> Histogram</li> </ul> <p>The time spent on receiving the response from the upstream server (affected by client speed)</p> <p>nginx var: <code>upstream_response_time</code></p> <ul> <li><code>nginx_ingress_controller_header_duration_seconds</code> Histogram</li> </ul> <p>The time spent on receiving first header from the upstream server</p> <p>nginx var: <code>upstream_header_time</code></p> <ul> <li><code>nginx_ingress_controller_connect_duration_seconds</code> Histogram</li> </ul> <p>The time spent on establishing a connection with the upstream server</p> <p>nginx var: <code>upstream_connect_time</code></p> <ul> <li><code>nginx_ingress_controller_response_size</code> Histogram</li> </ul> <p>The response length (including request line, header, and request body)</p> <p>nginx var: <code>bytes_sent</code></p> <ul> <li><code>nginx_ingress_controller_request_size</code> Histogram</li> </ul> <p>The request length (including request line, header, and request body)</p> <p>nginx var: <code>request_length</code></p> <ul> <li><code>nginx_ingress_controller_requests</code> Counter</li> </ul> <p>The total number of client requests</p> <ul> <li><code>nginx_ingress_controller_bytes_sent</code> Histogram</li> </ul> <p>The number of bytes sent to a client. <strong>Deprecated</strong>, use <code>nginx_ingress_controller_response_size</code></p> <p>nginx var: <code>bytes_sent</code></p> <ul> <li><code>nginx_ingress_controller_ingress_upstream_latency_seconds</code> Summary</li> </ul> <p>Upstream service latency per Ingress. <strong>Deprecated</strong>, use <code>nginx_ingress_controller_connect_duration_seconds</code></p> <p>nginx var: <code>upstream_connect_time</code></p> <div class=highlight><pre><span></span><code># HELP nginx_ingress_controller_bytes_sent The number of bytes sent to a client. DEPRECATED! Use nginx_ingress_controller_response_size
+</code></pre></div> - Open your browser and visit the following URL http://localhost:{port-forwarded-port} according to the above example it would be, http://localhost:3000 The default username/ password is admin/prom-operator - After the login you can import the Grafana dashboard from <a href=https://github.com/kubernetes/ingress-nginx/tree/main/deploy/grafana/dashboards>official dashboards</a>, by following steps given below :</p> <ul> <li>Navigate to lefthand panel of grafana</li> <li>Hover on the gearwheel icon for Configuration and click "Data Sources"</li> <li>Click "Add data source"</li> <li>Select "Prometheus"</li> <li>Enter the details (note: I used http://10.102.72.134:9090 which is the CLUSTER-IP for Prometheus service)</li> <li>Left menu (hover over +) -&gt; Dashboard</li> <li>Click "Import"</li> <li>Enter the copy pasted json from https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/grafana/dashboards/nginx.json</li> <li>Click Import JSON</li> <li>Select the Prometheus data source</li> <li>Click "Import"</li> </ul> <p><img alt="Grafana Dashboard" src=../../images/grafana-dashboard1.png></p> <h2 id=exposed-metrics>Exposed metrics<a class=headerlink href=#exposed-metrics title="Permanent link"> ¶</a></h2> <p>Prometheus metrics are exposed on port 10254.</p> <h3 id=request-metrics>Request metrics<a class=headerlink href=#request-metrics title="Permanent link"> ¶</a></h3> <ul> <li><code>nginx_ingress_controller_request_duration_seconds</code> Histogram</li> </ul> <p>The request processing time in seconds (affected by client speed)</p> <p>nginx var: <code>request_time</code></p> <ul> <li><code>nginx_ingress_controller_response_duration_seconds</code> Histogram</li> </ul> <p>The time spent on receiving the response from the upstream server (affected by client speed)</p> <p>nginx var: <code>upstream_response_time</code></p> <ul> <li><code>nginx_ingress_controller_header_duration_seconds</code> Histogram</li> </ul> <p>The time spent on receiving first header from the upstream server</p> <p>nginx var: <code>upstream_header_time</code></p> <ul> <li><code>nginx_ingress_controller_connect_duration_seconds</code> Histogram</li> </ul> <p>The time spent on establishing a connection with the upstream server</p> <p>nginx var: <code>upstream_connect_time</code></p> <ul> <li><code>nginx_ingress_controller_response_size</code> Histogram</li> </ul> <p>The response length (including request line, header, and request body)</p> <p>nginx var: <code>bytes_sent</code></p> <ul> <li><code>nginx_ingress_controller_request_size</code> Histogram</li> </ul> <p>The request length (including request line, header, and request body)</p> <p>nginx var: <code>request_length</code></p> <ul> <li><code>nginx_ingress_controller_requests</code> Counter</li> </ul> <p>The total number of client requests</p> <ul> <li><code>nginx_ingress_controller_bytes_sent</code> Histogram</li> </ul> <p>The number of bytes sent to a client. <strong>Deprecated</strong>, use <code>nginx_ingress_controller_response_size</code></p> <p>nginx var: <code>bytes_sent</code></p> <ul> <li><code>nginx_ingress_controller_ingress_upstream_latency_seconds</code> Summary</li> </ul> <p>Upstream service latency per Ingress. <strong>Deprecated</strong>, use <code>nginx_ingress_controller_connect_duration_seconds</code></p> <p>nginx var: <code>upstream_connect_time</code></p> <div class=highlight><pre><span></span><code># HELP nginx_ingress_controller_bytes_sent The number of bytes sent to a client. DEPRECATED! Use nginx_ingress_controller_response_size
 # TYPE nginx_ingress_controller_bytes_sent histogram
 # HELP nginx_ingress_controller_connect_duration_seconds The time spent on establishing a connection with the upstream server
 # TYPE nginx_ingress_controller_connect_duration_seconds nginx_ingress_controller_connect_duration_seconds