diff --git a/.env b/.env index 9858b1d2..af085d9d 100644 --- a/.env +++ b/.env @@ -3,3 +3,4 @@ SERVER_LOCAL_PORT="8080" STORAGE_DIRPATH="crates/generic-server/target/storage" MONGO_DBN="mediator-coordination" + diff --git a/Cargo.toml b/Cargo.toml index ef3403cf..24db9daf 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -111,6 +111,8 @@ chrono = { workspace = true, optional = true } did-endpoint = { workspace = true, optional = true } oob-messages = { workspace = true, optional = true } didcomm-messaging = { workspace = true, optional = true } +prometheus = "0.13.4" +actix-web = "4.9.0" @@ -135,4 +137,4 @@ mediator-coordination = ["plugin-didcomm_messaging", "didcomm-messaging/mediator [dev-dependencies] -tower = { version = "0.4.13", features = ["util"] } \ No newline at end of file +tower = { version = "0.4.13", features = ["util"] } diff --git a/Dockerfile b/Dockerfile index a7be19ee..ed61b3aa 100644 --- a/Dockerfile +++ b/Dockerfile @@ -17,13 +17,16 @@ WORKDIR /app # Set the storage directory path ENV STORAGE_DIRPATH="crates/generic-server/target/storage" +# Install dependencies for Prometheus metrics +RUN apt-get update && apt-get install -y curl + # Copy the built binary COPY --from=builder /app/target/release/didcomm-mediator /usr/local/bin/didcomm-mediator COPY .env .env # Expose the necessary port -EXPOSE 3000 +EXPOSE 3000 9100 # Set an entrypoint script to handle the environment file ENTRYPOINT ["didcomm-mediator"] diff --git a/docker-compose.yml b/docker-compose.yml index 0bbc6986..89dc6585 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,18 +1,24 @@ version: "3.8" + services: + # DIDComm Mediator Service mediator: build: context: . container_name: didcomm-mediator ports: - - "8080:8080" + - "8080:8080" # Expose the server port + - "9100:9100" # Expose port for Prometheus metrics env_file: - .env depends_on: - mongodb + - prometheus + - grafana networks: - mediator-network - + + # MongoDB Service mongodb: image: mongo:latest container_name: mongodb @@ -23,7 +29,34 @@ services: networks: - mediator-network ports: - - "27017:27017" + - "27018:27017" # Expose MongoDB port + + # Prometheus Service + prometheus: + image: prom/prometheus latest + container_name: prometheus + ports: + - "9091:9090" # Prometheus web interface + command: --config.file=/etc/prometheus/prometheus.yml # Use Prometheus config file + volumes: + - ./prometheus.yml:/etc/prometheus/prometheus.yml # Mount Prometheus config file + networks: + - mediator-network + restart: unless-stopped + + # Grafana Service + grafana: + image: grafana/grafana latest + container_name: grafana + ports: + - "3001:3000" # Expose Grafana web interface on port 3001 + depends_on: + - prometheus + environment: + - GF_SECURITY_ADMIN_PASSWORD=admin # Set Grafana admin password + networks: + - mediator-network + restart: unless-stopped networks: mediator-network: diff --git a/node_exporter-1.6.1.linux-amd64.tar.gz b/node_exporter-1.6.1.linux-amd64.tar.gz new file mode 100644 index 00000000..952c4c31 Binary files /dev/null and b/node_exporter-1.6.1.linux-amd64.tar.gz differ diff --git a/node_exporter-1.6.1.linux-amd64/LICENSE b/node_exporter-1.6.1.linux-amd64/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/node_exporter-1.6.1.linux-amd64/LICENSE @@ -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. diff --git a/node_exporter-1.6.1.linux-amd64/NOTICE b/node_exporter-1.6.1.linux-amd64/NOTICE new file mode 100644 index 00000000..970a9b23 --- /dev/null +++ b/node_exporter-1.6.1.linux-amd64/NOTICE @@ -0,0 +1,17 @@ +Configurable modular Prometheus exporter for various node metrics. +Copyright 2013-2015 The Prometheus Authors + +This product includes software developed at +SoundCloud Ltd. (http://soundcloud.com/). + +The following components are included in this product: + +wifi +https://github.com/mdlayher/wifi +Copyright 2016-2017 Matt Layher +Licensed under the MIT License + +netlink +https://github.com/mdlayher/netlink +Copyright 2016-2017 Matt Layher +Licensed under the MIT License diff --git a/node_exporter-1.6.1.linux-amd64/node_exporter b/node_exporter-1.6.1.linux-amd64/node_exporter new file mode 100755 index 00000000..3e5feb49 Binary files /dev/null and b/node_exporter-1.6.1.linux-amd64/node_exporter differ diff --git a/prometheus.yml b/prometheus.yml new file mode 100644 index 00000000..c467e03b --- /dev/null +++ b/prometheus.yml @@ -0,0 +1,9 @@ +global: + scrape_interval: 15s # Scrape every 15 seconds +evolution_interval: 30s + +scrape_configs: + - job_name: 'didcomm-mediator' + honor_labels: true # Fixed indentation and spelling + static_configs: + - targets: ['mediator:9100'] # Scrape the metrics from the mediator service diff --git a/src/health_metrics.rs b/src/health_metrics.rs new file mode 100644 index 00000000..e7e3f6a2 --- /dev/null +++ b/src/health_metrics.rs @@ -0,0 +1,38 @@ +/*use prometheus::{Encoder, IntCounter, TextEncoder, Opts, Registry}; +use actix_web::{web, App, HttpServer, Responder}; +use std::sync::Arc; +use tokio::sync::RwLock; + +async fn metrics_handler(registry: web::Data>>) -> impl Responder { + let registry = registry.read().await; + let encoder = TextEncoder::new(); + let mut buffer = Vec::new(); + encoder.encode(®istry.gather(), &mut buffer).unwrap(); + String::from_utf8(buffer).unwrap() +} + +#[actix_web::main] +async fn main() -> std::io::Result<()> { + // Set up metrics + let registry = Arc::new(RwLock::new(Registry::new())); + + // Counter example + let counter_opts = Opts::new("request_count", "Number of requests processed"); + let counter = IntCounter::with_opts(counter_opts).unwrap(); + registry.write().await.register(Box::new(counter.clone())).unwrap(); + counter.inc(); + + // Set up server with the metrics endpoint + HttpServer::new(move || { + App::new() + .app_data(web::Data::new(registry.clone())) + .route("/metrics", web::get().to(metrics_handler)) + }) + .bind("0.0.0.0:8080")? + .run() + .await +} + + https://www.youtube.com/watch?v=5ep_NvXJ1Fw + https://www.youtube.com/watch?v=zFDIj7OufE8 +*/ \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index f2812309..9ee04c55 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,5 @@ pub mod plugins; +mod health_metrics; use axum::Router; use eyre::{eyre, Result}; diff --git a/src/main.rs b/src/main.rs index 568d40d9..dc1c55d6 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,7 +1,10 @@ -use axum::Server; +use axum::{routing::get, Router, Server}; use didcomm_mediator::app; use eyre::{Result, WrapErr}; -use std::net::SocketAddr; +use prometheus::{Encoder, TextEncoder, Registry}; +use std::{net::SocketAddr, sync::Arc}; +use tokio::sync::Mutex; +use tower_http::trace::TraceLayer; #[tokio::main] async fn main() -> Result<()> { @@ -11,6 +14,9 @@ async fn main() -> Result<()> { // Enable logging config_tracing(); + // Create a shared registry for Prometheus metrics + let registry = Arc::new(Mutex::new(Registry::new())); + // Start server let port = std::env::var("SERVER_LOCAL_PORT").unwrap_or("3000".to_owned()); let ip = std::env::var("SERVER_PUBLIC_IP").unwrap_or("0.0.0.0".to_owned()); @@ -18,7 +24,7 @@ async fn main() -> Result<()> { tracing::debug!("listening on {}", addr); - generic_server_with_graceful_shutdown(addr) + generic_server_with_graceful_shutdown(addr, registry.clone()) .await .map_err(|err| { tracing::error!("{err:?}"); @@ -28,14 +34,32 @@ async fn main() -> Result<()> { Ok(()) } -async fn generic_server_with_graceful_shutdown(addr: SocketAddr) -> Result<()> { - // Load plugins - let (mut plugin_container, router) = app()?; +async fn generic_server_with_graceful_shutdown( + addr: SocketAddr, + registry: Arc>, +) -> Result<()> { + // Load plugins and get the application router + let (mut plugin_container, app_router) = app()?; + + // Add a `/metrics` route + let metrics_router = Router::new().route( + "/metrics", + get({ + let registry = Arc::clone(®istry); + move || metrics_handler(registry) + }), + ); - // Spawn task for server + // Combine the app router with the metrics router + let app_router = app_router.merge(metrics_router); + // Run the server Server::bind(&addr) - .serve(router.into_make_service()) + .serve( + app_router + .layer(TraceLayer::new_for_http()) // Optional tracing middleware + .into_make_service(), + ) .await .context("failed to start server")?; @@ -49,6 +73,16 @@ async fn generic_server_with_graceful_shutdown(addr: SocketAddr) -> Result<()> { Ok(()) } +/// Expose Prometheus metrics +async fn metrics_handler(registry: Arc>) -> String { + let registry = registry.lock().await; + let encoder = TextEncoder::new(); + let metric_families = registry.gather(); + let mut buffer = Vec::new(); + encoder.encode(&metric_families, &mut buffer).unwrap(); + String::from_utf8(buffer).unwrap() +} + fn config_tracing() { // Enable errors backtrace if std::env::var("RUST_LIB_BACKTRACE").is_err() { @@ -68,4 +102,4 @@ fn config_tracing() { .with(tracing_layer) .with(filter) .init(); -} \ No newline at end of file +}