ic_query/ic/
mod.rs

1//! Official IC Dashboard API report models, adapters, builders, and renderers.
2
3#[cfg(feature = "host")]
4mod build;
5#[cfg(feature = "host")]
6mod live;
7mod model;
8#[cfg(feature = "host")]
9mod source;
10mod text;
11
12#[cfg(feature = "host")]
13pub use build::{
14    build_ic_boundary_node_data_centers_report,
15    build_ic_boundary_node_data_centers_report_with_source, build_ic_canister_count_report,
16    build_ic_canister_count_report_with_source, build_ic_canister_page_report,
17    build_ic_canister_page_report_with_source, build_ic_daily_stats_report,
18    build_ic_daily_stats_report_with_source, build_ic_metric_report,
19    build_ic_metric_report_with_source,
20};
21#[cfg(feature = "host")]
22pub use build::{build_ic_canister_report, build_ic_canister_report_with_source};
23#[cfg(feature = "host")]
24pub use live::LiveIcSource;
25pub use model::{
26    IcBoundaryNodeDataCenterRow, IcBoundaryNodeDataCentersReport, IcBoundaryNodeDataCentersRequest,
27    IcCanisterCountReport, IcCanisterCountRequest, IcCanisterFilters, IcCanisterPageController,
28    IcCanisterPageReport, IcCanisterPageRequest, IcCanisterPageRow, IcCanisterReport,
29    IcCanisterRequest, IcCanisterUpgrade, IcDailyStatsQuery, IcDailyStatsReport,
30    IcDailyStatsRequest, IcDailyStatsRow, IcDashboardReportProvenance, IcMetricKind,
31    IcMetricObservation, IcMetricQuery, IcMetricReport, IcMetricRequest, IcMetricSeries,
32};
33#[cfg(feature = "host")]
34pub use model::{
35    IcBoundaryNodeDataCentersSourceData, IcCanisterCountSourceData, IcCanisterPageSourceData,
36    IcCanisterSourceData, IcDailyStatsSourceData, IcHostError, IcMetricSourceData, IcSourceRequest,
37};
38#[cfg(feature = "host")]
39pub use source::{IcCanisterCollectionSource, IcCanisterSource, IcMetricSource, IcNetworkSource};
40pub use text::{
41    ic_boundary_node_data_centers_report_text, ic_canister_count_report_text,
42    ic_canister_page_report_text, ic_canister_report_text, ic_daily_stats_report_text,
43    ic_metric_report_text,
44};
45
46/// Default base endpoint for the official IC Dashboard API.
47pub const DEFAULT_IC_DASHBOARD_SOURCE_ENDPOINT: &str = "https://ic-api.internetcomputer.org/api/v3";
48
49/// Default base endpoint for official IC Dashboard canister collection queries.
50pub const DEFAULT_IC_DASHBOARD_CANISTER_COLLECTION_SOURCE_ENDPOINT: &str =
51    "https://ic-api.internetcomputer.org/api/v4";
52
53/// Default base endpoint for the official IC Dashboard Metrics API.
54pub const DEFAULT_IC_DASHBOARD_METRICS_SOURCE_ENDPOINT: &str =
55    "https://metrics-api.internetcomputer.org/api/v1";
56
57/// Default base endpoint for official boundary-node data-center queries.
58pub const DEFAULT_IC_BOUNDARY_NODE_DATA_CENTERS_SOURCE_ENDPOINT: &str =
59    "https://ic-api.internetcomputer.org/api/v4";
60
61/// Default row limit for one official Dashboard canister page.
62pub const DEFAULT_IC_CANISTER_PAGE_LIMIT: u16 = 50;
63
64/// Maximum row limit accepted for one official Dashboard canister page.
65pub const MAX_IC_CANISTER_PAGE_LIMIT: u16 = 100;
66
67/// Default relative window for one Dashboard metric query.
68pub const DEFAULT_IC_METRIC_WINDOW_SECS: u64 = 3_600;
69
70/// Default interval between requested Dashboard metric observations.
71pub const DEFAULT_IC_METRIC_STEP_SECS: u32 = 300;
72
73/// Earliest timestamp accepted by the official Dashboard Metrics API.
74pub const MIN_IC_METRIC_TIMESTAMP: u64 = 1_620_432_000;
75
76/// Largest step accepted by the official Dashboard Metrics API.
77pub const MAX_IC_METRIC_STEP_SECS: u32 = 259_200;
78
79/// Maximum requested observations accepted per metric series.
80pub const MAX_IC_METRIC_OBSERVATIONS_PER_SERIES: u64 = 1_000;
81
82/// Default relative window for one Dashboard daily-statistics query.
83pub const DEFAULT_IC_DAILY_STATS_WINDOW_SECS: u64 = 7 * 24 * 60 * 60;
84
85/// Earliest timestamp accepted by the official Dashboard daily-statistics API.
86pub const MIN_IC_DAILY_STATS_TIMESTAMP: u64 = 1_620_406_800;
87
88/// Largest time window accepted by one daily-statistics request.
89pub const MAX_IC_DAILY_STATS_WINDOW_SECS: u64 = 366 * 24 * 60 * 60;
90
91/// Maximum daily-statistics rows accepted from one source response.
92pub const MAX_IC_DAILY_STATS_ROWS: usize = 366;
93
94/// Maximum boundary-node data-center rows accepted from one source response.
95pub const MAX_IC_BOUNDARY_NODE_DATA_CENTERS: usize = 1_000;
96
97#[cfg(feature = "host")]
98const IC_DASHBOARD_REPORT_SCHEMA_VERSION: u32 = 1;
99#[cfg(feature = "host")]
100const IC_DASHBOARD_AUTHORITY: &str = "official_ic_dashboard_api";
101#[cfg(feature = "host")]
102const IC_DASHBOARD_NETWORK: &str = "ic";
103
104#[cfg(all(test, feature = "host"))]
105mod tests;
ic_query/ic/mod.rs

ic_query/ic/
mod.rs
