Monitor API traffic and understand usage with Moesif’s user-centric API analytics, including:
- Understand API adoption and usage with user behavior analytics
- Quickly debug functional and performance issues
- Monitor for issues impacting customers
- Create live dashboards and share with colleagues
- Embed API logs in your app to improve developer experience
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} is 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}/plugins \
--data "name=kong-plugin-moesif" \
--data "config.application_id=MY_MOESIF_APPLICATION_ID"
{route} is the id or name of the Route that this plugin configuration will target.
Enabling the plugin on a Consumer
Configure this plugin on a Consumer with:
$ curl -X POST http://kong:8001/consumers/{consumer}/plugins \
--data "name=kong-plugin-moesif" \
--data "config.application_id=MY_MOESIF_APPLICATION_ID"
{consumer} is the id or username of the Consumer that this plugin configuration will target.
You can combine consumer.id and service.id in the same request, to further 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
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.
Plugins can be configured using the http://kong:8001/plugins/ endpoint.
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
| Form Parameter | Description |
|---|---|
name | The name of the plugin to use, in this case kong-plugin-moesif |
service.id | The ID of the Service the plugin targets. |
route.id | The ID of the Route the plugin targets. |
consumer.id | The ID of the Consumer the plugin targets. |
enableddefault value: true | Whether this plugin will be applied. |
api_id | The ID of the API the plugin targets. Note: The API Entity is deprecated in favor of Services since CE 0.13.0 and EE 0.32. |
config.application_id
|
Your Moesif Application Id from your Moesif dashboard. Go to Top Right Menu -> Installation. |
config.api_endpoint
optional default value:
|
URL for the Moesif Collection API (Only modify if secure proxy is used). |
config.timeout
optional default value:
|
An optional timeout in milliseconds when sending data to Moesif. |
config.keepalive
optional default value:
|
An optional value in milliseconds that defines for how long an idle connection will live before being closed. |
config.api_version
optional default value:
|
An optional API Version you want to tag this request with |
config.disable_capture_request_body
optional default value:
|
Set to true to disable logging of request body. |
config.disable_capture_response_body
optional default value:
|
Set to true to disable logging of response body. |
config.request_header_masks
optional default value:
|
An array of request header fields to mask. |
config.request_header_masks
optional default value:
|
An array of request body fields to mask. |
config.response_header_masks
optional default value:
|
An array of response header fields to mask. |
config.response_body_masks
optional default value:
|
An array of response body fields to mask. |
config.debug
optional default value: false |
An option if set to true, prints internal log messages for debugging integration issues. |
config.user_id_header
optional default value: |
An optional field name to identify a User from a request or response header. |
config.company_id_header
optional default value: |
An optional field name to identify a Company (Account) from a request or response header. |
How it works
When enabled, this plugin will monitor API traffic and log to Moesif API Analytics. Use Moesif to understand API adoption and resolve issues quickly.
Moesif natively supports REST, GraphQL, 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