Moesif is an AI-powered API insights platform for:
- API Debugging
- API Monitoring
- API Analytics
Support for REST, GraphQL, Ethereum Web3, JSON-RPC, SOAP, & more
Get real-time visibility into your (or your 3rd party) live API traffic saving you debug time.
- Understand how your customers actually use your API
- Root cause issues quickly with ML powered features like Smart Diff
- Get Slack and PagerDuty alerts of anomalous API behavior that pings tests don’t catch
Terminology
plugin: a plugin executing actions inside Kong before or after a request has been proxied to the upstream API.Service: the Kong entity representing an external upstream API or microservice.Route: the Kong entity representing a way to map downstream requests to upstream services.Consumer: the Kong entity representing a developer or machine using the API. When using Kong, a Consumer only communicates with Kong which proxies every call to the said upstream API.Credential: a unique string associated with a Consumer, also referred to as an API key.upstream service: this refers to your own API/service sitting behind Kong, to which client requests are forwarded.API: a legacy entity used to represent your upstream services. Deprecated in favor of Services since CE 0.13.0 and EE 0.32.
Configuration
Enabling the plugin on a Service
Configure this plugin on a Service by making the following request:
$ curl -X POST http://kong:8001/services/{service}/plugins \
--data "name=kong-plugin-moesif" \
--data "config.application_id=MY_MOESIF_APPLICATION_ID"
service: the id or name of the Service that this plugin configuration will target.
Enabling the plugin on a Route
Configure this plugin on a Route with:
$ curl -X POST http://kong:8001/routes/{route_id}/plugins \
--data "name=kong-plugin-moesif" \
--data "config.application_id=MY_MOESIF_APPLICATION_ID"
route_id: the id of the Route that this plugin configuration will target.
Enabling the plugin on a Consumer
You can use the http://localhost:8001/plugins endpoint to enable this plugin
on specific Consumers:
$ curl -X POST http://kong:8001/plugins \
--data "name=kong-plugin-moesif" \
--data "consumer_id={consumer_id}" \
--data "config.application_id=MY_MOESIF_APPLICATION_ID"
Where consumer_id is the id of the Consumer we want to associate with this
plugin.
You can combine consumer_id and
service_id
in the same request, to furthermore narrow the scope of the plugin.
Enabling the plugin on an API
If you are using an older version of Kong with the legacy API entity (deprecated in favor of Services since CE 0.13.0 and EE 0.32.), you can configure this plugin on top of such an API by making the following request:
$ curl -X POST http://kong:8001/apis/{api}/plugins \
--data "name=kong-plugin-moesif" \
--data "config.application_id=MY_MOESIF_APPLICATION_ID"
api: either id or name of the API that this plugin configuration will target.
Global plugins
All plugins can be configured using the http://kong:8001/plugins/ endpoint. A plugin which is not associated to any Service,
Route or Consumer (or API, if you are using an older version of Kong) is considered "global", and will be run on every request.
Read the Plugin Reference and the
Plugin Precedence sections for more information.
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
| form parameter | default | description |
|---|---|---|
name | The name of the plugin to use, in this case kong-plugin-moesif | |
service_id | The id of the Service which this plugin will target. | |
route_id | The id of the Route which this plugin will target. | |
enabled | true | Whether this plugin will be applied. |
consumer_id | The id of the Consumer which this plugin will target. | |
api_id | The id of the API which this plugin will target. Note: The API Entity is deprecated in favor of Services since CE 0.13.0 and EE 0.32. | |
config.application_id
|
The Moesif application token provided to you by Moesif. |
|
config.api_endpoint
optional |
|
URL for the Moesif API. |
config.timeout
optional |
|
An optional timeout in milliseconds when sending data to Moesif. |
config.keepalive
optional |
|
An optional value in milliseconds that defines for how long an idle connection will live before being closed. |
config.api_version
optional |
|
An optional API Version you want to tag this request with |
config.disable_capture_request_body
optional |
|
An option to disable logging of request body |
config.disable_capture_response_body
optional |
|
An option to disable logging of response body |
config.request_masks
optional |
|
An option to mask a specific request body field |
config.response_masks
optional |
|
An option to mask a specific response body field |
How it works
When enabled, this plugin will capture API requests and responses and log to Moesif API Insights for easy inspecting and real-time debugging of your API traffic.
Moesif natively supports REST, GraphQL, Ethereum Web3, SOAP, JSON-RPC, and more.
How to install
The .rock file is a self contained package that can be installed locally or from a remote server.
If the luarocks utility is installed in your system (this is likely the case if you used one of the official installation packages), you can install the ‘rock’ in your LuaRocks tree (a directory in which LuaRocks installs Lua modules).
It can be installed from luarocks repository by doing:
luarocks install --server=http://luarocks.org/manifests/moesif kong-plugin-moesif
Kong process errors
This logging plugin will only log HTTP request and response data. If you are looking for the Kong process error file (which is the nginx error file), then you can find it at the following path: