Skip to content

Commit 1520d53

Browse files
DOCSP-47157 doc for Ops Manager Prometheus /metrics endpoint (#836)
<!-- Add a description of your PR here (optional) --> - [DOCSP-47157](https://jira.mongodb.org/browse/DOCSP-47157) - [STAGING](https://deploy-preview-836--docs-ops-manager.netlify.app/reference/configuration/#prometheus) ### Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [ ] Resolve any new warnings or errors in the build. - [ ] Proofread for spelling and grammatical errors. - [ ] Check staging for rendering issues. - [ ] Confirm links are working. --------- Co-authored-by: John Williams <[email protected]>
1 parent 1d655e9 commit 1520d53

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. setting:: prom.listening.enabled
2+
3+
*Type*: boolean
4+
5+
Flag that specifies whether to enable access for Prometheus. To
6+
enable |mms| Prometheus endpoint, set value to ``true``. If omitted,
7+
defaults to ``false``.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. setting:: prom.listening.port
2+
3+
*Type*: number
4+
5+
The port over which |mms| listens for requests to the Prometheus
6+
endpoint. The port must be different than the port |mms| is already
7+
listening on, 8080 for |http| or 8443 for |https|. Every server will
8+
listen on the specified port. So, ensure that the port is available
9+
as an open port on every server. If you want to specify different
10+
port for each server, use ``conf-mms.properties`` instead to specify
11+
the ports.

source/reference/configuration.txt

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,48 @@ assignments.
252252

253253
.. include:: /includes/setting-fileConf-mms.publicApi.accesslistEnabled.rst
254254

255+
Prometheus
256+
----------
257+
258+
You must configure the following settings to enable the metrics that are
259+
available for ingestion through Prometheus. You can also configure these
260+
settings in the :guilabel:`Custom` tab of the :ref:`Ops Manager Config
261+
<admin-console-general-om-config>` page in the
262+
:ref:`admin-console-general-tab`.
263+
264+
After configuring these settings, you must restart |mms| on each
265+
instance. After restarting, the new Prometheus endpoint can be
266+
accessed at a |url| in the following format:
267+
268+
.. code-block:: shell
269+
270+
http(s)://<opsManagerUri>:<port>/metrics
271+
272+
.. note::
273+
274+
You can designate a listening port for the Prometheus metrics. This
275+
doesn't have to be the default port that |mms| uses, 8080 for |http| or
276+
8443 for |https|. Ensure that your network allows traffic to the
277+
specified Prometheus metrics port.
278+
279+
After enabling, you must configure a new scrape config similar to the
280+
following in Prometheus for each |onprem| server that you would like to
281+
gather statistics from.
282+
283+
.. code-block:: shell
284+
:caption: scrape_config
285+
286+
scrape_configs:
287+
288+
- job_name: 'opsmanager'
289+
static_configs:
290+
- targets: [<opsManagerHostname>:<port>]
291+
292+
Note that each server's endpoint only provides metrics for the same server.
293+
294+
.. include:: /includes/setting-fileConf-mms.prom.listening.enabled.rst
295+
.. include:: /includes/setting-fileConf-mms.prom.listening.port.rst
296+
255297
Push Live Migrations
256298
--------------------
257299

0 commit comments

Comments
 (0)