mod_push_service_mongoosepush¶

Module Description¶

This module handles the push_notifications hook generated either by mod_pubsub_old with an active push node, or by mod_event_pusher_push module's virtual pubsub host. Each notification is sent to MongoosePush as a POST /<api_version>/notification/<device_id> request.

Request parameters¶

Below is a summary of all parameters used when sending requests to MongoosePush. See the MongoosePush request documentation for their detailed meaning and default values. The listed publish options are set when enabling push notifications.

For message notifications, the remaining parameters depend on the notification type, determined by the silent publish option. By default, it is set to false, resulting in alert notifications with the following parameters:

When silent is set to true, MongooseIM sends silent (data-only) notifications with the parameters defined in XEP-0357: Push Notifications:

For Jingle Message Initiation (JMI) notifications triggered by the content = "jingle" rule, regardless of the silent option, MongooseIM sends requests containing data and no alert, with the following parameters:

Prerequisites¶

This module uses a connection pool via mongoose_http_client. It must be defined in outgoing_pools setting.

Options¶

modules.mod_push_service_mongoosepush.pool_name¶

• Syntax: non-empty string
• Default: "undefined"
• Example: pool_name = "mongoose_push_http"

The name of the pool to use (as defined in outgoing_pools).

modules.mod_push_service_mongoosepush.api_version¶

• Syntax: string, "v2" or "v3"
• Default: "v3"
• Example: api_version = "v3"

REST API version to be used.

modules.mod_push_service_mongoosepush.async_sender¶

• Syntax: TOML section
• Default: not declared
• Example: [modules.mod_push_service_mongoosepush.async_sender]

Enables asynchronous, batched push notification delivery. When disabled, push requests are sent synchronously, which may increase message processing time.

modules.mod_push_service_mongoosepush.async_sender.flush_interval¶

• Syntax: non-negative integer
• Default: 2000
• Example: modules.mod_push_service_mongoosepush.async_sender.flush_interval = 1000

How often (in milliseconds) the buffered push notifications are sent.

modules.mod_push_service_mongoosepush.async_sender.batch_size¶

• Syntax: non-negative integer
• Default: 30
• Example: modules.mod_push_service_mongoosepush.async_sender.batch_size = 20

Maximum number of messages in a batch before the queue is considered full and push notifications are sent. When the buffer is full, push notifications are sent immediately and the flush timer is reset.

modules.mod_push_service_mongoosepush.async_sender.pool_size¶

• Syntax: non-negative integer
• Default: 4 * erlang:system_info(schedulers_online)
• Example: modules.mod_push_service_mongoosepush.async_sender.pool_size = 32

Number of workers in the pool. Increasing the number of workers can improve throughput by allowing more messages to be processed concurrently. The optimal pool size depends on the deployment and can be fine-tuned to achieve the best performance.

Example configuration¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

[outgoing_pools.http.mongoose_push_http]
  scope = "global"
  workers = 50

  [outgoing_pools.http.mongoose_push_http.connection]
    host = "https://localhost:8443"
    path_prefix = "/"
    request_timeout = 2000

[modules.mod_push_service_mongoosepush]
  pool_name = "mongoose_push_http"
  api_version = "v3"

  [modules.mod_push_service_mongoosepush.async_sender]
    flush_interval = 5000
    batch_size = 50
    pool_size = 100

Metrics¶

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

Prometheus metrics have a host_type label associated with these metrics. Since Exometer doesn't support labels, the host types, or word global, are part of the metric names, depending on the instrumentation.exometer.all_metrics_are_global option.