The Service Map for APM is here!

Kong

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

The Agent’s Kong check tracks total requests, response codes, client connections, and more.

Setup

Installation

The Kong check is included in the Datadog Agent package, so you don’t need to install anything else on your Kong servers.

Configuration

  1. Edit the kong.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample kong.d/conf.yaml for all available configuration options:

    init_config:
    
    instances:
        # Each instance needs a `kong_status_url`. Tags are optional.
        -   kong_status_url: http://example.com:8001/status/
            tags:
            - instance:foo
        #-   kong_status_url: http://example2.com:8001/status/
        #    tags:
        #    - instance:bar
  2. Restart the Agent to begin sending Kong metrics to Datadog.

Validation

Run the Agent’s status subcommand and look for kong under the Checks section.

Data Collected

Metrics

kong.table.count
(gauge)
Total number of tables in the database.
shown as table
kong.table.items
(gauge)
Number of items in each table of the database.
shown as row
kong.connections_accepted
(gauge)
Total number of accepted client connections.
shown as connection
kong.connections_active
(gauge)
Current number of active client connections including Waiting connections.
shown as connection
kong.connections_handled
(gauge)
Total number of handled connections. (Same as accepts unless resource limits were reached).
shown as connection
kong.connections_reading
(gauge)
Current number of connections where Kong is reading the request header.
shown as connection
kong.connections_waiting
(gauge)
Current number of idle client connections waiting for a request.
shown as connection
kong.connections_writing
(gauge)
Current number of connections where nginx is writing the response back to the client.
shown as connection
kong.total_requests
(gauge)
Total number of client requests.
shown as request

Events

The Kong check does not include any events at this time.

Service Checks

kong.can_connect:

Returns CRITICAL if the Agent cannot connect to Kong to collect metrics, otherwise OK.

Troubleshooting

Need help? Contact Datadog Support.

Further Reading


Mistake in the docs? Feel free to contribute!