Files
adcs_api
cbor_protocol
channel_protocol
clyde_3g_eps_api
clyde_3g_eps_service
comms_service
db_test
eps_api
example_rust_c_service
example_rust_service
extern_lib
file_protocol
file_service
iobc_supervisor_service
isis_ants
isis_ants_api
isis_ants_service
isis_imtq_api
isis_iobc_supervisor
kubos_app
kubos_app_service
kubos_build_helper
kubos_file_client
kubos_service
kubos_shell_client
kubos_system
kubos_telemetry_db
large_download
large_upload
local_comms_service
mai400
mai400_api
mai400_service
monitor_service
novatel_oem6_api
novatel_oem6_service
nsl_duplex_d2
nsl_duplex_d2_comms_service
obc_hs
radio_api
rust_i2c
rust_mission_app
rust_uart
scheduler_service
serial_comms_service
shell_protocol
shell_service
telemetry_service
uart_comms_client
udp_client
utils
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
//
// Copyright (C) 2019 Kubos Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// OBC Housekeeping Application
//
// Default behavior:
// - Clean out any telemetry database entries which are older than a week
// - Check for excessive disk or RAM usage
// - Check for corruption in the user data partition
// - Check for OBC resets
// - Ping all the services

mod check_fs;
mod check_mem;
mod check_reset;
mod clean_db;
mod ping;

use failure::{bail, err_msg, Error};
use kubos_app::*;
use log::*;
use std::time::Duration;

/************** App Configuration Values **********************/

// Radio-specific options:

// Communications service which should be used for sending distress beacon if the filesystem
// becomes corrupted.
// If no beacon is desired, make this value an empty string ("")
pub const COMMS_SERVICE: &str = "local-comms-service";
// Comms service downlink port
pub const DOWNLINK_PORT: u16 = 8080;

// General options:

// Location of the systems configuration file
pub const CONFIG_PATH: &str = "/etc/kubos-config.toml";

// Maximum telemetry entry age. Default: 1 week (60*60*24*7)
pub const TELEMETRY_AGE: f64 = 604_800.0;
// Maximum telemetry entry age when system is low on disk space. Default: 1 day (60*60*24)
pub const CRITICAL_AGE: f64 = 86400.0;

// RAM usage % which is considered nominal
pub const RAM_NOMINAL: u8 = 50;
// RAM usage % which is considered high, but acceptable
pub const RAM_HIGH: u8 = 70;
// RAM usage % which is considered critically high. Recovery actions should be triggered
pub const RAM_CRITICAL: u8 = 80;

// Disk usage % which is considered nominal
pub const DISK_NOMINAL: u8 = 50;
// RAM usage % which is considered high, but acceptable
pub const DISK_HIGH: u8 = 70;
// RAM usage % which is considered critically high. Recovery actions should be triggered
pub const DISK_CRITICAL: u8 = 80;

// Amount of time to wait for responses from the services
pub const QUERY_TIMEOUT: Duration = Duration::from_millis(200);

/************** End of Configuration **************************/

fn main() -> Result<(), Error> {
    logging_setup!(env!("CARGO_PKG_NAME"))?;

    // Delete old database entries
    if let Err(error) = clean_db::clean_db(TELEMETRY_AGE) {
        error!("Error while cleaning telemetry database: {:?}", error);
    }

    // Check RAM and disk usage
    if let Err(error) = check_mem::check_mem() {
        error!("Error while checking memory: {:?}", error);
    }

    // Check for file system corruption
    if let Err(error) = check_fs::check_fs() {
        error!("Error while checking filesystem {:?}", error);
    }

    // Check for system reset
    if let Err(error) = check_reset::check_reset() {
        error!("Error while checking system reset: {:?}", error);
    }

    // Ping all services
    match ping::ping_services() {
        Ok(0) => info!("Successfully pinged all services"),
        Ok(count) => warn!("Failed to ping {} services", count),
        Err(error) => error!("Error while pinging the services: {:?}", error),
    }

    Ok(())
}