# health_check URL: /api/health/health_check/ Section: health -------------------------------------------------------------------------------- health_check - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy API Reference Health ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module health.health_check Main health check orchestrator. Coordinates all validators and produces unified health reports. Supports parallel execution of validators for improved performance. View source 2 Classes Classes HealthCheckStats dataclass Statistics about health check execution. Provides observability into parallel execution performance. 3 Caret Right Statistics about health check execution. Provides observability into parallel execution performance. Attributes Name Type Description total_duration_ms float execution_mode str validator_count int worker_count int cpu_count int sum_validator_duration_ms float Methods 3 Tag speedup property Calculate speedup from parallel execution. Returns ratio of sum(individual dur… float Caret Right def speedup(self) -> float Calculate speedup from parallel execution. Returns ratio of sum(individual durations) / total duration. A speedup of 2.0 means parallel was 2x faster than sequential would be. Returns float Tag efficiency property Calculate parallel efficiency (0.0 to 1.0). efficiency = speedup / worker_coun… float Caret Right def efficiency(self) -> float Calculate parallel efficiency (0.0 to 1.0). efficiency = speedup / worker_count 1.0 = perfect scaling, 0.5 = 50% efficiency Returns float format_summary Format a human-readable summary. 0 str Caret Right def format_summary(self) -> str Format a human-readable summary. Returns str HealthCheck Orchestrates health check validators and produces unified health reports. By default, registers al… 13 Caret Right Orchestrates health check validators and produces unified health reports. By default, registers all standard validators. You can disable auto-registration by passing auto_register=False, then manually register validators. Usage: # Default: auto-registers all validators health = HealthCheck(site) report = health.run() print(report.format_console()) # Manual registration: health = HealthCheck(site, auto_register=False) health.register(ConfigValidator()) health.register(OutputValidator()) report = health.run() Attributes Name Type Description last_stats HealthCheckStats | None Methods 3 register Register a validator to be run. 1 None Caret Right def register(self, validator: BaseValidator) -> None Register a validator to be run. Parameters 1 validator BaseValidator Validator instance to register run Run all registered validators and produce a health report. Validators run in p… 8 HealthReport Caret Right def run(self, build_stats: dict[str, Any] | None = None, verbose: bool = False, profile: BuildProfile | None = None, incremental: bool = False, context: list[Path] | None = None, cache: Any = None, build_context: Any = None, tier: str = 'build') -> HealthReport Run all registered validators and produce a health report. Validators run in parallel when there are 3+ enabled validators, falling back to sequential execution for smaller workloads. Parameters 8 build_stats dict[str, Any] | None Optional build statistics to include in report verbose bool Whether to show verbose output during validation profile BuildProfile | None Build profile to use for filtering validators incremental bool If True, only validate changed files (requires cache) context list[Path] | None Optional list of specific file paths to validate (overrides incremental) cache Any Optional BuildCache instance for incremental validation and result caching build_context Any Optional BuildContext with cached artifacts (e.g., knowledge graph, cached content) that validators can use to avoid redundant computation. When build_context has cached content, validators like DirectiveValidator skip disk I/O, reducing health check time from ~4.6s to <100ms. tier str Validation tier to run: - "build": Fast validators only (<100ms) - default - "full": + Knowledge graph validators (~500ms) - "ci": All validators including external checks (~30s) Returns HealthReport — HealthReport with results from all validators run_and_print Run health checks and print console output. 2 HealthReport Caret Right def run_and_print(self, build_stats: dict[str, Any] | None = None, verbose: bool = False) -> HealthReport Run health checks and print console output. Parameters 2 build_stats dict[str, Any] | None Optional build statistics verbose bool Whether to show all checks (not just problems) Returns HealthReport — HealthReport Internal Methods 10 Caret Right __init__ Initialize health check system. 2 None Caret Right def __init__(self, site: Site, auto_register: bool = True) Initialize health check system. Parameters 2 site Site The Site object to validate auto_register bool Whether to automatically register all default validators _register_default_validators Register all default validators. 0 None Caret Right def _register_default_validators(self) -> None Register all default validators. _get_optimal_workers Calculate optimal worker count based on system resources and workload. Auto-sc… 1 int Caret Right def _get_optimal_workers(self, validator_count: int) -> int Calculate optimal worker count based on system resources and workload. Auto-scales based on: Available CPU cores (uses ~50% to leave headroom) Number of validators (no point having more workers than tasks) Minimum of 2 workers (for any parallelism benefit) Maximum of 8 workers (diminishing returns beyond this) Parameters 1 validator_count int Number of validators to run Returns int — Optimal number of worker threads _is_validator_in_tier Check if a validator should run based on the validation tier. Tiered validatio… 2 bool Caret Right def _is_validator_in_tier(self, validator: BaseValidator, tier: str) -> bool Check if a validator should run based on the validation tier. Tiered validation allows fast builds by default with thorough checks available when needed. Tiers (cumulative): "build": Fast validators only (<100ms) "full": + Knowledge graph validators (~500ms) "ci": All validators including external checks (~30s) Parameters 2 validator BaseValidator The validator to check tier str One of "build", "full", or "ci" Returns bool — True if validator should run for this tier _is_validator_enabled Check if a validator should run based on profile and config. 3 bool Caret Right def _is_validator_enabled(self, validator: BaseValidator, profile: BuildProfile | None, verbose: bool) -> bool Check if a validator should run based on profile and config. Parameters 3 validator BaseValidator The validator to check profile BuildProfile | None Optional build profile for filtering verbose bool Whether to show skip messages Returns bool — True if validator should run _get_files_to_validate Determine which files to validate for incremental/context modes. 3 set[Path] | None Caret Right def _get_files_to_validate(self, context: list[Path] | None, incremental: bool, cache: Any) -> set[Path] | None Determine which files to validate for incremental/context modes. Parameters 3 context list[Path] | None Optional explicit file list incremental bool Whether incremental mode is enabled cache Any BuildCache instance Returns set[Path] | None — Set of paths to validate, or None for full validation _run_single_validator Run a single validator and return its report. This method is used by both sequ… 4 ValidatorReport Caret Right def _run_single_validator(self, validator: BaseValidator, build_context: BuildContext | Any | None, cache: Any, files_to_validate: set[Path] | None) -> ValidatorReport Run a single validator and return its report. This method is used by both sequential and parallel execution. Parameters 4 validator BaseValidator The validator to run build_context BuildContext | Any | None Optional BuildContext with cached artifacts cache Any Optional BuildCache for result caching files_to_validate set[Path] | None Set of files to validate (for incremental mode) Returns ValidatorReport — ValidatorReport with results and timing _run_validators_sequential Run validators sequentially (for small workloads). 6 None Caret Right def _run_validators_sequential(self, validators: list[BaseValidator], report: HealthReport, build_context: BuildContext | Any | None, verbose: bool, cache: Any, files_to_validate: set[Path] | None) -> None Run validators sequentially (for small workloads). Parameters 6 validators list[BaseValidator] List of validators to run report HealthReport HealthReport to add results to build_context BuildContext | Any | None Optional BuildContext with cached artifacts verbose bool Whether to show per-validator output cache Any Optional BuildCache for result caching files_to_validate set[Path] | None Set of files to validate (for incremental mode) _run_validators_parallel Run validators in parallel using ThreadPoolExecutor. Uses as_completed() to pr… 7 None Caret Right def _run_validators_parallel(self, validators: list[BaseValidator], report: HealthReport, build_context: BuildContext | Any | None, verbose: bool, cache: Any, files_to_validate: set[Path] | None, worker_count: int | None = None) -> None Run validators in parallel using ThreadPoolExecutor. Uses as_completed() to process results as they finish, providing better UX for verbose mode. Output is printed in the main thread to prevent garbled console output. Parameters 7 validators list[BaseValidator] List of validators to run report HealthReport HealthReport to add results to build_context BuildContext | Any | None Optional BuildContext with cached artifacts verbose bool Whether to show per-validator output cache Any Optional BuildCache for result caching files_to_validate set[Path] | None Set of files to validate (for incremental mode) worker_count int | None Number of worker threads (auto-detected if None) __repr__ 0 str Caret Right def __repr__(self) -> str Returns str ← Previous health Next → report List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 2232 - Reading Time: 11 minutes