Skip to content

Commit 4fd2b5e

Browse files
committed
feat: add command/sosreport.md #656
1 parent 92d7a8d commit 4fd2b5e

File tree

3 files changed

+158
-7
lines changed

3 files changed

+158
-7
lines changed

command/sosreport.md

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
sosreport
2+
===
3+
4+
收集系统配置和诊断信息
5+
6+
## 补充说明
7+
8+
**sosreport命令** 是一个配置和数据收集实用程序,用于收集系统配置、日志文件和诊断信息,以便进行故障排除和分析。它将信息打包到一个压缩的tar文件中,便于传输和分析。sosreport是Red Hat Enterprise Linux系统中用于技术支持的标准工具。
9+
10+
### 语法
11+
12+
```shell
13+
sosreport [选项]
14+
```
15+
16+
### 选项
17+
18+
```shell
19+
-l, --list-plugins # 列出所有可用的插件
20+
-n, --skip-plugins # 跳过指定的插件(多个插件用逗号分隔)
21+
-e, --enable-plugins # 启用指定的插件(多个插件用逗号分隔)
22+
-o, --only-plugins # 只运行指定的插件(多个插件用逗号分隔)
23+
-a, --alloptions # 启用所有插件选项
24+
-v, --verbose # 详细输出模式
25+
-q, --quiet # 静默模式,减少输出
26+
--batch # 批处理模式,不提示用户输入
27+
--build # 收集系统构建信息
28+
--case-id=CASE_ID # 指定案例ID
29+
--config-file=CONFIG # 指定配置文件路径
30+
--debug # 调试模式
31+
--experimental # 启用实验性插件
32+
--log-size=SIZE # 限制日志文件大小(MB)
33+
--plugin-timeout=TIMEOUT # 插件超时时间(秒)
34+
--since=DATE # 从指定日期开始收集日志
35+
--tmp-dir=DIR # 指定临时目录
36+
--verify # 验证归档的完整性
37+
-z, --compression-type # 指定压缩类型(gzip, bzip2, xz)
38+
```
39+
40+
### 常用选项
41+
42+
```shell
43+
-a # 启用所有插件选项,收集最全面的信息
44+
-v # 详细模式,显示收集过程
45+
-q # 静默模式,最小化输出
46+
--batch # 批处理模式,不需要用户交互
47+
```
48+
49+
### 实例
50+
51+
收集系统诊断信息:
52+
53+
```shell
54+
sosreport
55+
```
56+
57+
批处理模式收集信息(无需用户交互):
58+
59+
```shell
60+
sosreport --batch
61+
```
62+
63+
详细模式收集信息:
64+
65+
```shell
66+
sosreport -v
67+
```
68+
69+
启用所有插件选项收集完整信息:
70+
71+
```shell
72+
sosreport -a
73+
```
74+
75+
只收集网络相关信息:
76+
77+
```shell
78+
sosreport -o network
79+
```
80+
81+
跳过某些插件:
82+
83+
```shell
84+
sosreport -n rpm,yum
85+
```
86+
87+
收集指定日期之后的日志:
88+
89+
```shell
90+
sosreport --since="2023-01-01"
91+
```
92+
93+
指定案例ID和批处理模式:
94+
95+
```shell
96+
sosreport --batch --case-id=12345678
97+
```
98+
99+
列出所有可用插件:
100+
101+
```shell
102+
sosreport -l
103+
```
104+
105+
收集系统信息并限制日志文件大小:
106+
107+
```shell
108+
sosreport --log-size=100
109+
```
110+
111+
使用不同的压缩类型:
112+
113+
```shell
114+
sosreport -z xz
115+
```
116+
117+
### 常见插件
118+
119+
```shell
120+
block # 块设备信息
121+
boot # 启动相关信息
122+
kernel # 内核信息
123+
logs # 系统日志
124+
memory # 内存信息
125+
network # 网络配置
126+
networking # 网络诊断
127+
process # 进程信息
128+
processor # CPU信息
129+
rpm # RPM包信息
130+
system # 系统配置
131+
yum # YUM包管理器信息
132+
```
133+
134+
### 输出文件
135+
136+
sosreport会在`/var/tmp/`目录下生成一个压缩的tar文件,文件名格式为:
137+
```
138+
sosreport-<hostname>-<timestamp>-<hash>.tar.xz
139+
```
140+
141+
### 注意事项
142+
143+
- sosreport需要root权限运行
144+
- 收集的信息可能包含敏感数据,传输前请确认安全性
145+
- 生成的文件可能较大,请确保有足够的磁盘空间
146+
- 默认情况下,敏感信息(如密码、密钥)会被混淆处理

dist/data.json

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,6 @@
184184
"p": "/blockdev",
185185
"d": "从命令行调用区块设备控制程序"
186186
},
187-
"bmodinfo": {
188-
"n": "bmodinfo",
189-
"p": "/bmodinfo",
190-
"d": "显示给定模块的详细信息"
191-
},
192187
"break": {
193188
"n": "break",
194189
"p": "/break",
@@ -1629,6 +1624,11 @@
16291624
"p": "/modetest",
16301625
"d": "DRM/KMS驱动程序libdrm中的模式测试工具"
16311626
},
1627+
"modinfo": {
1628+
"n": "modinfo",
1629+
"p": "/modinfo",
1630+
"d": "显示给定模块的详细信息"
1631+
},
16321632
"modprobe": {
16331633
"n": "modprobe",
16341634
"p": "/modprobe",
@@ -1692,7 +1692,7 @@
16921692
"named-checkzone": {
16931693
"n": "named-checkzone",
16941694
"p": "/named-checkzone",
1695-
"d": "使用named-checkzone命令可以进行区域文件有效性检查和转换,必须指定区域名称和区域文件名称"
1695+
"d": "使用 named-checkzone 可验证并转换区域文件,需指定区域名和文件名。"
16961696
},
16971697
"nano": {
16981698
"n": "nano",
@@ -2399,6 +2399,11 @@
23992399
"p": "/sort",
24002400
"d": "对文本文件中所有行进行排序。"
24012401
},
2402+
"sosreport": {
2403+
"n": "sosreport",
2404+
"p": "/sosreport",
2405+
"d": "收集系统配置和诊断信息"
2406+
},
24022407
"source": {
24032408
"n": "source",
24042409
"p": "/source",

dist/data.min.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)