Skip to content

Commit a9c6549

Browse files
jamietannajamietanna
authored
docs(metrics): document custom Prometheus metrics (#769)
1 parent d7ee1f7 commit a9c6549

1 file changed

Lines changed: 96 additions & 0 deletions

File tree

‎docs/api.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,102 @@ This endpoint exposes Prometheus-compatible metrics.
3434

3535
Controlled by `MEND_RNV_API_ENABLE_PROMETHEUS_METRICS` (backward compatible with `MEND_RNV_PROMETHEUS_METRICS_ENABLED`)
3636

37+
A number of default metrics are exposed by Node.JS.
38+
39+
Additionally, the following custom metrics are exposed:
40+
41+
<table>
42+
<thead>
43+
<tr>
44+
<th>Metric</th>
45+
<th>Type</th>
46+
<th>Description</th>
47+
<th>Comments</th>
48+
</tr>
49+
</thead>
50+
<tbody>
51+
<tr>
52+
<td>
53+
<code>mend_renovate_queue_size</code>
54+
</td>
55+
<td>
56+
<code>gauge</code>
57+
</td>
58+
<td>
59+
Current size of various queue types.
60+
</td>
61+
<td>
62+
Contains a number of queue types:
63+
<!-- don't indent further or add a newline above this line, as Markdown rendering will make it a code block -->
64+
<ul>
65+
<li>
66+
<code>scheduledAll</code>
67+
</li>
68+
<li>
69+
<code>scheduledHot</code>
70+
</li>
71+
<li>
72+
<code>scheduledCold</code>
73+
</li>
74+
<li>
75+
<code>scheduledCapped</code>
76+
</li>
77+
<li>
78+
<code>requested</code>
79+
</li>
80+
</ul>
81+
<!-- don't indent further -->
82+
</td>
83+
</tr>
84+
<tr>
85+
<td>
86+
<code>mend_renovate_queue_max_wait</code>
87+
</td>
88+
<td>
89+
<code>gauge</code>
90+
</td>
91+
<td>
92+
Current age in seconds of the oldest entry in each queue type.
93+
</td>
94+
<td>
95+
Contains a number of queue types:
96+
<!-- don't indent further or add a newline above this line, as Markdown rendering will make it a code block -->
97+
<ul>
98+
<li>
99+
<code>scheduledAll</code>
100+
</li>
101+
<li>
102+
<code>scheduledHot</code>
103+
</li>
104+
<li>
105+
<code>scheduledCold</code>
106+
</li>
107+
<li>
108+
<code>scheduledCapped</code>
109+
</li>
110+
<li>
111+
<code>requested</code>
112+
</li>
113+
</ul>
114+
<!-- don't indent further -->
115+
</td>
116+
</tr>
117+
<tr>
118+
<td>
119+
<code>mend_renovate_job_wait_time</code>
120+
</td>
121+
<td>
122+
<code>summary</code>
123+
</td>
124+
<td>
125+
Total time taken for a job from being enqueued to execution.
126+
</td>
127+
<td>
128+
</td>
129+
</tr>
130+
</tbody>
131+
</table>
132+
37133
### System API Routes
38134

39135
```

0 commit comments

Comments
 (0)