Skip to content

Commit

Permalink
Update metrics description in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrzaszcz committed Jun 19, 2024
1 parent f145184 commit 7baafa9
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 23 deletions.
4 changes: 2 additions & 2 deletions doc/modules/mod_register.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ If you'd like to learn more about metrics in MongooseIM, please visit [MongooseI

| Name | Type | Description (when it gets incremented) |
| ---- | ---- | -------------------------------------- |
| `[Host, modRegisterCount]` | spiral | A user registers via `mod_register` module. |
| `[Host, modUnregisterCount]` | spiral | A user unregisters via `mod_register` module. |
| `[Host, auth_register, count]` | spiral | A user registers via `mod_register` module. |
| `[Host, auth_unregister, count]` | spiral | A user unregisters via `mod_register` module. |

## Entropy calculation algorithm

Expand Down
4 changes: 2 additions & 2 deletions doc/operation-and-maintenance/Logging-&-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ For time-based metrics, you can choose to display multiple calculated values for
Session count: <prefix>.global.totalSessionCount.value
XMPP messages received: <prefix>.<domain>.xmppMessageReceived.one
XMPP messages sent: <prefix>.<domain>.xmppMessageSent.one
Successful logins: <prefix>.<domain>.sessionSuccessfulLogins.one
Logouts: <prefix>.<domain>.sessionLogouts.one
Successful logins: <prefix>.<domain>.sm_session.logins.one
Logouts: <prefix>.<domain>.sm_session.logouts.one
Authorization time: <prefix>.<domain>.backends.auth.authorize.<value-type>
RDBMS "simple" query time: <prefix>.<domain>.backends.mongoose_rdbms.query.<value-type>
RDBMS prepared query time: <prefix>.<domain>.backends.mongoose_rdbms.execute.<value-type>
Expand Down
34 changes: 17 additions & 17 deletions doc/operation-and-maintenance/MongooseIM-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,33 +96,33 @@ As a result it makes more sense to maintain a list of the most relevant or usefu

| Name | Type | Description (when it gets incremented) |
| ---- | ---- | -------------------------------------- |
| `[HostType, modPresenceSubscriptions]` | spiral | Presence subscription is processed. |
| `[HostType, modPresenceUnsubscriptions]` | spiral | Presence unsubscription is processed. |
| `[HostType, modRosterGets]` | spiral | User's roster is fetched. |
| `[HostType, modRosterPush]` | spiral | A roster update is pushed to a single session. |
| `[HostType, modRosterSets]` | spiral | User's roster is updated. |
| `[HostType, sm_presence_subscription, subscription_count]` | spiral | Presence subscription is processed. |
| `[HostType, sm_presence_subscription, unsubscription_count]` | spiral | Presence unsubscription is processed. |
| `[HostType, mod_roster_get, count]` | spiral | User's roster is fetched. |
| `[HostType, mod_roster_push, count]` | spiral | A roster update is pushed to a single session. |
| `[HostType, mod_roster_set, count]` | spiral | User's roster is updated. |

### Privacy lists

| Name | Type | Description (when it gets incremented) |
| ---- | ---- | -------------------------------------- |
| `[HostType, modPrivacyGets]` | spiral | IQ privacy `get` is processed. |
| `[HostType, modPrivacyPush]` | spiral | Privacy list update is sent to a single session. |
| `[HostType, modPrivacySets]` | spiral | IQ privacy `set` is processed. |
| `[HostType, modPrivacySetsActive]` | spiral | Active privacy list is changed. |
| `[HostType, modPrivacySetsDefault]` | spiral | Default privacy list is changed. |
| `[HostType, modPrivacyStanzaAll]` | spiral | A packet is checked against the privacy list. |
| `[HostType, modPrivacyStanzaDenied]` | spiral | Privacy list check resulted in `deny`. |
| `[HostType, modPrivacyStanzaBlocked]` | spiral | Privacy list check resulted in `block`. |
| `[HostType, mod_privacy_get, count]` | spiral | IQ privacy `get` is processed. |
| `[HostType, mod_privacy_push_item, count]` | spiral | Privacy list update is sent to a single session. |
| `[HostType, mod_privacy_set, count]` | spiral | IQ privacy `set` is processed. |
| `[HostType, mod_privacy_set, active_count]` | spiral | Active privacy list is changed. |
| `[HostType, mod_privacy_set, default_count]` | spiral | Default privacy list is changed. |
| `[HostType, mod_privacy_check_packet, count]` | spiral | A packet is checked against the privacy list. |
| `[HostType, mod_privacy_check_packet, denied_count]` | spiral | Privacy list check resulted in `deny`. |
| `[HostType, mod_privacy_check_packet, blocked_count]` | spiral | Privacy list check resulted in `block`. |

### Other

| Name | Type | Description (when it gets incremented) |
| ---- | ---- | -------------------------------------- |
| `[HostType, sessionAuthFails]` | spiral | A client failed to authenticate. |
| `[HostType, sessionCount]` | counter | Number of active sessions. |
| `[HostType, sessionLogouts]` | spiral | A client session is closed. |
| `[HostType, sessionSuccessfulLogins]` | spiral | A client session is opened. |
| `[HostType, c2s_auth_failed, count]` | spiral | A client failed to authenticate. |
| `[HostType, sm_session, count]` | counter | Number of active sessions. |
| `[HostType, sm_session, logouts]` | spiral | A client session is closed. |
| `[HostType, sm_session, logins]` | spiral | A client session is opened. |
| `[HostType, xmppErrorIq]` | spiral | An `error` IQ is sent to a client. |
| `[HostType, xmppErrorMessage]` | spiral | An `error` message is sent to a client. |
| `[HostType, xmppErrorPresence]` | spiral | An `error` presence is sent to a client. |
Expand Down
4 changes: 2 additions & 2 deletions doc/rest-api/Administration-backend_swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ paths:
metrics:
type: object
example:
modRosterPush:
mod_roster_push.count:
one: 0
count: 0
/metrics/all/{metric}:
Expand Down Expand Up @@ -881,7 +881,7 @@ paths:
metrics:
type: object
example:
modRosterPush:
mod_roster_push.count:
one: 0
count: 0
404:
Expand Down

0 comments on commit 7baafa9

Please sign in to comment.