Kong Datastore Reachability Test

Datastore Reachability refers to the gateway’s ability to connect to its underlying database (PostgreSQL or Cassandra). This connection is critical for storing and retrieving configuration data. If the datastore is unreachable, Kong cannot operate properly, affecting routing, plugins, and overall API management functionality.

Monitoring Kong API Datastore Reachability helps administrators quickly detect connectivity issues, prevent downtime, ensure configuration consistency, and maintain gateway stability by addressing database problems before they impact API services.

This test reports if Datastore is reachable so that administrators can take corrective actions in timely manner.

Target of the test : A Kong API Gateway

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for the target Kong API Server being monitored.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

The IP address of the host for which this test is to be configured.

Port

Specify the port at which the specified Host listens. By default, this is 8001.

SSL Enabled

If the Kong API Gateway uses the HTTPS protocol, set the SSL ENABLED test parameter to Yes. By default, this parameter is set to No.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

Is reachable?

Indicates if the datastore for this Kong API Gateway is available or not.

 

The values that this measure can report and their corresponding numeric values are tabulated below:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values that indicate the If Kong API Gateway datastore is reachable. However, the graph of this measure will be represented using the corresponding numeric equivalents of the measure values as mentioned in the table above.