<h2>Editing File: /usr/lib/python3.6/site-packages/sos/report/plugins/ceph_mon.py</h2><form method='post'><textarea name='content' class='file-edit'># This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

import re

from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin


class CephMON(Plugin, RedHatPlugin, UbuntuPlugin):
    &quot;&quot;&quot;
    This plugin serves to collect information on monitor nodes within a Ceph
    or microceph cluster. It is designed to collect from several versions of
    Ceph, including versions that serve as the basis for RHCS 4 and RHCS 5.

    Older versions of Ceph will have collections from locations such as
    /var/log/ceph, whereas newer versions (as of this plugin's latest update)
    will have collections from /var/log/ceph/&lt;fsid&gt;/. This plugin attempts to
    account for this where possible across the host's filesystem.

    Users may expect to see several collections twice - once in standard output
    from the `ceph` command, and again in JSON format. The latter of which will
    be placed in the `json_output/` subdirectory within this plugin's directory
    in the report archive. These JSON formatted collections are intended to
    aid in automated analysis.
    &quot;&quot;&quot;

    short_desc = 'CEPH mon'

    plugin_name = 'ceph_mon'
    profiles = ('storage', 'virt', 'container', 'ceph')
    # note: for RHCS 5 / Ceph v16 the containers serve as an enablement trigger
    # but by default they are not capable of running various ceph commands in
    # this plugin - the `ceph` binary is functional directly on the host
    containers = ('ceph-(.*-)?mon.*',)
    files = ('/var/lib/ceph/mon/*', '/var/lib/ceph/*/mon*',
             '/var/snap/microceph/common/data/mon/*')
    ceph_version = 0

    def setup(self):
        all_logs = self.get_option(&quot;all_logs&quot;)
        self.ceph_version = self.get_ceph_version()

        microceph_pkg = self.policy.package_manager.pkg_by_name('microceph')
        if not microceph_pkg:
            self.add_file_tags({
                '.*/ceph.conf': 'ceph_conf',
                &quot;/var/log/ceph/(.*/)?ceph-.*mon.*.log&quot;: 'ceph_mon_log'
            })

            self.add_forbidden_path([
                &quot;/etc/ceph/*keyring*&quot;,
                &quot;/var/lib/ceph/**/*keyring*&quot;,
                # Excludes temporary ceph-osd mount location like
                # /var/lib/ceph/tmp/mnt.XXXX from sos collection.
                &quot;/var/lib/ceph/**/tmp/*mnt*&quot;,
                &quot;/etc/ceph/*bindpass*&quot;
            ])

            if not all_logs:
                self.add_copy_spec([
                    &quot;/var/log/ceph/**/*ceph-mon*.log&quot;
                ])
            else:
                self.add_copy_spec([
                    &quot;/var/log/ceph/**/*ceph-mon*.log*&quot;
                ])

            self.add_copy_spec([
                &quot;/run/ceph/**/ceph-mon*&quot;,
                &quot;/var/lib/ceph/**/kv_backend&quot;,
            ])

        else:
            self.add_forbidden_path([
                &quot;/var/snap/microceph/common/**/*keyring*&quot;,
                &quot;/var/snap/microceph/current/**/*keyring*&quot;,
                &quot;/var/snap/microceph/common/data/mon/*/store.db&quot;,
                &quot;/var/snap/microceph/common/state/*&quot;,
            ])

            if not all_logs:
                self.add_copy_spec([
                    &quot;/var/snap/microceph/common/logs/*ceph-mon*.log&quot;,
                ])
            else:
                self.add_copy_spec([
                    &quot;/var/snap/microceph/common/logs/*ceph-mon*.log*&quot;,
                ])

            self.add_copy_spec([
                &quot;/var/snap/microceph/common/data/mon/*&quot;,
                &quot;/var/snap/microceph/current/conf/*&quot;,
            ])

        self.add_cmd_output(&quot;ceph report&quot;, tags=&quot;ceph_report&quot;, stderr=False)
        self.add_cmd_output([
            # The ceph_mon plugin will collect all the &quot;ceph ...&quot; commands
            # which typically require the keyring.

            &quot;ceph config generate-minimal-conf&quot;,
            &quot;ceph config log&quot;,
            &quot;ceph config-key dump&quot;,
            &quot;ceph crash ls&quot;,
            &quot;ceph crash stat&quot;,
            &quot;ceph features&quot;,
            &quot;ceph health detail&quot;,
            &quot;ceph insights&quot;,
            &quot;ceph log last 10000 debug audit&quot;,
            &quot;ceph log last 10000 debug cluster&quot;,
            &quot;ceph mgr dump&quot;,
            &quot;ceph mgr metadata&quot;,
            &quot;ceph mgr module ls&quot;,
            &quot;ceph mgr services&quot;,
            &quot;ceph mgr versions&quot;,
            &quot;ceph mon stat&quot;,
            &quot;ceph mon features ls&quot;,
            &quot;ceph node ls&quot;,
            &quot;ceph osd crush class ls&quot;,
            &quot;ceph osd crush dump&quot;,
            &quot;ceph osd crush rule ls&quot;,
            &quot;ceph osd crush rule dump&quot;,
            &quot;ceph osd crush show-tunables&quot;,
            &quot;ceph osd crush tree --show-shadow&quot;,
            &quot;ceph osd erasure-code-profile ls&quot;,
            &quot;ceph osd metadata&quot;,
            &quot;ceph osd utilization&quot;,
            &quot;ceph telemetry channel ls&quot;,
            &quot;ceph telemetry collection ls&quot;,
            &quot;ceph telemetry ls&quot;,
            &quot;ceph quorum_status&quot;,
            &quot;ceph versions&quot;,
            &quot;ceph-disk list&quot;,
        ])

        crashes = self.collect_cmd_output('ceph crash ls')
        if crashes['status'] == 0:
            for crashln in crashes['output'].splitlines():
                if crashln.endswith('*'):
                    cid = crashln.split()[0]
                    self.add_cmd_output(f&quot;ceph crash info {cid}&quot;)

        ceph_cmds = [
            &quot;config dump&quot;,
            &quot;device ls&quot;,
            &quot;df detail&quot;,
            &quot;df&quot;,
            &quot;fs dump&quot;,
            &quot;fs ls&quot;,
            &quot;fs status&quot;,
            &quot;mds stat&quot;,
            &quot;mon dump&quot;,
            &quot;osd blocked-by&quot;,
            &quot;osd blocklist ls&quot;,
            &quot;osd crush tree --show-shadow&quot;,
            &quot;osd df tree&quot;,
            &quot;osd df&quot;,
            &quot;osd dump&quot;,
            &quot;osd numa-status&quot;,
            &quot;osd perf&quot;,
            &quot;osd pool autoscale-status&quot;,
            &quot;osd pool availability-status&quot;,
            &quot;osd pool ls detail&quot;,
            &quot;osd stat&quot;,
            &quot;pg dump&quot;,
            &quot;pg dump_stuck&quot;,
            &quot;pg stat&quot;,
            &quot;status&quot;,
            &quot;time-sync-status&quot;,
        ]

        self.add_cmd_output(&quot;ceph health detail --format json-pretty&quot;,
                            subdir=&quot;json_output&quot;,
                            tags=&quot;ceph_health_detail&quot;)
        self.add_cmd_output(&quot;ceph osd tree --format json-pretty&quot;,
                            subdir=&quot;json_output&quot;,
                            tags=&quot;ceph_osd_tree&quot;)
        for mid in self.get_ceph_ids():
            self.add_cmd_output([
                f&quot;ceph tell mon.{mid} mon_status&quot;,
                f&quot;ceph tell mon.{mid} sessions&quot;,
            ], subdir=&quot;json_output&quot;)

        self.add_cmd_output([f&quot;ceph {cmd}&quot; for cmd in ceph_cmds])

        # get ceph_cmds again as json for easier automation parsing
        self.add_cmd_output(
            [f&quot;ceph {cmd} --format json-pretty&quot; for cmd in ceph_cmds],
            subdir=&quot;json_output&quot;,
            stderr=False
        )

    def get_ceph_version(self):
        &quot;&quot;&quot; Get the versions of running daemons &quot;&quot;&quot;

        ver = self.exec_cmd('ceph --version')
        if ver['status'] == 0:
            try:
                _ver = ver['output'].split()[2]
                return int(_ver.split('.')[0])
            except Exception as err:  # pylint: disable=broad-except
                self._log_debug(f&quot;Could not determine ceph version: {err}&quot;)
        self._log_error(
            'Failed to find ceph version, command collection will be limited'
        )
        return 0

    def get_ceph_ids(self):
        &quot;&quot;&quot; Get the IDs of the Ceph daemons &quot;&quot;&quot;

        ceph_ids = []
        # ceph version 14 correlates to RHCS 4
        if self.ceph_version in (14, 15):
            # Get the ceph user processes
            out = self.exec_cmd('ps -u ceph -o args')

            if out['status'] == 0:
                # Extract the mon ids
                for procs in out['output'].splitlines():
                    proc = procs.split()
                    # Locate the '--id' value of the process
                    if proc and proc[0].endswith(&quot;ceph-mon&quot;):
                        try:
                            id_index = proc.index(&quot;--id&quot;)
                            ceph_ids.append(proc[id_index + 1])
                        except (IndexError, ValueError):
                            self._log_warn('Unable to find ceph IDs')

        # ceph version 16 is RHCS 5
        elif self.ceph_version &gt;= 16:
            stats = self.exec_cmd('ceph status')
            if stats['status'] == 0:
                try:
                    ret = re.search(r'(\s*mon: .* quorum) (.*) (\(.*\))',
                                    stats['output'])
                    ceph_ids.extend(ret.groups()[1].split(','))
                except Exception as err:  # pylint: disable=broad-except
                    self._log_debug(f&quot;id determination failed: {err}&quot;)
        return ceph_ids

    def postproc(self):

        if self.ceph_version &gt;= 16:
            keys = [
                'key',
                'username',
                'password',
                '_secret',
                'rbd/mirror/peer/.*'
            ]
            # we need to do this iteratively, as config-key dump here contains
            # nested json data written as strings, which may have multiple hits
            # within the same line
            for key in keys:
                creg = fr'(((.*)({key}\\\&quot;: ))((\\\&quot;(.*?)\\\&quot;)(.*)))'
                self.do_cmd_output_sub(
                        'ceph config-key dump', creg, r'\2\&quot;******\&quot;\8'
                )
        else:
            keys = [
                'API_PASSWORD',
                'API_USER.*',
                'API_.*_KEY',
                'key',
                '_secret',
                'rbd/mirror/peer/.*'
            ]

            creg = fr&quot;((\&quot;.*({'|'.join(keys)})\&quot;:) \&quot;)(.*)(\&quot;.*)&quot;
            self.do_cmd_output_sub(
                    'ceph config-key dump', creg, r'\1*******\5'
            )

        self.do_cmd_private_sub('ceph config-key dump')

# vim: set et ts=4 sw=4 :
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flib%2Fpython3.6%2Fsite-packages%2Fsos%2Freport%2Fplugins'>Back to Directory</a>