iroh_services/lib.rs
1//! iroh-services is the client side of interacting with [iroh-services]. iroh-services gives
2//! visibility into a running iroh network by pushing metrics aggregations
3//! from [iroh] endpoints into a central hub for monitoring.
4//!
5//! Typical setup looks something like this:
6//! ```no_run
7//! use iroh::{Endpoint, endpoint::presets};
8//! use iroh_services::Client;
9//!
10//! #[tokio::main]
11//! async fn main() -> anyhow::Result<()> {
12//! let endpoint = Endpoint::bind(presets::N0).await?;
13//!
14//! // needs IROH_SERVICES_API_SECRET set to an environment variable
15//! // client will now push endpoint metrics to iroh-services.
16//! let client = Client::builder(&endpoint)
17//! .api_secret_from_env()?
18//! .build()
19//! .await?;
20//!
21//! // we can also ping the service just to confirm everything is working
22//! client.ping().await?;
23//!
24//! Ok(())
25//! }
26//! ```
27//!
28//! [iroh-services]: https://services.iroh.computer
29//! [iroh]: https://iroh.computer
30
31mod client;
32mod client_host;
33#[cfg(not(target_arch = "wasm32"))]
34mod openssh;
35
36pub mod api_secret;
37pub mod caps;
38pub mod net_diagnostics;
39pub mod protocol;
40
41mod built_info {
42 include!(concat!(env!("OUT_DIR"), "/built.rs"));
43}
44
45/// Version of this crate.
46pub const IROH_SERVICES_VERSION: &str = built_info::PKG_VERSION;
47
48/// Version of iroh this crate was built against.
49pub static IROH_VERSION: std::sync::LazyLock<&str> = std::sync::LazyLock::new(|| {
50 built_info::DEPENDENCIES
51 .iter()
52 .find(|(name, _)| *name == "iroh")
53 .expect("iroh dependency not found")
54 .1
55});
56
57pub use anyhow;
58pub use client_host::{CLIENT_HOST_ALPN, ClientHost, ClientHostClient};
59pub use iroh_metrics::Registry;
60
61pub use self::{
62 api_secret::ApiSecret,
63 client::{API_SECRET_ENV_VAR_NAME, Client, ClientBuilder},
64 net_diagnostics::{DiagnosticsReport, checks::run_diagnostics},
65 protocol::ALPN,
66};