Merge pull request ceph#55050 from rhcs-dashboard/nfs-monitoring

mgr/nfs: scrape nfs monitoring endpoint

Reviewed-by: Adam King <[email protected]>
Reviewed-by: Redouane Kachach <[email protected]>

Author: adk3798

src/pybind/mgr/cephadm/service_discovery.py

@@ -12,6 +12,7 @@ class Server:  # type: ignore
 from mgr_module import ServiceInfoT
 from mgr_util import build_url
 from typing import Dict, List, TYPE_CHECKING, cast, Collection, Callable, NamedTuple, Optional, IO
+from cephadm.services.nfs import NFSService
 from cephadm.services.monitoring import AlertmanagerService, NodeExporterService, PrometheusService
 import secrets
 from mgr_util import verify_tls_files
@@ -147,6 +148,7 @@ def index(self) -> str:
 <p><a href='prometheus/sd-config?service=haproxy'>HAProxy http sd-config</a></p>
 <p><a href='prometheus/sd-config?service=ceph-exporter'>Ceph exporter http sd-config</a></p>
 <p><a href='prometheus/sd-config?service=nvmeof'>NVMeoF http sd-config</a></p>
+<p><a href='prometheus/sd-config?service=nfs'>NFS http sd-config</a></p>
 <p><a href='prometheus/rules'>Prometheus rules</a></p>
 </body>
 </html>'''
@@ -167,6 +169,8 @@ def get_sd_config(self, service: str) -> List[Dict[str, Collection[str]]]:
             return self.ceph_exporter_sd_config()
         elif service == 'nvmeof':
             return self.nvmeof_sd_config()
+        elif service == 'nfs':
+            return self.nfs_sd_config()
         else:
             return []
 
@@ -248,6 +252,19 @@ def nvmeof_sd_config(self) -> List[Dict[str, Collection[str]]]:
             })
         return srv_entries
 
+    def nfs_sd_config(self) -> List[Dict[str, Collection[str]]]:
+        """Return <http_sd_config> compatible prometheus config for nfs service."""
+        srv_entries = []
+        for dd in self.mgr.cache.get_daemons_by_type('nfs'):
+            assert dd.hostname is not None
+            addr = dd.ip if dd.ip else self.mgr.inventory.get_addr(dd.hostname)
+            port = NFSService.DEFAULT_EXPORTER_PORT
+            srv_entries.append({
+                'targets': [build_url(host=addr, port=port).lstrip('/')],
+                'labels': {'instance': dd.hostname}
+            })
+        return srv_entries
+
     @cherrypy.expose(alias='prometheus/rules')
     def get_prometheus_rules(self) -> str:
         """Return currently configured prometheus rules as Yaml."""

src/pybind/mgr/cephadm/services/monitoring.py

@@ -470,6 +470,7 @@ def generate_config(
         ceph_exporter_sd_url = f'{srv_end_point}service=ceph-exporter'  # always included
         nvmeof_sd_url = f'{srv_end_point}service=nvmeof'  # always included
         mgmt_gw_enabled = len(self.mgr.cache.get_daemons_by_service('mgmt-gateway')) > 0
+        nfs_sd_url = f'{srv_end_point}service=nfs'  # always included
 
         alertmanager_user, alertmanager_password = self.mgr._get_alertmanager_credentials()
         prometheus_user, prometheus_password = self.mgr._get_prometheus_credentials()
@@ -490,7 +491,8 @@ def generate_config(
             'ceph_exporter_sd_url': ceph_exporter_sd_url,
             'nvmeof_sd_url': nvmeof_sd_url,
             'external_prometheus_targets': targets,
-            'cluster_fsid': FSID
+            'cluster_fsid': FSID,
+            'nfs_sd_url': nfs_sd_url
         }
 
         ip_to_bind_to = ''

src/pybind/mgr/cephadm/services/nfs.py

@@ -22,6 +22,7 @@
 
 class NFSService(CephService):
     TYPE = 'nfs'
+    DEFAULT_EXPORTER_PORT = 9587
 
     def ranked(self, spec: ServiceSpec) -> bool:
         return True

src/pybind/mgr/cephadm/templates/services/prometheus/prometheus.yml.j2

@@ -161,6 +161,26 @@ scrape_configs:
 {% endif %}
 {% endif %}
 
+{% if nfs_sd_url %}
+  - job_name: 'nfs'
+{% if security_enabled %}
+    honor_labels: true
+    scheme: https
+    tls_config:
+      ca_file: root_cert.pem
+    http_sd_configs:
+    - url: {{ nfs_sd_url }}
+      basic_auth:
+        username: {{ service_discovery_username }}
+        password: {{ service_discovery_password }}
+      tls_config:
+        ca_file: root_cert.pem
+{% else %}
+    http_sd_configs:
+    - url: {{ nfs_sd_url }}
+{% endif %}
+{% endif %}
+
 {% if not security_enabled %}
   - job_name: 'federate'
     scrape_interval: 15s
@@ -175,4 +195,3 @@ scrape_configs:
     static_configs:
     - targets: {{ external_prometheus_targets }}
 {% endif %}
-

src/pybind/mgr/cephadm/tests/test_service_discovery.py

@@ -23,6 +23,10 @@ def get_daemons_by_service(self, service_type):
             return [FakeDaemonDescription('1.2.3.4', [10008], 'node0'),
                     FakeDaemonDescription('1.2.3.5', [10008], 'node1')]
 
+        if service_type == 'nfs':
+            return [FakeDaemonDescription('1.2.3.4', [9587], 'node0'),
+                    FakeDaemonDescription('1.2.3.5', [9587], 'node1')]
+
         return [FakeDaemonDescription('1.2.3.4', [9100], 'node0'),
                 FakeDaemonDescription('1.2.3.5', [9200], 'node1')]
 
@@ -188,6 +192,20 @@ def test_get_sd_config_nvmeof(self):
         # check content
         assert cfg[0]['targets'] == ['1.2.3.4:10008']
 
+    def test_get_sd_config_nfs(self):
+        mgr = FakeMgr()
+        root = Root(mgr, 5000, '0.0.0.0')
+        cfg = root.get_sd_config('nfs')
+
+        # check response structure
+        assert cfg
+        for entry in cfg:
+            assert 'labels' in entry
+            assert 'targets' in entry
+
+        # check content
+        assert cfg[0]['targets'] == ['1.2.3.4:9587']
+
     def test_get_sd_config_invalid_service(self):
         mgr = FakeMgr()
         root = Root(mgr, 5000, '0.0.0.0')

src/pybind/mgr/cephadm/tests/test_services.py

@@ -824,6 +824,10 @@ def test_prometheus_config_security_disabled(self, _run_cephadm, cephadm_module:
                     http_sd_configs:
                     - url: http://[::1]:8765/sd/prometheus/sd-config?service=nvmeof
 
+                  - job_name: 'nfs'
+                    http_sd_configs:
+                    - url: http://[::1]:8765/sd/prometheus/sd-config?service=nfs
+
                   - job_name: 'federate'
                     scrape_interval: 15s
                     honor_labels: true
@@ -1021,6 +1025,19 @@ def gen_cert(host, addr):
                       tls_config:
                         ca_file: root_cert.pem
 
+                  - job_name: 'nfs'
+                    honor_labels: true
+                    scheme: https
+                    tls_config:
+                      ca_file: root_cert.pem
+                    http_sd_configs:
+                    - url: https://[::1]:8765/sd/prometheus/sd-config?service=nfs
+                      basic_auth:
+                        username: sd_user
+                        password: sd_password
+                      tls_config:
+                        ca_file: root_cert.pem
+
                 """).lstrip()
 
                 _run_cephadm.assert_called_with(