Skip to content

Commit 3bf7b3b

Browse files
DOCSP-47157 doc for Ops Manager Prometheus /metrics endpoint-v7.0-backport (836) (#888)
# Backport This will backport the following commits from `master` to `v7.0`: - [DOCSP-47157 doc for Ops Manager Prometheus /metrics endpoint (#836)](10gen/docs-ops-manager#836) <!--- Backport version: 9.6.1 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) Co-authored-by: John Williams <[email protected]>
1 parent 7f771b7 commit 3bf7b3b

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
@@ -249,6 +249,48 @@ assignments.
249249

250250
.. include:: /includes/setting-fileConf-mms.publicApi.whitelistEnabled.rst
251251

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

0 commit comments

Comments
 (0)