Monitoring Kong

This article will help you get the Kong plugin for sd-agent configured and returning metrics

Installing the kong plugin package

Install the kong plugin on Debian/Ubuntu:

sudo apt-get install sd-agent-kong

Install the kong plugin on RHEL/CentOS:

sudo yum install sd-agent-kong

Read more about agent plugins.

Configuring the agent to monitor kong

1. Configure /etc/sd-agent/conf.d/kong.yaml

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/pre>

2. Restart the agent

sudo /etc/init.d/sd-agent restart

or

sudo systemctl restart sd-agent

Verifying the configuration
Execute info to verify the configuration with the following:

sudo /etc/init.d/sd-agent info 

or

/usr/share/python/sd-agent/agent.py info

If the agent has been configured correctly you'll see an output such as:

kong
-----
  - instance #0 [OK]
  - Collected * metrics

You can also view the metrics returned with the following command:

sudo -u sd-agent /usr/share/python/sd-agent/agent.py check kong

Configuring graphs

Click the name of your server from the Devices list in your Server Density account then go to the Metrics tab. Click the + Graph button on the right then choose the kong metrics to display the graphs. The metrics will also be available to select when building dashboard graphs.

Monitored metrics

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