Struct Config 

pub struct Config {

    pub cronitor_base_url: String,
    pub cronitor_api_key: Option<String>,
    pub monitor_name: String,
    pub server_url: String,
    pub endpoint_type: Type,
    pub model_name: String,
    pub env: String,
    pub timeout_seconds: u64,
    pub min_success_freq: Option<u8>,
    pub schedule: Option<String>,
    pub realert_interval: Option<u16>,
    pub consecutive_failures: Option<u8>,
    pub consecutive_missing: Option<u8>,
    pub monitor_group: Option<String>,
    pub collection_path: String,
    pub environment_path: Option<String>,
    pub request_delay_milliseconds: Option<u64>,
}

Configuration for the monitoring tool

Fields

cronitor_base_url: String

Base URL for Cronitor, e.g. https://cronitor.link

cronitor_api_key: Option<String>

Base URL for Cronitor, e.g. https://cronitor.link

monitor_name: String

Monitor name / code in Cronitor

server_url: String

Base URL of the server to probe, e.g. https://my-openai-proxy

endpoint_type: Type

Optional: Probe type to use for the probe. Currently only “llm” is supported.

model_name: String

Name of the model to query

env: String

Environment descriptor (defaults to “production”)

timeout_seconds: u64

Request timeout in seconds (default 10)

min_success_freq: Option<u8>

The below all require an API key to be set to take effect. minFreqRequiredMins catches inactive alerts - if an alert starts but never completes, it’ll be marked as inactive by Cronitor. To force this into raising an alert, we require a successful ping once per any minFreqRequiredMins period. Beware - this can cause some unpredictable behaviour in Cronitor

schedule: Option<String>

Which schedule to display in the frontend and to guide CONSECUTIVE_FAILURES_FOR_ALERT. If none, one isn’t sent to cronitor but will still be running for a cronjob.

realert_interval: Option<u16>

How often we want to resend alerts after the first fails, integer in HOURS

consecutive_failures: Option<u8>

Optional: how many failed pings are needed to trigger an alert. Cronitor assumes 1 if unset.

consecutive_missing: Option<u8>

Optional: how many missing pings are needed to trigger an alert. Cronitor disables this unless specified here as > 0. Requires schedule to be set.

monitor_group: Option<String>

Optional: Group to put monitor in, mostly for frontend viewing.

collection_path: String

Newman-specific options

environment_path: Option<String>

request_delay_milliseconds: Option<u64>

Trait Implementations

impl Args for Config

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for Config

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for Config

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Config

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Config