Repository navigation
Commit f7eff23
docs(protocol): document the real checkMethod health-check contract (#11822)
The TypeScript example under "Custom Health Checks" declared `healthChecks`,
a map of async functions taking `({ context })`, on the plugin default export.
No such field exists: measured as an author-writable field it has 0
occurrences (the hits in packages/ are PluginHealthMonitor's own private Map
plus one example reading it). The real configuration is
PluginHealthCheckSchema.checkMethod — a method NAME, invoked with no
arguments, whose return is read only for `false` / `{ status: 'unhealthy' }`.
Rewrite the example against that contract, in the two halves it actually has:
the plugin exposes a plain method, and the embedding application constructs
PluginHealthMonitor and names the method in the parsed config. No declarative
plugin field is shown, which keeps the section's callout ("not yet ... as a
declarative plugin field") true — that callout was verified correct and is
left untouched, as is the PluginHealthReport block below.
Claude-Session: https://claude.ai/code/session_015ahemw8RcTgqtxrj15PEZx
Co-authored-by: Claude <noreply@anthropic.com>1 parent 0d8bac2 commit f7eff23
1 file changed
Lines changed: 47 additions & 22 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
665 | 665 | | |
666 | 666 | | |
667 | 667 | | |
668 | | - | |
| 668 | + | |
| 669 | + | |
| 670 | + | |
| 671 | + | |
| 672 | + | |
| 673 | + | |
669 | 674 | | |
670 | 675 | | |
671 | | - | |
672 | | - | |
| 676 | + | |
| 677 | + | |
| 678 | + | |
| 679 | + | |
| 680 | + | |
673 | 681 | | |
674 | 682 | | |
675 | | - | |
676 | | - | |
677 | | - | |
678 | | - | |
679 | | - | |
680 | | - | |
681 | | - | |
682 | | - | |
683 | | - | |
684 | | - | |
685 | | - | |
686 | | - | |
687 | | - | |
688 | | - | |
689 | | - | |
690 | | - | |
691 | | - | |
692 | | - | |
| 683 | + | |
| 684 | + | |
| 685 | + | |
| 686 | + | |
| 687 | + | |
| 688 | + | |
| 689 | + | |
| 690 | + | |
693 | 691 | | |
694 | 692 | | |
695 | | - | |
| 693 | + | |
| 694 | + | |
| 695 | + | |
| 696 | + | |
| 697 | + | |
| 698 | + | |
| 699 | + | |
| 700 | + | |
| 701 | + | |
| 702 | + | |
| 703 | + | |
| 704 | + | |
| 705 | + | |
| 706 | + | |
| 707 | + | |
| 708 | + | |
| 709 | + | |
| 710 | + | |
| 711 | + | |
| 712 | + | |
| 713 | + | |
| 714 | + | |
| 715 | + | |
| 716 | + | |
| 717 | + | |
| 718 | + | |
| 719 | + | |
| 720 | + | |
696 | 721 | | |
697 | 722 | | |
698 | 723 | | |
| |||
0 commit comments