all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Dietmar Maurer <dietmar@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 10/15] proxmox-rrd: add binary to create/manage rrd files
Date: Wed, 13 Oct 2021 10:24:47 +0200	[thread overview]
Message-ID: <20211013082452.619406-11-dietmar@proxmox.com> (raw)
In-Reply-To: <20211013082452.619406-1-dietmar@proxmox.com>

---
 proxmox-rrd/Cargo.toml     |   1 +
 proxmox-rrd/src/bin/rrd.rs | 215 +++++++++++++++++++++++++++++++++++++
 2 files changed, 216 insertions(+)
 create mode 100644 proxmox-rrd/src/bin/rrd.rs

diff --git a/proxmox-rrd/Cargo.toml b/proxmox-rrd/Cargo.toml
index 69a68530..e3ab5380 100644
--- a/proxmox-rrd/Cargo.toml
+++ b/proxmox-rrd/Cargo.toml
@@ -16,4 +16,5 @@ serde_cbor = "0.11.1"
 
 proxmox = { version = "0.14.0" }
 proxmox-time = "1"
+proxmox-router = "1"
 proxmox-schema = { version = "1", features = [ "api-macro" ] }
diff --git a/proxmox-rrd/src/bin/rrd.rs b/proxmox-rrd/src/bin/rrd.rs
new file mode 100644
index 00000000..fdb61ffd
--- /dev/null
+++ b/proxmox-rrd/src/bin/rrd.rs
@@ -0,0 +1,215 @@
+//! RRD toolkit - create/manage/update proxmox RRD (v2) file
+
+use std::path::PathBuf;
+
+use anyhow::{bail, Error};
+use serde::{Serialize, Deserialize};
+
+use proxmox_router::RpcEnvironment;
+use proxmox_router::cli::{run_cli_command, CliCommand, CliCommandMap, CliEnvironment};
+use proxmox_schema::{api, parse_property_string};
+use proxmox_schema::{ApiStringFormat, ApiType, Schema, StringSchema};
+
+use proxmox::tools::fs::CreateOptions;
+
+use proxmox_rrd::rrd::{CF, DST, RRA, RRD};
+
+pub const RRA_CONFIG_STRING_SCHEMA: Schema = StringSchema::new(
+    "RRA configuration")
+    .format(&ApiStringFormat::PropertyString(&RRAConfig::API_SCHEMA))
+    .schema();
+
+#[api(
+    properties: {},
+    default_key: "cf",
+)]
+#[derive(Debug, Serialize, Deserialize)]
+/// RRA configuration
+pub struct RRAConfig {
+    /// Time resolution
+    pub r: u64,
+    pub cf: CF,
+    /// Number of data points
+    pub n: u64,
+}
+
+#[api(
+   input: {
+       properties: {
+          path: {
+              description: "The filename."
+          },
+       },
+   },
+)]
+/// Dump the RRDB database in JSON format
+pub fn dump_rrdb(path: String) -> Result<(), Error> {
+
+    let rrd = RRD::load(&PathBuf::from(path))?;
+    serde_json::to_writer_pretty(std::io::stdout(), &rrd)?;
+    Ok(())
+}
+
+#[api(
+   input: {
+       properties: {
+           path: {
+               description: "The filename."
+           },
+           time: {
+               description: "Update time.",
+               optional: true,
+           },
+           value: {
+               description: "Update value.",
+           },
+       },
+   },
+)]
+/// Update the RRDB database
+pub fn update_rrdb(
+    path: String,
+    time: Option<u64>,
+    value: f64,
+) -> Result<(), Error> {
+
+    let path = PathBuf::from(path);
+
+    let time = time.map(|v| v as f64)
+        .unwrap_or_else(proxmox_time::epoch_f64);
+
+    let mut rrd = RRD::load(&path)?;
+    rrd.update(time, value);
+
+    rrd.save(&path, CreateOptions::new())?;
+
+    Ok(())
+}
+
+#[api(
+   input: {
+       properties: {
+           path: {
+               description: "The filename."
+           },
+           cf: {
+               type: CF,
+           },
+           resolution: {
+               description: "Time resulution",
+           },
+           start: {
+               description: "Start time. If not sepecified, we simply extract 10 data points.",
+               optional: true,
+           },
+           end: {
+               description: "End time (Unix Epoch). Default is the last update time.",
+               optional: true,
+           },
+       },
+   },
+)]
+/// Fetch data from the RRDB database
+pub fn fetch_rrdb(
+    path: String,
+    cf: CF,
+    resolution: u64,
+    start: Option<u64>,
+    end: Option<u64>,
+) -> Result<(), Error> {
+
+    let rrd = RRD::load(&PathBuf::from(path))?;
+
+    let data = rrd.extract_data(cf, resolution, start, end)?;
+
+    println!("{}", serde_json::to_string_pretty(&data)?);
+
+    Ok(())
+}
+
+#[api(
+   input: {
+       properties: {
+           dst: {
+               type: DST,
+           },
+           path: {
+               description: "The filename to create."
+           },
+           rra: {
+               description: "Configuration of contained RRAs.",
+               type: Array,
+               items: {
+                   schema:  RRA_CONFIG_STRING_SCHEMA,
+               }
+           },
+       },
+   },
+)]
+/// Create a new RRDB database file
+pub fn create_rrdb(
+    dst: DST,
+    path: String,
+    rra: Vec<String>,
+) -> Result<(), Error> {
+
+    let mut rra_list = Vec::new();
+
+    for item in rra.iter() {
+        let rra: RRAConfig = serde_json::from_value(
+            parse_property_string(item, &RRAConfig::API_SCHEMA)?
+        )?;
+        println!("GOT {:?}", rra);
+        rra_list.push(RRA::new(rra.cf, rra.r, rra.n as usize));
+    }
+
+    let path = PathBuf::from(path);
+
+    let rrd = RRD::new(dst, rra_list);
+
+    rrd.save(&path, CreateOptions::new())?;
+
+    Ok(())
+}
+
+
+fn main() -> Result<(), Error> {
+
+    let uid = nix::unistd::Uid::current();
+
+    let username = match nix::unistd::User::from_uid(uid)? {
+        Some(user) => user.name,
+        None => bail!("unable to get user name"),
+    };
+
+    let cmd_def = CliCommandMap::new()
+        .insert(
+            "create",
+            CliCommand::new(&API_METHOD_CREATE_RRDB)
+                .arg_param(&["path"])
+        )
+        .insert(
+            "update",
+            CliCommand::new(&API_METHOD_UPDATE_RRDB)
+                .arg_param(&["path"])
+        )
+        .insert(
+            "fetch",
+            CliCommand::new(&API_METHOD_FETCH_RRDB)
+                .arg_param(&["path"])
+        )
+        .insert(
+            "dump",
+            CliCommand::new(&API_METHOD_DUMP_RRDB)
+                .arg_param(&["path"])
+        )
+        ;
+
+    let mut rpcenv = CliEnvironment::new();
+    rpcenv.set_auth_id(Some(format!("{}@pam", username)));
+
+    run_cli_command(cmd_def, rpcenv, None);
+
+    Ok(())
+
+}
-- 
2.30.2





  parent reply	other threads:[~2021-10-13  8:25 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-13  8:24 [pbs-devel] [PATCH proxmox-backup 00/15] RRD database improvements Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 01/15] proxmox-rrd: use a journal to reduce amount of bytes written Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 02/15] RRD_CACHE: use a OnceCell instead of lazy_static Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 03/15] proxmox-backup-proxy: use tokio::task::spawn_blocking instead of block_in_place Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 04/15] proxmox-rrd: implement new CBOR based format Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 05/15] proxmox-rrd: remove dependency to proxmox-rrd-api-types Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 06/15] proxmox-rrd: extract_data: include values from current slot Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 07/15] remove proxmox-rrd-api-types crate, s/RRDTimeFrameResolution/RRDTimeFrame/ Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 08/15] proxmox-rrd: support CF::Last Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 09/15] proxmox-rrd: split out load_rrd (cleanup) Dietmar Maurer
2021-10-13  8:24 ` Dietmar Maurer [this message]
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 11/15] proxmox-rrd: avoid % inside loop Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 12/15] proxmox-rrd: new helper methods - slot() and slot_end_time() Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 13/15] proxmox-rrd: protect against negative update time Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 14/15] proxmox-rrd: rename last_counter to last_value Dietmar Maurer
2021-10-13  8:24 ` [pbs-devel] [PATCH proxmox-backup 15/15] proxmox-rrd: add more commands to the rrd cli tool Dietmar Maurer
2021-10-13 11:58 ` [pbs-devel] applied-series: [PATCH proxmox-backup 00/15] RRD database improvements Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211013082452.619406-11-dietmar@proxmox.com \
    --to=dietmar@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal