Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
3.0.x
  • Home icon
  • Kong Gateway
  • Kong Enterprise
  • Vitals
  • Vitals Reports
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Prerequisites
  • Generate a Vitals Report
  • Export Vitals Data to a CSV Report
You are browsing documentation for an outdated version. See the latest documentation here.

Vitals Reports

Browse, filter, and view your data in a Vitals time-series report, and export the data into a comma-separated values (CSV) file.

When generating a Vitals report, you can:

  • Generate a report across all Workspaces or a single Workspace.
  • Filter report parameters, such as object, metric, metric type, and values.
  • Select the time period or interval for the report, such as minutes, hours, or days.
  • View a line chart that automatically generates depending on the selected criteria.
  • Export your report to a CSV file.

Prerequisites

InfluxDB database installed and configured. For more information, see Vitals with InfluxDB.

Important: The Vitals Reports feature is not compatible with any other database. If you’re not using InfluxDB, the Reports button will not display on the Vitals view.

Generate a Vitals Report

To create a time-series report containing Vitals data, complete the steps in this section.

  1. On the Vitals view, click the Reports button.

  2. On the Reports page select the Timeframe, up to 12 hours, for which you want to create the report.

  3. Select the report criteria for the report:

    Selection Description
    Report Type Consumer Requests: This report is for requests made by Consumers.
    Service Requests: This report is for services with a Service ID and name of the service that is stored in the Kong Gateway database.
    Cluster Latency: This report is the aggregation of two fields.
    Scope Drill down and filter for more detailed information.
    Interval Select the time interval to display in the report: weeks, hours, days, minutes. If you select an interval that is out of the available range, the results return zeroes.
  4. A Vitals report generates, starting with a summary of data in your report, including Id, Name, App Name, App Id, and Total. Note that the App Name and App Id are dependent on the Dev Portal App Registration plugin. For more information about status codes (2XX, 4XX, etc), see Vitals Metrics.

  5. To download your report, click Export. A CSV file containing your Vitals report data downloads to your system.

Export Vitals Data to a CSV Report

  1. Create a Vitals report, as defined above in Generate a Vitals Report.

  2. Click Export to download a CSV file to your system.

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • 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. 2023