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 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
// // Copyright (C) 2018 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. // #![deny(missing_docs)] #![deny(warnings)] //! Kubos Service for interacting with the telemetry database. //! //! # Configuration //! //! The service can be configured in the `/etc/kubos-config.toml` with the following fields: //! //! ``` //! [telemetry-service] //! database = "/var/lib/telemetry.db" //! //! [telemetry-service.addr] //! ip = "127.0.0.1" //! port = 8020 //! ``` //! //! Where `database` specifies the path to the telemetry database file, `ip` specifies the //! service's IP address, and `port` specifies the port on which the service will be //! listening for UDP packets. //! //! # Starting the Service //! //! The service should be started automatically by its init script, but may also be started manually: //! //! ``` //! $ telemetry-service //! Listening on: 127.0.0.1:8020 //! ``` //! //! # Panics //! //! Attempts to grab database path from Configuration and will `panic!` if not found. //! Attempts to connect to database at provided path and will `panic!` if connection fails. //! Attempts to create telemetry table and will `panic!` if table creation fails. //! //! # GraphQL Schema //! //! ```graphql //! type Entry { //! timestamp: Integer! //! subsystem: String! //! parameter: String! //! value: Float! //! } //! //! query ping: "pong" //! query telemetry(timestampGe: Integer, timestampLe: Integer, subsystem: String, parameter: String, parameters: [String]): Entry //! query routedTelemetry(timestampGe: Integer, timestampLe: Integer, subsystem: String, parameter: String, parameters: [String], output: String!, compress: Boolean = true): String! //! //! mutation insert(timestamp: Integer, subsystem: String!, parameter: String!, value: String!):{ success: Boolean!, errors: String! } //! ``` //! //! # Example Queries //! //! ## Select all attributes of all telemetry entries //! ```graphql //! { //! telemetry { //! timestamp, //! subsystem, //! parameter, //! value //! } //! } //! ``` //! //! ## Select all attributes of all telemetry entries for the eps subsystem //! ```graphql //! { //! telemetry(subsystem: "eps") { //! timestamp, //! subsystem, //! parameter, //! value //! } //! } //! ``` //! //! ## Select all attributes of all telemetry entries for the voltage parameter of the eps subsystem //! ```graphql //! { //! telemetry(subsystem: "eps", parameter: "voltage") { //! timestamp, //! subsystem, //! parameter, //! value //! } //! } //! ``` //! //! ## Select all attributes of all telemetry entries for the voltage and current parameters of the eps subsystem //! ```graphql //! { //! telemetry(subsystem: "eps", parameters: ["voltage", "current"]) { //! timestamp, //! subsystem, //! parameter, //! value //! } //! } //! ``` //! //! ## Select all attributes of all telemetry entries occurring between the timestamps 100 and 200 //! ```graphql //! { //! telemetry(timestampGe: 101, timestampLe: 199) { //! timestamp, //! subsystem, //! parameter, //! value //! } //! } //! ``` //! //! ## Select all attributes of all telemetry entries occurring at the timestamp 101 //! ```graphql //! { //! telemetry(timestampGe: 101, timestampLe: 101) { //! timestamp, //! subsystem, //! parameter, //! value //! } //! } //! ``` //! //! ## Select ten entries occurring on or after the timestamp 1008 //! ```graphql //! { //! telemetry(limit: 10, timestampGe: 1008) { //! timestamp, //! subsystem, //! parameter, //! value //! } //! } //! ``` //! //! ## Repeat the previous query, but route the output to compressed file `/home/system/recent_telem.tar.gz` //! ```graphql //! { //! telemetry(limit: 10, timestampGe: 1008, output: "/home/system/recent_telem") //! } //! ``` //! //! ## Repeat the previous query, but route the output to uncompressed file `/home/system/recent_telem` //! ```graphql //! { //! telemetry(limit: 10, timestampGe: 1008, output: "/home/system/recent_telem", compress: false) //! } //! ``` //! //! # Example Mutations //! //! ## Insert a new entry, allowing the service to generate the timestamp //! ```graphql //! mutation { //! insert(subsystem: "eps", parameter: "voltage", value: "4.0") { //! success, //! errors //! } //! } //! ``` //! //! ## Insert a new entry with a custom timestamp //! ```graphql //! mutation { //! insert(timestamp: 533, subsystem: "eps", parameter: "voltage", value: "5.1") { //! success, //! errors //! } //! } //! //! ``` //! //! ## Delete all entries from the EPS subsystem occuring before timestamp 1003 //! ```graphql //! mutation { //! delete(subsystem: "eps", timestampLe: 1004) { //! success, //! errors, //! entriesDeleted //! } //! } //! ``` #[macro_use] extern crate juniper; mod schema; mod udp; use crate::schema::{MutationRoot, QueryRoot, Subsystem}; use kubos_service::{Config, Logger, Service}; use kubos_telemetry_db::Database; use log::error; fn main() { Logger::init("kubos-telemetry-service").unwrap(); let config = Config::new("telemetry-service") .map_err(|err| { error!("Failed to load service config: {:?}", err); err }) .unwrap(); let db_path = config .get("database") .ok_or_else(|| { error!("No database path found in config file"); "No database path found in config file" }) .unwrap(); let db_path = db_path .as_str() .ok_or_else(|| { error!("Failed to parse 'database' config value"); "Failed to parse 'database' config value" }) .unwrap(); let db = Database::new(&db_path); db.setup(); let direct_udp = config.get("direct_port").map(|port| { let host = config .hosturl() .ok_or_else(|| { error!("Failed to load service URL"); "Failed to load service URL" }) .unwrap(); let mut host_parts = host.split(':').map(|val| val.to_owned()); let host_ip = host_parts .next() .ok_or_else(|| { error!("Failed to parse service IP address"); "Failed to parse service IP address" }) .unwrap(); format!("{}:{}", host_ip, port) }); Service::new( config, Subsystem::new(db, direct_udp), QueryRoot, MutationRoot, ) .start(); }