# observability URL: /api/utils/observability/ Section: utils -------------------------------------------------------------------------------- observability - 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 Utils ᗢ 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 utils.observability Observability utilities for systematic stats collection across Bengal's build pipeline. Provides standardized stats collection and formatting for debugging performance issues, cache effectiveness, and processing bottlenecks. This module implements the observability improvements from RFC: rfc-observability-improvements.md Key Concepts: ComponentStats: Standardized stats container with counts, cache metrics, and sub-timings HasStats: Protocol for components that expose observability stats Consistent formatting for CLI output and structured logging Usage: >>> from bengal.utils.observability import ComponentStats, HasStats >>> stats = ComponentStats(items_total=100, items_processed=80) >>> stats.items_skipped["filtered"] = 20 >>> print(stats.format_summary("MyComponent")) MyComponent: processed=80/100 | skipped=[filtered=20] Related: bengal/health/report.py: ValidatorStats (extends ComponentStats pattern) bengal/orchestration/build/finalization.py: CLI output integration plan/active/rfc-observability-improvements.md: Design rationale View source 2 Classes 1 Function Classes HasStats Protocol for components that expose observability stats. Components implementing this protocol can… 0 Caret Right Protocol for components that expose observability stats. Components implementing this protocol can have their stats displayed automatically when phases exceed performance thresholds. Inherits from Protocol Attributes Name Type Description last_stats ComponentStats | None ComponentStats dataclass Standardized stats container for any build component. Provides a uniform interface for tracking: -… 5 Caret Right Standardized stats container for any build component. Provides a uniform interface for tracking: Processing counts (total, processed, skipped by reason) Cache effectiveness (hits, misses, hit rate) Sub-operation timings (analyze, render, validate, etc.) Custom metrics (component-specific values) Attributes Name Type Description items_total int Total items to process items_processed int Items actually processed items_skipped dict[str, int] Dict of skip reasons and counts (e.g., {"autodoc": 450, "draft": 3}) cache_hits int Number of cache hits (if applicable) cache_misses int Number of cache misses (if applicable) sub_timings dict[str, float] Dict of sub-operation names to duration_ms metrics dict[str, int | float | str] Custom metrics (component-specific, e.g., {"pages_per_sec": 375}) Methods 5 Tag cache_hit_rate property Cache hit rate as percentage (0-100). float Caret Right def cache_hit_rate(self) -> float Cache hit rate as percentage (0-100). Returns float — Percentage of cache hits, or 0.0 if no cache operations. Tag skip_rate property Skip rate as percentage (0-100). float Caret Right def skip_rate(self) -> float Skip rate as percentage (0-100). Returns float — Percentage of items skipped, or 0.0 if no items. Tag total_skipped property Total number of skipped items across all reasons. int Caret Right def total_skipped(self) -> int Total number of skipped items across all reasons. Returns int format_summary Format stats for CLI output. Produces a compact, informative summary suitable … 1 str Caret Right def format_summary(self, name: str = '') -> str Format stats for CLI output. Produces a compact, informative summary suitable for terminal display. Only includes sections with actual data. Parameters 1 name str Component name prefix (e.g., "Directives", "Links") Returns str — Formatted string like "processed=80/100 | skipped=[autodoc=450] | cache=80/80 (100%)" to_log_context Convert to flat dict for structured logging. Flattens nested data structures f… 0 dict[str, int | flo… Caret Right def to_log_context(self) -> dict[str, int | float | str] Convert to flat dict for structured logging. Flattens nested data structures for log aggregation systems. Returns dict[str, int | float | str] — Flat dictionary suitable for structured logging kwargs. Functions format_phase_stats Format stats for a slow phase, if applicable. Returns formatted stats string only if the phase exc… 4 str | None Caret Right def format_phase_stats(phase_name: str, duration_ms: float, component: HasStats | None, slow_threshold_ms: float = 1000) -> str | None Format stats for a slow phase, if applicable. Returns formatted stats string only if the phase exceeded the threshold AND the component has stats available. Parameters 4 Name Type Default Description phase_name str — Name of the phase (e.g., "Directives", "Links") duration_ms float — How long the phase took component HasStats | None — Component with HasStats protocol (or None) slow_threshold_ms float 1000 Threshold for considering a phase "slow" Returns str | None — Formatted stats string, or None if phase was fast or no stats available. ← Previous metadata Next → page_initializer 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: 1547 - Reading Time: 8 minutes