Skip to content
compforgePublic

About

Extensible diagnostics for Kubernetes applications.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

Doctor

English | 简体中文

Application-aware diagnostics for Kubernetes applications.

Doctor is an enhanced kubectl for diagnosing applications. It understands an application as a set of Services, connects to their runtime instances, and delivers evidence and offline reports to your machine. A Plugin supplies the application's Service catalog and business knowledge; Core provides the diagnostic tools.

From deployment to investigation

When Command What you get
After deployment, before serving traffic doctor health Active checks of service health, dependency connectivity and business functionality
After the system has been running doctor overview Errors, diagnostic patterns and duration distributions over a time window, with optional representative samples
When a problem needs investigation doctor collect Related configuration, business data, traces and logs in one evidence bundle

Start at the stage that matches your situation. You can also run a focused command such as inspect, trace, log or data directly; CPU, memory and network investigations have their own tools. Read the diagnostic workflow for how these paths fit together.

doctor health --scope self,deps
doctor overview --since 1h
doctor collect <biz-id> --include data,trace,log

Available checks and data depend on the active Plugin and target access. Use doctor plugin to inspect the Service catalog and doctor <command> --help for options. Operations that change the target require confirmation.

Build and start

Requirements: Bun and Go. From the repository root:

make deps
make build-local
./dist/doctor --help

make build-local builds the local macOS artifact; make build builds platform artifacts into dist/. Use a distribution with your application's Plugin, or follow the Plugin author guide to add one. For development checks, run make lint-all and make test-all.

Learn more

About

Extensible diagnostics for Kubernetes applications.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages