(Legacy) Monitoring Health with Vitals
This documentation is for the legacy Konnect environment at konnect.konghq.com. For the cloud.konghq.com environment, see the current Konnect documentation.
Use Konnect Vitals (Vitals) to monitor the health and performance of a Service managed by Kong Konnect (Konnect). Vitals uses visual API analytics to see exactly how your APIs and runtimes are performing. Quickly access key statistics, monitor vital signs, and pinpoint anomalies in real time.
Vitals charts are available from:
- Any Service’s overview page, which displays request count, failed requests by status codes, and includes all versions of the Service filtered by timeframe. You can also export a report of a Service’s performance data.
- Any Service version or Route page, which display status codes filtered by timeframe. You can also export a report of version performance data.
Konnect Cloud has Vitals enabled by default.
View Vitals performance for a Service
To view traffic health and performance of a Service, including across all of a Service’s versions:
-
From the ServiceHub, select a Service.
-
In the Traffic section, the Vitals graph displays any events that have occurred for all of the versions of the Service. Hover over an area of the graph to view details of an event, including version information and time the event occurred.
-
Select a timeframe to display. By default, the graph displays the last 6 hours of events.
View Vitals performance for a Service version
To view traffic health and performance for a Service version:
-
From the ServiceHub, select a Service version.
-
In the Status Codes section, events display in a graph for the selected version. Hover over an area of the graph to view details, including status code class and count.
-
Select a timeframe to display. By default, the graph displays the last 6 hours of events.
For more information about status codes, see Vitals Status Codes.
View Vitals performance for a Route
To view traffic health and performance for a Route:
-
From the ServiceHub, select a Service version.
-
In the Routes section, click on a Route.
-
In the Status Codes section, events display in a graph for the selected route. Hover over an area of the graph to view details, including status code class and count.
-
To customize the view, select a timeframe, Coordinated Universal Time (UTC), and list view or graph view. By default, the graphs display data for the last 6 hours.
For more information about status codes, see Vitals Status Codes.
Vitals terms
- Request Count
- Displays a count of all proxy requests received. This includes requests that were rejected due to rate limiting, failed authentication, and so on.
- Status Codes
- Displays visualizations of cluster-wide status code classes (1xx, 2xx, 3xx, 4xx, 5xx). The Status Codes view contains the counts of status code classes graphed over time, as well as the ratio of code classes to total requests.
- Timeframe selector
- Controls the timeframe of data visualized, which indirectly controls the granularity of the data. For example, the “5M” selection displays 5 minutes in 1-second resolution data, while longer time frames display minute, hour, or days resolution data.
- Traffic metrics
- Provide insight into which of your Services and Service versions are being used and how they are responding.
Summary and Next Steps
In this topic, you viewed the health and monitoring information for Services, Service versions, and Routes.
Next, learn how to export a report of Vitals performance information.