Skip to content

docs: Update documentation for EventBus-based monitoring #347

Description

@kcenon

Summary

Update documentation to reflect the new EventBus-based monitoring architecture.

Parent Issue

Depends On

Files to Update

  • docs/integration/with-monitoring.md
  • docs/INTEGRATION.md
  • README.md (if applicable)

Content to Add

  1. Migration guide from KCENON_WITH_MONITORING_SYSTEM to EventBus pattern
  2. Example of subscribing to NetworkMetricEvent from monitoring_system
  3. Updated architecture diagrams
  4. API reference for NetworkMetricEvent

Migration Guide Example

// Before: Direct monitoring_system dependency
#if KCENON_WITH_MONITORING_SYSTEM
auto collector = monitoring_system::get_collector();
http_client client(collector);
#else
http_client client;
#endif

// After: EventBus subscription
auto& bus = common::get_event_bus();
bus.subscribe<network::events::NetworkMetricEvent>(
    [](const auto& event) {
        // Process metric event
    }
);

Acceptance Criteria

  • Migration guide complete
  • Architecture diagrams updated
  • All code examples tested

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions