Mercurial > prosody-modules
annotate mod_measure_process/README.md @ 6083:ffd0184cd478
mod_compliance_latest: New module that depends on and therefore loads the latest compliance tester mod.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
new file mode 100644
--- /dev/null
+++ b/mod_compliance_latest/README.md
@@ -0,0 +1,25 @@
+---
+summary: XMPP Compliance Suites self-test
+labels:
+- Stage-Beta
+rockspec:
+ dependencies:
+ - mod_compliance_2023
+...
+
+# Introduction
+
+This module will always require and load to the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023].
+
+# Configuration
+
+Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
+See the linked module for further details.
+
+# Compatibility
+
+ Prosody-Version Status
+ --------------- ----------------------
+ trunk Works as of 2024-12-22
+ 0.12 Works
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
new file mode 100644
--- /dev/null
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -0,0 +1,1 @@
+module:depends("compliance_2023");
| author | Menel <menel@snikket.de> |
|---|---|
| date | Sun, 22 Dec 2024 18:12:42 +0100 |
| parents | fe081789f7b5 |
| children |
| rev | line source |
|---|---|
|
4554
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
1 --- |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
2 labels: |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
3 - Statistics |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
4 summary: Measure process resource use metrics (cpu, memory, file descriptors) |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
5 --- |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
6 |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
7 Description |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
8 =========== |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
9 |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
10 This module exposes process resource use metrics similar to those exposed by |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
11 default when using a Prometheus client library. Specifically, the following |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
12 metrics are exposed: |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
13 |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
14 - CPU use |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
15 - Resident set and virtual memory size |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
16 - Number of open file descriptors and their limit |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
17 |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
18 This module uses the new OpenMetrics API and thus requires a recent version |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
19 of Prosody trunk (0.12+). |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
20 |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
21 Compatibility |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
22 ============= |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
23 |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
24 ------- ------------- |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
25 trunk Works |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
26 0.11 Does not work |
|
025cf93acfe9
mod_measure_process: Provide metrics about the process itself
Jonas Schäfer <jonas@wielicki.name>
parents:
diff
changeset
|
27 ------- ------------- |
