initial version

Cargo.toml

@@ -3,7 +3,17 @@ name = "prometheus-edge-detector"
 version = "0.1.0"
 authors = ["Robin Appelman <robin@icewind.nl>"]
 edition = "2018"
-
+description = "Find the most recent rising or dropping edge from a prometheus query"
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/icewind1991/prometheus-edge-detector"
 
 [dependencies]
+tokio = { version = "0.2.4", features = ["time"] }
+err-derive = "0.2.1"
+futures-util = "0.3.1"
+reqwest = { version = "0.10.0", features = ["json"]}
+serde = { version = "1.0", features = ["derive"] }
+
+[dev-dependencies]
+tokio = { version = "0.2.4", features = ["macros"] }
+main_error = "0.1.0"

LICENSE-APACHE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

LICENSE-MIT

@@ -0,0 +1,25 @@
+Copyright (c) 2014 The Rust Project Developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,43 @@
+# Prometheus edge detector
+
+Find the most recent rising or dropping edge from a prometheus query
+
+## Usage
+
+```rust
+use main_error::MainError;
+use prometheus_edge_detector::EdgeDetector;
+use tokio::time::Duration;
+
+#[tokio::main]
+async fn main() -> Result<(), MainError> {
+    let edge_detector = EdgeDetector::new("http://example.com");
+    let edge = edge_detector
+        .get_last_edge("prometheus_value", 1, 0, Duration::from_secs(60 * 60))
+        .await?;
+
+    if let Some(edge_time) = edge {
+        print!("Last dropping edge: {}", edge_time);
+    } else {
+        println!("Query doesn't end with dropping edge");
+    }
+
+    Ok(())
+}
+```
+
+## License
+
+Licensed under either of
+
+* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the Apache-2.0
+license, shall be dual licensed as above, without any additional terms or
+conditions.

examples/test.rs

@@ -0,0 +1,19 @@
+use main_error::MainError;
+use prometheus_edge_detector::EdgeDetector;
+use tokio::time::Duration;
+
+#[tokio::main]
+async fn main() -> Result<(), MainError> {
+    let edge_detector = EdgeDetector::new("http://example.com");
+    let edge = edge_detector
+        .get_last_edge("prometheus_value", 1, 0, Duration::from_secs(60 * 60))
+        .await?;
+
+    if let Some(edge_time) = edge {
+        print!("Last dropping edge: {}", edge_time);
+    } else {
+        println!("Query doesn't end with dropping edge");
+    }
+
+    Ok(())
+}

src/lib.rs

@@ -1,7 +1,174 @@
-#[cfg(test)]
+use err_derive::Error;
-mod tests {
+use reqwest::Client;
-    #[test]
+use serde::Deserialize;
-    fn it_works() {
+use std::time::SystemTime;
-        assert_eq!(2 + 2, 4);
+use tokio::time::Duration;
+
+#[derive(Debug, Error)]
+pub enum Error {
+    #[error(display = "Network error: {}", _0)]
+    Network(reqwest::Error),
+    #[error(display = "Malformed json response: {}", _0)]
+    MalformedResponse(reqwest::Error),
+    #[error(display = "Data point is not an interger: {}", _0)]
+    NonNumericDataPoint(String),
+}
+
+#[derive(Debug, Clone, Deserialize)]
+#[serde(rename_all = "lowercase")]
+pub enum QueryResultStatus {
+    Success,
+    Error,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+struct QueryResult {
+    status: QueryResultStatus,
+    data: QueryResultData,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+#[serde(rename_all = "lowercase")]
+enum QueryResultDataType {
+    Matrix,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+#[serde(rename_all = "camelCase")]
+struct QueryResultData {
+    result_type: QueryResultDataType,
+    result: Vec<QueryResultDataResult>,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+struct QueryResultDataResult {
+    metric: QueryResultDataResultMetric,
+    values: Vec<QueryResultDataResultValue>,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+struct QueryResultDataResultMetric {
+    #[serde(rename = "__name__")]
+    id: String,
+    instance: String,
+    job: String,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+struct QueryResultDataResultValue(u64, String);
+
+async fn query_prometheus(
+    client: &Client,
+    base_url: &str,
+    query: &str,
+    start: u64,
+    end: u64,
+    step: usize,
+) -> Result<QueryResult, Error> {
+    client
+        .get(base_url)
+        .query(&[
+            ("query", query),
+            ("start", &format!("{}", start)),
+            ("end", &format!("{}", end)),
+            ("step", &format!("{}", step)),
+        ])
+        .send()
+        .await
+        .map_err(|err| Error::Network(err))?
+        .json()
+        .await
+        .map_err(|err| Error::MalformedResponse(err))
+}
+
+#[derive(Debug, Clone)]
+pub struct EdgeDetector {
+    client: Client,
+    base_url: String,
+}
+
+impl EdgeDetector {
+    pub fn new(prometheus_url: impl std::fmt::Display) -> Self {
+        EdgeDetector {
+            client: Client::new(),
+            base_url: format!("{}/api/v1/query_range", prometheus_url),
+        }
+    }
+
+    pub async fn get_last_edge(
+        &self,
+        query: &str,
+        from: u64,
+        to: u64,
+        max_age: Duration,
+    ) -> Result<Option<u64>, Error> {
+        let end_time = SystemTime::now();
+        let start_time = end_time - max_age;
+
+        let end_time = end_time
+            .duration_since(SystemTime::UNIX_EPOCH)
+            .unwrap()
+            .as_secs();
+        let start_time = start_time
+            .duration_since(SystemTime::UNIX_EPOCH)
+            .unwrap()
+            .as_secs();
+
+        self.get_edge_between(query, from, to, start_time, end_time)
+            .await
+    }
+
+    pub async fn get_edge_between(
+        &self,
+        query: &str,
+        from: u64,
+        to: u64,
+        start_time: u64,
+        end_time: u64,
+    ) -> Result<Option<u64>, Error> {
+        let rising = from < to;
+
+        let data = query_prometheus(
+            &self.client,
+            &self.base_url,
+            query,
+            start_time,
+            end_time,
+            60,
+        )
+        .await?
+        .data
+        .result;
+
+        let first_data = match data.into_iter().next() {
+            Some(result) => result,
+            None => return Ok(None),
+        };
+
+        let mut last_from_time = 0;
+        let mut last_to_time = 0;
+
+        for point in first_data.values {
+            let QueryResultDataResultValue(time, value_str) = point;
+            let value: u64 = value_str
+                .parse()
+                .map_err(|_| Error::NonNumericDataPoint(value_str))?;
+
+            let is_from_value = if rising { value <= from } else { value >= from };
+
+            let is_to_value = if rising { value >= from } else { value <= from };
+
+            if is_from_value {
+                last_from_time = time;
+            } else if is_to_value {
+                last_to_time = time;
+            }
+        }
+
+        if last_from_time > 0 && last_to_time > last_from_time {
+            Ok(Some(last_from_time))
+        } else {
+            Ok(None)
+        }
     }
 }