Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify deep service insight #3453

Merged
merged 2 commits into from
Jan 25, 2023
Merged

clarify deep service insight #3453

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d312c3
clarify deep service insight
brianehlert Jan 18, 2023
9f2eaef
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions docs/content/logging-and-monitoring/service-insight.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ docs: "DOCS-000"
---


The Ingress Controller exposes an endpoint and provides host statistics for Virtual Servers (VS) and Transport Servers (TS).
The Ingress Controller exposes an endpoint and provides host statistics for services exposed using the VirtualServer (VS) and TransportServer (TS) resource objects.
It exposes data in JSON format and returns HTTP status codes.
The response body holds information about the total, down and the unhealthy number of
upstreams associated with the hostname.
Returned HTTP codes indicate the health of the upstreams (service).
upstream pods associated with the configured hostname.
Returned HTTP codes indicate the health of the service.

The service is not healthy (HTTP response code different than 200 OK) if all upstreams are unhealthy.
The service is healthy if at least one upstream is healthy. In this case, the endpoint returns HTTP code 200 OK.
The service is indicated as not healthy (HTTP response code different than 200 OK) if all upstreams (pods) are determined unhealthy by NGINX Plus.
The service is healthy if at least one upstream pod is healthy as determined by NGINX Plus. In this case, the endpoint returns HTTP code 200 OK.

NGINX Plus determination of healthy can be tuned using advanced health checks, and also dynamically relate to pods responses and responsiveness. See Upstream Healthcheck https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/#upstream

## Enabling Service Insight Endpoint

Expand All @@ -39,9 +41,9 @@ If you're using *Helm* to install the Ingress Controller, to enable Service Insi

The Service Insight provides the following statistics:

* Total number of VS and TS
* Number of VS and TS in 'Up' state
* Number of VS and TS in 'Unhealthy' state
* Total number of VS or TS pods
* Number of VS or TS pods in 'Up' state
* Number of VS or TS pods in 'Unhealthy' state

These statistics are returned as JSON:

Expand Down