Implementation of O11ySources Diagnostics

Diagnostics Stages

The O11ySources Diagnostics feature operates across three distinct stages, aligning with the data journey:

1. Diagnosing Data Ingestion: This stage focuses on the interaction between agents and the system. It verifies whether agents are operational, establishing connections to Kafka for seamless data transmission.
2. Inspecting Data Processing: In this stage, the focus shifts to data movement. It ensures that data has successfully traversed the path from sources to the input topic and then through pipelines to the output topic.
3. Assessing Data Storage: The final stage examines the data storage’s status. It verifies whether databases like ES or TSDB are operational and accessible, and if the data is present as expected.

Visualizing Data Collection Status

In the O11ySources Source tab, each host’s data collection status for the last 15 minutes is vividly displayed in a dedicated column. Color-coded buttons provide a quick visual indicator.

The listing page features a data reception status indicator, which indicates whether data has been received by the system within the last 15 minutes. Simultaneously, a diagnostic process is initiated for a duration of 15 minutes.

Interactive Insights

Hovering over these status buttons reveals a text box popup that comprehensively details the status:

1. Green: Data Reception working fine – Not clickable
2. Orange: Data not received from one or more sources – Click for more info or restart diagnostics
3. Red: No data received at all – Click for more info or restart diagnostics

Performing Diagnostics

1. If the status indicator is either Red or Orange, it indicates a potential issue. To initiate diagnostics, click on the respective status icon.
   
   
   
2. Upon clicking the status icon, a modal window will appear. This modal window will provide access to commence diagnostics.
   
   
   
3. Upon initiation, the diagnostics will commence, and you will have the ability to observe the ongoing progress and status of the diagnostics operation. If necessary, you can interrupt the diagnostics process by opting to cancel it at any point during its execution.
   
   
   
4. Upon successful completion of the diagnostics, the outcomes will be presented. An illustrative example of the diagnostic results is provided below:
   
   
   

Detailed Data Flow Status

Clicking the colored status button opens a dialogue box showcasing the data flow status at each stage. This includes agent status, input topic, pipelines, output topic, and data store. Color coding highlights data reception (green) and absence (red).

💡Note: This feature is an initial release of O11ySources Diagnostics, focusing on data presence in specific stages. Service and connection status information will be incorporated in subsequent phases.