Skip to content

Commit

Permalink
add monitor module comment
Browse files Browse the repository at this point in the history
  • Loading branch information
drmille2 committed Nov 24, 2024
1 parent 5e69686 commit 7c7b8fc
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions src/monitor.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
//! Monitor and related structs used to build and run independent
//! asynchronous synthetic monitors.
//!
//! Each monitor has a hashmap of reporters registered to it
//! (heap allocated) that are referenced by-name at each configured
//! level to determine how the output of each monitor execution
//! should be reported.
//!
//! Monitors also include an ordered colletion (Vec) of Levels that
//! are used to configure the different reporting behavior and rules
//! for escalating/clearing based on failures or successes.
//!
//! Finally each Monitor is created with a Target that defines what
//! will be executed and reported on each monitoring cycle.
//!
//! Includes structs for creation arguments that implement serde
//! deserialize for easy parsing from user-provided configuration.
//!
//! Also defines the Reporter async trait and MonitorResult struct
//! that can be used to create new reporter modules.
//!
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
Expand Down

0 comments on commit 7c7b8fc

Please sign in to comment.