1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
# Copyright (C) 2023 Canonical Ltd., Nikhil Kshirsagar <nkshirsagar@ubuntu.com>
# 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 os
from sos.report.plugins import Plugin, RedHatPlugin, UbuntuPlugin
class CephMGR(Plugin, RedHatPlugin, UbuntuPlugin):
"""
This plugin is for capturing information from Ceph mgr nodes. While the
majority of this plugin should be version-agnostic, several collections are
dependent upon the version of Ceph installed. Versions that correlate to
RHCS 4 or RHCS 5 are explicitly handled for differences such as those
pertaining to log locations on the host filesystem.
Note that while this plugin will activate based on the presence of Ceph
containers, commands are run directly on the host as those containers are
often not configured to successfully run the `ceph` commands collected by
this plugin. These commands are majorily `ceph daemon` commands that will
reference discovered admin sockets under /var/run/ceph.
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.
"""
short_desc = 'CEPH mgr'
plugin_name = 'ceph_mgr'
profiles = ('storage', 'virt', 'container', 'ceph')
files = ('/var/lib/ceph/mgr/*', '/var/lib/ceph/*/mgr*',
'/var/snap/microceph/common/data/mgr/*')
containers = ('ceph-(.*-)?mgr.*',)
def setup(self):
all_logs = self.get_option("all_logs")
microceph_pkg = self.policy.package_manager.pkg_by_name('microceph')
ceph_mgr_cmds = ([
"balancer status",
"healthcheck history ls",
"log last cephadm",
"mgr dump",
"mgr metadata",
"mgr module ls",
"mgr stat",
"mgr versions"
])
# if orchestrator is configured
orch_configured = self.exec_cmd('ceph orch status')
if orch_configured['status'] == 0:
ceph_mgr_cmds += ([
"orch host ls",
"orch device ls",
"orch ls",
"orch ls --export",
"orch ps",
"orch status --detail",
"orch upgrade status"
])
cmds = [
"config diff",
"config show",
"counter dump",
"counter schema",
"dump_cache",
"dump_mempools",
"dump_osd_network",
"mds_requests",
"mds_sessions",
"objecter_requests",
"perf dump",
"perf histogram dump",
"perf histogram schema",
"perf schema",
"status",
"version",
]
directory = ''
if not microceph_pkg:
directory = '/var/run/ceph'
self.add_file_tags({
'/var/log/ceph/(.*/)?ceph-mgr.*.log': 'ceph_mgr_log',
})
self.add_forbidden_path([
"/etc/ceph/*keyring*",
"/var/lib/ceph/**/*keyring*",
"/var/lib/ceph/**/osd*",
"/var/lib/ceph/**/mon*",
# Excludes temporary ceph-osd mount location like
# /var/lib/ceph/tmp/mnt.XXXX from sos collection.
"/var/lib/ceph/**/tmp/*mnt*",
"/etc/ceph/*bindpass*",
])
if not all_logs:
self.add_copy_spec([
"/var/log/ceph/**/ceph-mgr*.log",
])
else:
self.add_copy_spec([
"/var/log/ceph/**/ceph-mgr*.log*",
])
self.add_copy_spec([
"/var/lib/ceph/**/mgr*",
"/var/lib/ceph/**/bootstrap-mgr/",
"/run/ceph/**/ceph-mgr*",
])
else:
directory = '/var/snap/microceph'
self.add_file_tags({
'/var/snap/microceph/common/logs/ceph-mgr.*.log':
'ceph_mgr_log',
})
self.add_forbidden_path([
"/var/snap/microceph/common/**/*keyring*",
])
if not all_logs:
self.add_copy_spec([
"/var/snap/microceph/common/logs/ceph-mgr*.log",
])
else:
self.add_copy_spec([
"/var/snap/microceph/common/logs/ceph-mgr*.log*",
])
self.add_cmd_output(
[f"ceph {cmd}" for cmd in ceph_mgr_cmds])
# get ceph_cmds again as json for easier automation parsing
self.add_cmd_output(
[f"ceph {cmd} --format json-pretty" for cmd in ceph_mgr_cmds],
subdir="json_output",
)
self.add_cmd_output([
f"ceph daemon {m} {cmd}" for m in self.get_socks(directory)
for cmd in cmds]
)
def get_socks(self, directory):
"""
Find any available admin sockets under /var/run/ceph (or subdirs for
later versions of Ceph) which can be used for ceph daemon commands
"""
ceph_sockets = []
for rdir, _, files in os.walk(directory):
for file in files:
if file.startswith('ceph-mgr') and file.endswith('.asok'):
ceph_sockets.append(self.path_join(rdir, file))
return ceph_sockets
# vim: set et ts=4 sw=4 :
|
