Struct HeartbeatConfig 

pub struct HeartbeatConfig {

    pub enabled: bool,
    pub interval_minutes: u32,
    pub two_phase: bool,
    pub message: Option<String>,
    pub target: Option<String>,
    pub to: Option<String>,
    pub adaptive: bool,
    pub min_interval_minutes: u32,
    pub max_interval_minutes: u32,
    pub deadman_timeout_minutes: u32,
    pub deadman_channel: Option<String>,
    pub deadman_to: Option<String>,
    pub max_run_history: u32,
    pub load_session_context: bool,
}

Heartbeat configuration for periodic health pings ([heartbeat] section).

Fields

enabled: bool

Enable periodic heartbeat pings. Default: false.

interval_minutes: u32

Interval in minutes between heartbeat pings. Default: 5.

two_phase: bool

Enable two-phase heartbeat: Phase 1 asks LLM whether to run, Phase 2 executes only when the LLM decides there is work to do. Saves API cost during quiet periods. Default: true.

message: Option<String>

Optional fallback task text when HEARTBEAT.md has no task entries.

target: Option<String>

Optional delivery channel for heartbeat output (for example: telegram). When omitted, auto-selects the first configured channel.

to: Option<String>

Optional delivery recipient/chat identifier (required when target is explicitly set).

adaptive: bool

Enable adaptive intervals that back off on failures and speed up for high-priority tasks. Default: false.

min_interval_minutes: u32

Minimum interval in minutes when adaptive mode is enabled. Default: 5.

max_interval_minutes: u32

Maximum interval in minutes when adaptive mode backs off. Default: 120.

deadman_timeout_minutes: u32

Dead-man’s switch timeout in minutes. If the heartbeat has not ticked within this window, an alert is sent. 0 disables. Default: 0.

deadman_channel: Option<String>

Channel for dead-man’s switch alerts (e.g. telegram). Falls back to the heartbeat delivery channel.

deadman_to: Option<String>

Recipient for dead-man’s switch alerts. Falls back to to.

max_run_history: u32

Maximum number of heartbeat run history records to retain. Default: 100.

load_session_context: bool

Load the channel session history before each heartbeat task execution so the LLM has conversational context. Default: false.

When true, the session file for the configured target/to is passed to the agent as session_state_file, giving it access to the recent conversation history — just as if the user had sent a message.

Trait Implementations

impl Clone for HeartbeatConfig

fn clone(&self) -> HeartbeatConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeartbeatConfig

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

Formats the value using the given formatter.

impl Default for HeartbeatConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HeartbeatConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HeartbeatConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for HeartbeatConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.