Moesif API Monetization and Analytics

Third Party

Overview Examples Configuration reference

Configuration

configobject

Hide Child Parameters

api_endpointstring

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

Default:https://api.moesif.net

api_versionstring

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

Default:1.0

application_idstring

Your Moesif Application Id from your Moesif dashboard. Go to Bottom Left Menu -> Installation.

authorization_company_id_fieldstring

Field name in JWT/OpenId token’s payload for identifying companies. Only applicable if authorization_header_name is set and is a Bearer token. See identifying companies.

Default:null

authorization_header_namestring

Request header containing a Bearer or basic token to extract user id. See identifying users. Also, supports a comma-separated string. The plugin will check headers in order “X-Api-Key, Authorization”. See identifying users.

Default:authorization

authorization_user_id_fieldstring

Field name in JWT/OpenId token’s payload for identifying users. Only applicable if authorization_header_name is set and is a Bearer token. See identifying users.

Default:sub

batch_sizenumber

Maximum batch size when sending to Moesif.

Default:200

company_id_headerstring

Request or response header used to identify the Company (Account) in Moesif. See identifying companies.

Default:null

connect_timeoutnumber

Timeout in milliseconds when connecting to Moesif.

Default:1000

debugboolean

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

Default:false

disable_capture_request_bodyboolean

Disable logging of request body.

Default:false

disable_capture_response_bodyboolean

Disable logging of response body.

Default:false

disable_gzip_payload_decompressionboolean

If set to true, disables decompressing body in Kong.

Default:false

disable_transaction_idboolean

Disable adding the X-Moesif-Transaction-Id response header for debugging.

Default:false

event_queue_sizenumber

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.

Default:1000

keepalivenumber

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

Default:5000

max_callback_time_spentnumber

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

Default:750

request_body_masksobject

An array of request body fields to mask.

Default:{}

request_header_masksobject

An array of request header fields to mask.

Default:{}

request_max_body_size_limitnumber

Maximum request body size in bytes to log in Moesif.

Default:100000

request_query_masksobject

An array of query string parameter fields to mask.

Default:{}

response_body_masksobject

An array of response body fields to mask.

Default:{}

response_header_masksobject

An array of response header fields to mask.

Default:{}

response_max_body_size_limitnumber

Maximum response body size in bytes to log in Moesif.

Default:100000

send_timeoutnumber

Timeout in milliseconds when sending data to Moesif.

Default:2000

timeoutnumber

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

Default:1000

user_id_headerstring

Request or response header used to identify the User in Moesif. See identifying users.

Default:X-Consumer-Custom-Id

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

protocolsarray[string]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudp

Default:grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

Moesif API Monetization and Analytics

Configuration

Did this doc help?

Help us make these docs great!

Still need help