Module Description

This module implements XMPP Ping functionality as described in XEP-0199: XMPP Ping.

Options

• send_pings (boolean, default false): If set to true, the server will send ping iqs to the client if they are not active for a ping_interval.
• ping_interval (seconds, default 60): Defines the client inactivity timeout after which the server will send a ping request if the above option is set to true.
• timeout_action (none | kill, default none): Defines if the client connection should be closed if it doesn't reply to a ping request in less than ping_req_timeout.
• ping_req_timeout (seconds, default 32) Defines how long the server waits for the client to reply to the ping request.
• iqdisc (default: no_queue)

Example Configuration

  {mod_ping, [{send_pings, true}]},

Metrics

If you'd like to learn more about metrics in MongooseIM, please visit MongooseIM metrics page.

Name	Type	Description (when it gets incremented)
[Host, mod_ping, ping_response]	spiral	Client responds to a ping.
[Host, mod_ping, ping_response_timeout]	spiral	Ping request timeouts without a response from client.
[Host, mod_ping, ping_response_time]	histogram	Response times (doesn't include timeouts).