Skip to content
Kong Gateway 2.8 Increases Security and Simplifies API Management.  —Learn More →
|
search
Plugin Hub
header icon

Moesif API Analytics

Monitor API logs and usage metrics in Moesif, which enables you to:

This plugin supports automatic analysis of high-volume REST, GraphQL, and other APIs without adding latency.

How it works

When enabled, this plugin captures API traffic and logs it to Moesif API Analytics. This plugin logs to Moesif with an asynchronous design and doesn’t add any latency to your API calls.

Package on Luarocks

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

Configuration Reference

This plugin is not compatible with DB-less mode.

Enable the plugin on a service

For example, configure this plugin on a service by making the following request:

curl -X POST http://{HOST}:8001/services/{SERVICE}/plugins \
    --data "name=moesif"  \
    --data "config.application_id=MY_MOESIF_APPLICATION_ID"

SERVICE is the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <moesif-example>
config: 
  application_id: MY_MOESIF_APPLICATION_ID
plugin: moesif

Next, apply the KongPlugin resource to a Service by annotating the Service as follows:

apiVersion: v1
kind: Service
metadata:
  name: {SERVICE}
  labels:
    app: {SERVICE}
  annotations:
    konghq.com/plugins: <moesif-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: {SERVICE}
  selector:
    app: {SERVICE}

{SERVICE} is the id or name of the service that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a service by adding this section to your declarative configuration file:

plugins:
- name: moesif
  service: {SERVICE}
  config: 
    application_id: MY_MOESIF_APPLICATION_ID

SERVICE is the id or name of the service that this plugin configuration will target.

Enable the plugin on a route

For example, configure this plugin on a route with:

$ curl -X POST http://{HOST}:8001/routes/{ROUTE}/plugins \
    --data "name=moesif"  \
    --data "config.application_id=MY_MOESIF_APPLICATION_ID"

ROUTE is the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <moesif-example>
config: 
  application_id: MY_MOESIF_APPLICATION_ID
plugin: moesif

Then, apply it to an ingress (Route or Routes) by annotating the ingress as follows:

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: {ROUTE}
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <moesif-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80

ROUTE is the id or name of the route that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a route by adding this section to your declarative configuration file:

plugins:
- name: moesif
  route: <route>
  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

For example, configure this plugin on a consumer with:

$ curl -X POST http://{HOST}:8001/consumers/{CONSUMER}/plugins \
    --data "name=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, service.id, or route.id in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <moesif-example>
config: 
  application_id: MY_MOESIF_APPLICATION_ID
plugin: moesif

Then, apply it to a consumer by annotating the KongConsumer resource as follows:

apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: {CONSUMER}
  annotations:
    konghq.com/plugins: <moesif-example>
    kubernetes.io/ingress.class: kong

CONSUMER is the id or username of the consumer that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any Service, Consumer, or Route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a consumer by adding this section to your declarative configuration file:

plugins:
- name: moesif
  consumer: {CONSUMER}
  config: 
    application_id: MY_MOESIF_APPLICATION_ID

CONSUMER is the id or username of the consumer that this plugin configuration will target.

Enable the plugin globally

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

For example, configure this plugin globally with:

$ curl -X POST http://{HOST}:8001/plugins/ \
    --data "name=moesif"  \
    --data "config.application_id=MY_MOESIF_APPLICATION_ID"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-moesif>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  application_id: MY_MOESIF_APPLICATION_ID
plugin: moesif

For example, configure this plugin using the plugins: entry in the declarative configuration file:

plugins:
- name: moesif
  config: 
    application_id: MY_MOESIF_APPLICATION_ID

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

Form Parameter Description
name
required

Type: string		 The name of the plugin, in this case moesif.
service.id

Type: string		 The ID of the Service the plugin targets.
route.id

Type: string		 The ID of the Route the plugin targets.
consumer.id

Type: string		 The ID of the Consumer the plugin targets.
enabled
required

Type: boolean

Default value: true		 Whether this plugin will be applied.
api_id

Type: string		 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
required

Your Moesif Application Id from your Moesif dashboard. Go to Top Right Menu -> Installation.
config.api_endpoint
optional

Default value: https://api.moesif.net

URL for the Moesif Collection API (Change to your secure proxy hostname if client-side encryption is used).
config.connect_timeout
optional

Default value: 1000

Timeout in milliseconds when connecting to Moesif.
config.send_timeout
optional

Default value: 2000

Timeout in milliseconds when sending data to Moesif.
config.timeout
optional

Default value: 1000

(Deprecated) timeout in milliseconds when connecting/sending to Moesif.
config.keepalive
optional

Default value: 5000

Value in milliseconds that defines for how long an idle connection will live before being closed.
config.api_version
optional

Default value: 1.0

API Version you want to tag this request with in Moesif.
config.user_id_header
optional

Default value: X-Consumer-Custom-Id

Request or response header to use to identify the User in Moesif.
config.company_id_header
optional

Default value:

Request or response header to use to identify the Company (Account) in Moesif.
config.disable_capture_request_body
optional

Default value: false

Disable logging of request body.
config.disable_capture_response_body
optional

Default value: false

Disable logging of response body.
config.request_header_masks
optional

Default value: {}

An array of request header fields to mask.
config.request_query_masks
optional

Default value: {}

An array of query string parameter fields to mask.
config.request_body_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.batch_size
optional

Default value: 200

Maximum batch size when sending to Moesif.
config.event_queue_size
optional

Default value: 5000

Maximum number of events to hold in the queue before sending to Moesif. In case of network issues where the plugin is unable to connect or send an event to Moesif, skips adding new events to the queue to prevent memory overflow.
config.disable_gzip_payload_decompression
optional

Default value: false

If set to true, disables decompressing body in Kong.
config.max_callback_time_spent
optional

Default value: 2000

Limits the amount of time in milliseconds to send events to Moesif per worker cycle.
config.request_max_body_size_limit
optional

Default value: 100000

Maximum request body size in bytes to log in Moesif.
config.response_max_body_size_limit
optional

Default value: 100000

Maximum response body size in bytes to log in Moesif.
config.debug
optional

Default value: false

An option if set to true, prints internal log messages for debugging integration issues.