obdiag-usage

Guide users through obdiag agent tools for configuration, data collection, analysis, and RCA.

161|40|Updated Nov 22, 2022
One-click install
npx skills add https://github.com/oceanbase/obdiag --skill obdiag-usage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obdiag-usage
Source: https://github.com/oceanbase/obdiag/tree/main/plugins/agent/skills/obdiag-usage
Command: npx skills add https://github.com/oceanbase/obdiag --skill obdiag-usage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a structured, user-friendly guide to operating the obdiag agent tools for configuration, data collection, analysis, and root-cause investigation.

Core Features & Use Cases

  • Comprehensive workflow coverage: generate configuration files, gather logs, analyze logs, run checks, and perform RCA across OceanBase deployments.
  • Scenarios for novices and experts: step-by-step guidance, risk-aware recommendations, and troubleshooting patterns for common diagnostic tasks.
  • Real-world example-driven guidance: mapping symptoms to appropriate tools and workflows to accelerate resolution.

Quick Start

Ask the agent for guidance on generating configuration and performing a diagnostic workflow

Frequently Asked Questions about obdiag-usage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I gather logs and run diagnostics for OceanBase deployments?

To gather logs and run diagnostics for OceanBase, use the obdiag agent tools to generate configuration files, collect log data, and analyze system health. The workflow covers step-by-step guidance for both novices and advanced users.

What is the recommended workflow for performing root cause analysis with obdiag?

Root cause analysis with obdiag involves mapping symptoms to appropriate diagnostic workflows, running checks, and analyzing gathered log data. The tool provides risk-aware recommendations and troubleshooting patterns to accelerate resolution.

Can I generate configuration files for obdiag before collecting diagnostic data?

Yes, you can generate configuration files as the first step in the obdiag workflow. This prepares the environment for subsequent log gathering, data analysis, checks, and root cause investigation tasks.

What safety considerations should I be aware of when running obdiag commands?

When running obdiag commands, follow the defined safety considerations to avoid unsafe operations. The tool provides risk-aware recommendations and defines functional scope boundaries to ensure secure diagnostic workflows.

Does obdiag support troubleshooting patterns for common diagnostic tasks?

Yes, obdiag supports troubleshooting patterns for common diagnostic tasks. It provides real-world example-driven guidance that maps symptoms to appropriate tools and workflows, offering step-by-step instructions for both novices and experts.

What arguments and commands do I need to use for obdiag log analysis?

For obdiag log analysis, use the defined commands and arguments specified in the tool's functional scope. The guidance includes recommended workflows that map symptoms to appropriate analysis tools for OceanBase deployments.