Skip to main content

Module ic

Module ic 

Source
Expand description

Official IC Dashboard API report models, adapters, builders, and renderers.

Structs§

IcBoundaryNodeDataCenterRow
IcBoundaryNodeDataCenterRow
IcBoundaryNodeDataCentersReport
IcBoundaryNodeDataCentersReport
IcBoundaryNodeDataCentersRequest
IcBoundaryNodeDataCentersRequest
IcCanisterCountReport
IcCanisterCountReport
IcCanisterCountRequest
IcCanisterCountRequest
IcCanisterFilters
IcCanisterFilters
IcCanisterPageController
IcCanisterPageController
IcCanisterPageReport
IcCanisterPageReport
IcCanisterPageRequest
IcCanisterPageRequest
IcCanisterPageRow
IcCanisterPageRow
IcCanisterReport
IcCanisterReport
IcCanisterRequest
IcCanisterRequest
IcCanisterUpgrade
IcCanisterUpgrade
IcDailyStatsQuery
IcDailyStatsQuery
IcDailyStatsReport
IcDailyStatsReport
IcDailyStatsRequest
IcDailyStatsRequest
IcDailyStatsRow
IcDailyStatsRow
IcDashboardReportProvenance
IcDashboardReportProvenance
IcMetricObservation
IcMetricObservation
IcMetricQuery
IcMetricQuery
IcMetricReport
IcMetricReport
IcMetricRequest
IcMetricRequest
IcMetricSeries
IcMetricSeries

Enums§

IcMetricKind
IcMetricKind

Constants§

DEFAULT_IC_BOUNDARY_NODE_DATA_CENTERS_SOURCE_ENDPOINT
Default base endpoint for official boundary-node data-center queries.
DEFAULT_IC_CANISTER_PAGE_LIMIT
Default row limit for one official Dashboard canister page.
DEFAULT_IC_DAILY_STATS_WINDOW_SECS
Default relative window for one Dashboard daily-statistics query.
DEFAULT_IC_DASHBOARD_CANISTER_COLLECTION_SOURCE_ENDPOINT
Default base endpoint for official IC Dashboard canister collection queries.
DEFAULT_IC_DASHBOARD_METRICS_SOURCE_ENDPOINT
Default base endpoint for the official IC Dashboard Metrics API.
DEFAULT_IC_DASHBOARD_SOURCE_ENDPOINT
Default base endpoint for the official IC Dashboard API.
DEFAULT_IC_METRIC_STEP_SECS
Default interval between requested Dashboard metric observations.
DEFAULT_IC_METRIC_WINDOW_SECS
Default relative window for one Dashboard metric query.
MAX_IC_BOUNDARY_NODE_DATA_CENTERS
Maximum boundary-node data-center rows accepted from one source response.
MAX_IC_CANISTER_PAGE_LIMIT
Maximum row limit accepted for one official Dashboard canister page.
MAX_IC_DAILY_STATS_ROWS
Maximum daily-statistics rows accepted from one source response.
MAX_IC_DAILY_STATS_WINDOW_SECS
Largest time window accepted by one daily-statistics request.
MAX_IC_METRIC_OBSERVATIONS_PER_SERIES
Maximum requested observations accepted per metric series.
MAX_IC_METRIC_STEP_SECS
Largest step accepted by the official Dashboard Metrics API.
MIN_IC_DAILY_STATS_TIMESTAMP
Earliest timestamp accepted by the official Dashboard daily-statistics API.
MIN_IC_METRIC_TIMESTAMP
Earliest timestamp accepted by the official Dashboard Metrics API.

Functions§

ic_boundary_node_data_centers_report_text
Render one official boundary-node data-center report as human-facing text.
ic_canister_count_report_text
Render one official Dashboard canister-count report as human-facing text.
ic_canister_page_report_text
Render one bounded official Dashboard canister page as human-facing text.
ic_canister_report_text
Render one official Dashboard canister report as human-facing text.
ic_daily_stats_report_text
Render one bounded official Dashboard daily-statistics report as human-facing text.
ic_metric_report_text
Render one bounded official Dashboard metric report as human-facing text.