Skip to content
Kong Summit 2022: Where API Innovation Runs Wild  —Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Konnect Cloud
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Kong Konnect Platform

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Request Demo
  • Kong Gateway
  • Konnect Cloud
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Kong Konnect Platform

  • Docs contribution guidelines
    • Overview of Konnect
    • Architecture
    • Network Resiliency and Availability
    • Port and Network Requirements
    • Compatibility
    • Release Notes
    • Overview
    • Access a Konnect Account
    • Set up a Runtime
    • Configure a Service
    • Implement and Test the Service
      • Publish and Consume Services
      • Register Applications
    • Import Kong Gateway Entities into Konnect Cloud
    • Overview
      • Konnect Services
      • Service Versions
      • Service Implementations
      • Manage Service Documentation
      • Overview
      • Configure a Plugin on a Service
      • Configure a Plugin on a Route
    • Overview
      • Overview
      • Manage Runtime Groups with UI
      • Manage Runtime Groups with decK
      • Install with Docker
      • Install on Kubernetes
      • Install on Linux
      • Upgrade a Runtime Instance to a New Version
      • Renew Certificates
      • Runtime Parameter Reference
      • Overview
      • Runtime Configuration
    • Troubleshoot
    • Overview
    • Access the Dev Portal
    • Sign Up for a Dev Portal Account
      • Manage Developer Access
      • Manage Application Registration Requests
      • Manage Application Connections
      • Auto Approve Dev and App Registrations
      • Azure OIDC
      • Application Overview
      • Enable and Disable App Registration
      • Create, Edit, and Delete an Application
      • Register an Application with a Service
      • Generate Credentials for an Application
    • Customize Dev Portal
    • Troubleshoot
    • Introduction to Vitals
    • Overview Dashboard
    • Analyze Services and Routes
    • Generate Reports
      • Manage a Konnect Account or Plan
      • Change to a Different Plan
      • Manage Payment Methods and Invoices
      • Overview
        • Overview
        • Manage Teams and Roles
        • Teams Reference
        • Roles Reference
      • Manage Users
      • Set up SSO with Okta
    • Account and Org Deactivation
    • Troubleshoot
    • Overview of Konnect
      • Access a Konnect Account
        • Manage a Konnect Account or Plan
        • Change to a Different Plan
        • Manage Payment Methods and Invoices
        • Manage Users and Roles
        • Set up SSO with Okta
      • Account and Org Deactivation
      • License Management
      • Port and Network Requirements
      • Network Resiliency and Availability
      • Migrate from Kong Gateway to Konnect Cloud
        • Set up a Runtime
        • Configure a Service
        • Implement and Test the Service
      • Manage Konnect Cloud with decK
      • Manage Services
        • Manage Service Documentation
        • Publish a Service to Dev Portal
        • Docker
        • Kubernetes
        • Linux
        • Runtime Parameter Reference
      • Upgrade a Runtime to a New Version
      • Renew Certificates
        • Developer Registration
        • Manage Developer Access
        • Auto Approve Dev and App Registrations
        • Application Overview
        • Create, Edit, and Delete an Application
        • Enable App Registration
        • Disable App Registration
        • Manage Application Registration Requests
        • Manage Application Connections
        • Register an Application with a Service
        • Generate Credentials for an Application
        • Appearance
        • Public Portal
        • Add a Custom Domain
      • Generating Vitals Reports
      • Configure a Plugin on a Service
      • Configure a Plugin on a Route
      • Configure Global or Consumer Plugins
    • Shared Config
      • Proxy Traffic

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • View Vitals performance for a Service
  • View Vitals performance for a Service version
  • View Vitals performance for a Route
  • Vitals terms
  • Summary and Next Steps
Konnect Cloud
  • Home
  • Konnect Cloud
  • Legacy

(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.
Note: The activity graphs in the ServiceHub only show the past 12 hours of activity. To see historical data for a greater range, generate a report.

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:

  1. From the ServiceHub, select a Service.

  2. 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.

  3. Select a timeframe to display. By default, the graph displays the last 6 hours of events.

Konnect Vitals Services View

View Vitals performance for a Service version

To view traffic health and performance for a Service version:

  1. From the ServiceHub, select a Service version.

  2. 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.

  3. Select a timeframe to display. By default, the graph displays the last 6 hours of events.

Konnect Vitals Service Version Status Codes

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:

  1. From the ServiceHub, select a Service version.

  2. In the Routes section, click on a Route.

  3. 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.

  4. 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.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2022