Kong Gateway (deprecated) 🔗

Caution

The Kong monitor is deprecated and is no longer supported. Do not use it to send data to Splunk Observability Cloud.

To monitor your Kong traffic metrics with the Splunk Distribution of the OpenTelemetry Collector use the native OTel Prometheus receiver. The receiver uses the Kong metrics Prometheus endpoint, which emits metrics for configurable request and response lifecycle groups, including:

Counters for response counts
Counters for cumulative response and request sizes
Counters for cumulative request, upstream, and Kong latencies

You can partition request and response lifecycle groups by:

API or Service Name/ID
Route ID
Request HTTP Method
Response HTTP Status Code

In addition, the integration provides system-wide connection statistics, including:

A counter for total fielded requests
Gauges for active connections and their various states
A gauge for database connectivity

To learn more:

About the Kong metrics Prometheus endpoint, see the official Kong documentation on Prometheus.
About using the Prometheus receiver to monitor applications, see the Configure applications with Prometheus metrics doc.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata catalog.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Kong installation 🔗

Follow the official Kong instructions to expose the Prometheus metrics endpoint. To learn how, see the official Kong documentation on Prometheus. Use Kong version 3.4 or higher.

Configuration 🔗

Configure the Prometheus receiver with Kong as shown:

prometheus/kong:
   config:
      scrape_configs:
         - job_name: 'kong'
         scrape_interval: 10s
         static_configs:
            - targets: ['0.0.0.0:8001']

Next, activate the metrics pipeline:

metrics:
   receivers: [hostmetrics, otlp, signalfx, prometheus/kong]

Metrics 🔗

For the complete list of metrics provided by the integration, refer to Kong Docs on Prometheus.

Notes 🔗

To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

This page was last updated on Oct 07, 2024.

Related Topics