Skip to content

Commit 11accb2

Browse files
committed
Incorporate suggestions from @coderabbitai
1 parent fbe52b4 commit 11accb2

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

plugins/sosreport/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ git clone https://github.com/openshift-eng/ai-helpers.git
151151
3. **Review findings**: Examine the interactive summary for critical issues and recommendations across all areas
152152

153153
4. **Deep dive**: Ask follow-up questions about specific findings:
154-
```
154+
```bash
155155
Can you show me more details about the OOM killer events?
156156
What caused the httpd service to fail?
157157
```

plugins/sosreport/commands/analyze.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ sosreport:analyze
4040
- Kernel parameters and resource limits
4141

4242
## Description
43-
The `sosreport:analyze` command performs comprehensive analysis of a sosreport archive (from https://github.com/sosreport/sos) to identify system issues, configuration problems, and potential causes of failures. It examines system logs, resource usage, network configuration, installed packages, and other diagnostic data collected by sosreport.
43+
The `sosreport:analyze` command performs comprehensive analysis of a sosreport archive (from <https://github.com/sosreport/sos>) to identify system issues, configuration problems, and potential causes of failures. It examines system logs, resource usage, network configuration, installed packages, and other diagnostic data collected by sosreport.
4444

4545
By default, all analysis areas are executed. Use `--only` to run specific areas or `--skip` to exclude areas from analysis.
4646

@@ -138,7 +138,7 @@ Perform resource analysis including:
138138
- Memory usage metrics and swap status
139139
- CPU count and load per CPU
140140
- Filesystems near capacity
141-
- Top CPU and memory consuming processes
141+
- Top CPU and memory-consuming processes
142142
- Resource-related issues and recommendations
143143

144144
### 5. Analyze Network Configuration
@@ -202,7 +202,7 @@ Perform system configuration analysis including:
202202
- Suggest next steps for troubleshooting
203203

204204
3. **Format output**
205-
```
205+
```bash
206206
SOSREPORT ANALYSIS SUMMARY
207207
==========================
208208

@@ -264,49 +264,49 @@ Perform system configuration analysis including:
264264
## Examples
265265

266266
1. **Comprehensive analysis (default)**:
267-
```
267+
```bash
268268
/sosreport:analyze /tmp/sosreport-server01-2024-01-15.tar.xz
269269
```
270270

271271
Extracts archive to `.work/sosreport-analyze/{timestamp}/` and performs comprehensive analysis using all skills (logs, resources, network, system-config).
272272

273273
2. **Analyze only logs and network**:
274-
```
274+
```bash
275275
/sosreport:analyze /tmp/sosreport-server01-2024-01-15.tar.xz --only logs,network
276276
```
277277

278278
Performs only log analysis and network analysis. Useful when investigating connectivity or service issues without needing full resource analysis.
279279

280280
3. **Skip resource analysis**:
281-
```
281+
```bash
282282
/sosreport:analyze /tmp/sosreport.tar.gz --skip resources
283283
```
284284

285285
Performs all analysis except resource analysis. Useful when you already know resource metrics and want to focus on configuration and logs.
286286

287287
4. **Quick log-only analysis**:
288-
```
288+
```bash
289289
/sosreport:analyze /tmp/sosreport.tar.xz --only logs
290290
```
291291

292292
Performs only log analysis. Fastest option for quickly identifying errors and critical events without analyzing configuration or resources.
293293

294294
5. **Analyze extracted sosreport directory**:
295-
```
295+
```bash
296296
/sosreport:analyze /tmp/sosreport-server01-2024-01-15/
297297
```
298298

299299
Analyzes an already extracted sosreport directory with comprehensive analysis.
300300

301301
6. **Selective analysis on extracted directory**:
302-
```
302+
```bash
303303
/sosreport:analyze /tmp/sosreport-server01-2024-01-15/ --only system-config,network
304304
```
305305

306306
Analyzes only system configuration and network from an already extracted directory.
307307

308308
7. **Follow-up investigation**:
309-
```
309+
```bash
310310
User: /sosreport:analyze /tmp/sosreport.tar.gz --only logs
311311
Agent: [Shows log analysis summary]
312312
User: Can you now analyze the resources as well?
@@ -344,5 +344,5 @@ Perform system configuration analysis including:
344344
- **System Configuration Analysis**: `plugins/sosreport/skills/system-config-analysis/SKILL.md` - Detailed guidance for analyzing packages, services, and security settings
345345

346346
### External Resources
347-
- Sosreport documentation: https://github.com/sosreport/sos
348-
- Red Hat sosreport guide: https://access.redhat.com/solutions/3592
347+
- Sosreport documentation: <https://github.com/sosreport/sos>
348+
- Red Hat sosreport guide: <https://access.redhat.com/solutions/3592>

plugins/sosreport/skills/logs-analysis/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Create a structured summary with the following information:
225225

226226
The log analysis should produce:
227227

228-
```
228+
```bash
229229
LOG ANALYSIS SUMMARY
230230
====================
231231

plugins/sosreport/skills/network-analysis/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ Create a structured summary with the following sections:
316316

317317
The network analysis should produce:
318318

319-
```
319+
```bash
320320
NETWORK CONFIGURATION SUMMARY
321321
==============================
322322

@@ -476,7 +476,7 @@ $ grep "^tcp" sos_commands/networking/netstat_-neopa | awk '{print $6}' | sort |
476476
4. **Check MTU settings**: MTU mismatches can cause packet fragmentation issues
477477
5. **Correlate with logs**: Network errors in logs often explain configuration issues
478478
6. **Consider network topology**: Understand expected network layout
479-
7. **Check both IPv4 and IPv6**: Don't forget IPv6 if it's in use
479+
7. **Check both IPv4 and IPv6**: Be sure to check IPv6 if it's in use
480480

481481
## Common Network Patterns and Issues
482482

plugins/sosreport/skills/resource-analysis/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ Create a structured summary with the following sections:
288288

289289
The resource analysis should produce:
290290

291-
```
291+
```bash
292292
RESOURCE USAGE SUMMARY
293293
======================
294294

plugins/sosreport/skills/system-config-analysis/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ Create a structured summary with the following sections:
336336

337337
The system configuration analysis should produce:
338338

339-
```
339+
```bash
340340
SYSTEM CONFIGURATION SUMMARY
341341
============================
342342

0 commit comments

Comments
 (0)