annotate mod_measure_process/README.markdown @ 5472:b80b6947b079

mod_http_oauth2: Always show early errors to user Before having validated the client_id, communicating an error back to the client via redirect would make this an open redirect, so we may just as well skip past that logic, and especially the warning log message.
author Kim Alvefur <zash@zash.se>
date Thu, 18 May 2023 13:43:17 +0200
parents 025cf93acfe9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 ------- -------------