Skip to content

mod_offline

Module Description

This module implements an offline messages storage compliant with XEP-0160: Best Practices for Handling Offline Messages. It can store one-to-one and groupchat messages only when the recipient has no online resources. It is not well suited for applications supporting multiple user devices, because anything saved in the DB can be retrieved only once, so the message history is not synchronised between devices. Although mod_offline may be sufficient in some cases, it is preferable to use mod_mam.

If this module is disabled, an error 503 with text "Bounce offline message" would be sent back to the sender, each time a message is sent to an offline user. Check mod_offline_stub to disable this error message.

Options

modules.mod_offline.access_max_user_messages

  • Syntax: non-empty string
  • Default: "max_user_offline_messages"
  • Example: access_max_user_messages = "custom_max_user_offline_messages"

Access Rule to use for limiting the storage size per user.

modules.mod_offline.backend

  • Syntax: string, one of mnesia, rdbms
  • Default: "mnesia"
  • Example: backend = "rdbms"

Storage backend.

modules.mod_offline.store_groupchat_messages

  • Syntax: boolean
  • Default: false
  • Example: store_groupchat_messages = true

Specifies whether or not we should store groupchat messages.

Warning

This option can work only with MUC-light and is not expected to work with MUC.

Example Configuration

1
2
3
4
[modules.mod_offline]
  access_max_user_messages = "max_user_offline_messages"
  backend = "rdbms"
  store_groupchat_messages = true

Metrics

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

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

Backend in the action name can be either rdbms or mnesia.

Backend action Type Function Description (when it gets incremented)
mod_offline_Backend_count counter pop_messages Offline messages for a user are retrieved and deleted from a DB.
mod_offline_Backend_time histogram pop_messages Time spent retrieving and deleting offline messages for a user from a DB.
mod_offline_Backend_count counter write_messages New offline messages to a user are written in a DB.
mod_offline_Backend_time histogram write_messages Time spent writing a new offline messages to a user in a DB.
Backend action Type Description (when it gets incremented)
[HostType, mod_offline_Backend, pop_messages, count] spiral Offline messages for a user are retrieved and deleted from a DB.
[HostType, mod_offline_Backend, pop_messages, time] histogram Time spent retrieving and deleting offline messages for a user from a DB.
[HostType, mod_offline_Backend, write_messages, count] spiral New offline messages to a user are written in a DB.
[HostType, mod_offline_Backend, write_messages, time] histogram Time spent writing a new offline messages to a user in a DB.