{ "id": "monitoring", "title": "Uptime monitoring and status pages", "summary": "Turn probe results into up, degraded or down, incidents and uptime; drive a public status page; alert on thresholds, anomalies and SLO burn rates.", "synonyms": [ "monitoring", "uptime", "uptime monitor", "status page", "health checks", "alerting", "alerts", "slo", "sla", "error budget", "incidents", "observability", "cron monitoring", "heartbeat", "server monitoring", "site monitoring" ], "apps": [ "uptime monitor", "status page", "server monitoring dashboard", "alerting service", "cron job monitor", "SRE tooling", "website down checker" ], "language": "python", "includes": [ "dashboards", "dates-basics" ], "includedBy": [], "caveats": [], "sections": [ { "key": "checks", "title": "Checks", "purpose": "Classify each probe and combine probes into one status per target.", "from": "monitoring", "members": [ { "id": "monitor.http-check-result", "tier": "core", "why": "Classifies one HTTP probe as up, degraded or down from status, body and latency.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "Classify one HTTP probe as up, degraded or down, with a reason and message, from status, body and latency.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "classifyHttpCheck" ], "signatures": [ "def classify_http_check(probe: HttpProbe, expect: HttpExpectation) -> CheckOutcome" ], "reference": "from fune.monitor.http_check_result import classify_http_check # monitor.http-check-result@^1", "url": "http://www.functionalweave.com/functions/monitor.http-check-result" }, { "id": "monitor.check-status", "tier": "core", "why": "Combines several locations' probes into one status with a quorum.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "Combine the statuses of one target's probes from several locations into one up, degraded or down, with a quorum.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "aggregateStatus" ], "signatures": [ "def aggregate_status(statuses: Sequence[CheckStatus], down_quorum: int) -> CheckStatus" ], "reference": "from fune.monitor.check_status import aggregate_status # monitor.check-status@^1", "url": "http://www.functionalweave.com/functions/monitor.check-status" }, { "id": "monitor.cert-expiry", "tier": "optional", "why": "Days left on a TLS certificate and whether that is ok, warning, critical or expired.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "How long a TLS certificate has left before its notAfter, and whether that is ok, a warning, critical or expired.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "certExpiry" ], "signatures": [ "def cert_expiry(not_after: int, now: int, warn_days: int, critical_days: int) -> CertExpiry" ], "reference": "from fune.monitor.cert_expiry import cert_expiry # monitor.cert-expiry@^1", "url": "http://www.functionalweave.com/functions/monitor.cert-expiry" }, { "id": "monitor.cert-check", "tier": "optional", "why": "A certificate's expiry state as a check status.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "A TLS certificate's expiry state as a check status: ok and warning are up, critical is degraded, expired is down.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "certCheck" ], "signatures": [ "def cert_check(state: CertExpiryState) -> CheckStatus" ], "reference": "from fune.monitor.cert_check import cert_check # monitor.cert-check@^1", "url": "http://www.functionalweave.com/functions/monitor.cert-check" }, { "id": "monitor.heartbeat", "tier": "optional", "why": "Whether a cron job that pings on a schedule is new, up, late or down.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "Whether a cron job that pings on a schedule is new, up, late or down, from its last ping, period and grace time.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "heartbeatStatus" ], "signatures": [ "def heartbeat_status(last_ping_at: Optional[int], now: int, interval_seconds: int, grace_seconds: int) -> HeartbeatStatus" ], "reference": "from fune.monitor.heartbeat import heartbeat_status # monitor.heartbeat@^1", "url": "http://www.functionalweave.com/functions/monitor.heartbeat" }, { "id": "monitor.heartbeat-check", "tier": "optional", "why": "A heartbeat's state as a check status for the status page.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "A heartbeat's state as a check status for a status page: up, late as degraded, down as down, new as nothing yet.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "heartbeatCheck" ], "signatures": [ "def heartbeat_check(state: HeartbeatState) -> Optional[CheckStatus]" ], "reference": "from fune.monitor.heartbeat_check import heartbeat_check # monitor.heartbeat-check@^1", "url": "http://www.functionalweave.com/functions/monitor.heartbeat-check" }, { "id": "net.latency-summary", "tier": "optional", "why": "Loss, min/avg/max, p95 and jitter from ping-style probe results.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "Summarise probe results: sent, received, loss, min/avg/max, p95 and jitter, in whole microseconds.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "summariseLatency" ], "signatures": [ "def summarise_latency(samples_us: Sequence[Optional[int]]) -> LatencySummary" ], "reference": "from fune.net.latency_summary import summarise_latency # net.latency-summary@^1", "url": "http://www.functionalweave.com/functions/net.latency-summary" }, { "id": "net.device-status", "tier": "optional", "why": "Up, degraded or down from a latency summary and thresholds.", "section": "checks", "from": "monitoring", "version": "1.0.0", "summary": "Classify a device as up, degraded or down from its latency summary and loss, p95 and jitter thresholds.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "deviceStatus" ], "signatures": [ "def device_status(summary: LatencySummary, thresholds: StatusThresholds) -> StatusResult" ], "reference": "from fune.net.device_status import device_status # net.device-status@^1", "url": "http://www.functionalweave.com/functions/net.device-status" } ], "gaps": [ { "key": "probes", "text": "Running the probes: HTTP requests, TLS handshakes and pings from several locations on a schedule are network I/O and yours.", "section": "checks", "from": "monitoring" } ] }, { "key": "incidents", "title": "Incidents and uptime", "purpose": "Turn check history into incidents and uptime figures.", "from": "monitoring", "members": [ { "id": "monitor.incidents", "tier": "core", "why": "Turns check series into incidents, ignoring runs too short to confirm.", "section": "incidents", "from": "monitoring", "version": "1.0.0", "summary": "Turn a series of up, degraded and down checks into incidents, ignoring runs too short to confirm.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "findIncidents" ], "signatures": [ "def find_incidents(checks: Sequence[Check], incident_status: CheckStatus, confirm_checks: int, now: int) -> List[Incident]" ], "reference": "from fune.monitor.incidents import find_incidents # monitor.incidents@^1", "url": "http://www.functionalweave.com/functions/monitor.incidents" }, { "id": "monitor.uptime", "tier": "core", "why": "Time-weighted uptime over a window, with long gaps counted as unknown.", "section": "incidents", "from": "monitoring", "version": "1.0.0", "summary": "Time-weighted uptime of a target over a window from its checks, with gaps longer than a limit counted as unknown.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "uptime" ], "signatures": [ "def uptime(checks: Sequence[Check], from_: int, to: int, max_gap_seconds: int) -> UptimeReport" ], "reference": "from fune.monitor.uptime import uptime # monitor.uptime@^1", "url": "http://www.functionalweave.com/functions/monitor.uptime" }, { "id": "monitor.mttr", "tier": "optional", "why": "MTTR, MTBF, downtime and incident counts for a reporting window.", "section": "incidents", "from": "monitoring", "version": "1.0.0", "summary": "MTTR, MTBF, downtime and incident counts for a reporting window, from a list of incidents.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "reliabilityStats" ], "signatures": [ "def reliability_stats(incidents: Sequence[Incident], from_: int, to: int) -> ReliabilityStats" ], "reference": "from fune.monitor.mttr import reliability_stats # monitor.mttr@^1", "url": "http://www.functionalweave.com/functions/monitor.mttr" }, { "id": "monitor.maintenance-window", "tier": "optional", "why": "The maintenance window in force at a moment, to suppress alerts and uptime.", "section": "incidents", "from": "monitoring", "version": "1.0.0", "summary": "The scheduled maintenance window in force at a moment, if any, so alerts and uptime can be suppressed during it.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "activeMaintenance" ], "signatures": [ "def active_maintenance(windows: Sequence[MaintenanceWindow], at: int) -> Optional[MaintenanceWindow]" ], "reference": "from fune.monitor.maintenance_window import active_maintenance # monitor.maintenance-window@^1", "url": "http://www.functionalweave.com/functions/monitor.maintenance-window" } ], "gaps": [] }, { "key": "status-page", "title": "Status page", "purpose": "The public page: overall state, components and history bars.", "from": "monitoring", "members": [ { "id": "monitor.component-state", "tier": "core", "why": "A component's state from its checks: operational, degraded, partial or major outage, maintenance.", "section": "status-page", "from": "monitoring", "version": "1.0.0", "summary": "A status page component's state from its checks: operational, degraded, partial or major outage, or maintenance.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "componentState" ], "signatures": [ "def component_state(statuses: Sequence[CheckStatus], under_maintenance: bool) -> ComponentState" ], "reference": "from fune.monitor.component_state import component_state # monitor.component-state@^1", "url": "http://www.functionalweave.com/functions/monitor.component-state" }, { "id": "monitor.status-page", "tier": "core", "why": "The headline, overall state and affected components at the top of the page.", "section": "status-page", "from": "monitoring", "version": "1.0.0", "summary": "The overall state, headline and affected components at the top of a status page, from each component's state.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "statusPage" ], "signatures": [ "def status_page(components: Sequence[Component]) -> StatusSummary" ], "reference": "from fune.monitor.status_page import status_page # monitor.status-page@^1", "url": "http://www.functionalweave.com/functions/monitor.status-page" }, { "id": "monitor.uptime-bars", "tier": "core", "why": "One bar per UTC day of uptime history, oldest first.", "section": "status-page", "from": "monitoring", "version": "1.0.0", "summary": "One bar per UTC day for a status page's uptime history: seconds in each state, uptime and a colour state, oldest first.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "uptimeBars" ], "signatures": [ "def uptime_bars(checks: Sequence[Check], now: int, days: int, max_gap_seconds: int) -> List[DayBar]" ], "reference": "from fune.monitor.uptime_bars import uptime_bars # monitor.uptime-bars@^1", "url": "http://www.functionalweave.com/functions/monitor.uptime-bars" }, { "id": "monitor.format-duration", "tier": "optional", "why": "Short durations like \"3h 12m\" for incident lengths.", "section": "status-page", "from": "monitoring", "version": "1.0.0", "summary": "A number of seconds as a short human duration for dashboards and alerts: \"3h 12m\", \"2d 4h\", \"45s\".", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "formatDuration" ], "signatures": [ "def format_duration(seconds: int, max_units: int) -> str" ], "reference": "from fune.monitor.format_duration import format_duration # monitor.format-duration@^1", "url": "http://www.functionalweave.com/functions/monitor.format-duration" } ], "gaps": [] }, { "key": "alerting", "title": "Alerting", "purpose": "Decide when to alert and what to send.", "from": "monitoring", "members": [ { "id": "monitor.alert-rule", "tier": "core", "why": "Evaluates a threshold rule over a metric series: inactive, pending, firing or no-data.", "section": "alerting", "from": "monitoring", "version": "1.0.0", "summary": "Evaluate a threshold alert rule over a metric series: inactive, pending, firing or no-data, Prometheus style.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "evaluateAlertRule" ], "signatures": [ "def evaluate_alert_rule(samples: Sequence[MetricSample], rule: ThresholdRule, now: int) -> RuleEvaluation" ], "reference": "from fune.monitor.alert_rule import evaluate_alert_rule # monitor.alert-rule@^1", "url": "http://www.functionalweave.com/functions/monitor.alert-rule" }, { "id": "monitor.alert-state", "tier": "core", "why": "Steps an alert through pending, firing and resolved and says which notification to send.", "section": "alerting", "from": "monitoring", "version": "1.0.0", "summary": "Step an alert through inactive, pending, firing and resolved, and say which notification to send.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "nextAlertState" ], "signatures": [ "def next_alert_state(previous: AlertState, condition: bool, now: int, policy: AlertPolicy) -> AlertTransition" ], "reference": "from fune.monitor.alert_state import next_alert_state # monitor.alert-state@^1", "url": "http://www.functionalweave.com/functions/monitor.alert-state" }, { "id": "monitor.alert-mute", "tier": "optional", "why": "Holds an alert back during maintenance or when a related alert is already firing.", "section": "alerting", "from": "monitoring", "version": "1.0.0", "summary": "Whether to hold an alert back: its component is under maintenance, or a related alert on it is already firing.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "muteAlert" ], "signatures": [ "def mute_alert(kind: str, under_maintenance: bool, firing_kinds: Sequence[str], policy: MutePolicy) -> AlertMute" ], "reference": "from fune.monitor.alert_mute import mute_alert # monitor.alert-mute@^1", "url": "http://www.functionalweave.com/functions/monitor.alert-mute" }, { "id": "monitor.anomaly", "tier": "optional", "why": "Flags an outlier against history by z-score or median/MAD.", "section": "alerting", "from": "monitoring", "version": "1.0.0", "summary": "Is a new metric value an outlier against its history? By z-score or by the robust median/MAD modified z-score.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "detectAnomaly" ], "signatures": [ "def detect_anomaly(history: Sequence[int], value: int, method: AnomalyMethod, threshold_hundredths: int) -> Anomaly" ], "reference": "from fune.monitor.anomaly import detect_anomaly # monitor.anomaly@^1", "url": "http://www.functionalweave.com/functions/monitor.anomaly" } ], "gaps": [ { "key": "notifications", "text": "Delivering alerts by email, SMS, Slack, PagerDuty or webhooks, with retries and on-call schedules.", "section": "alerting", "from": "monitoring" } ] }, { "key": "slo", "title": "SLOs and error budgets", "purpose": "Track service level objectives.", "from": "monitoring", "members": [ { "id": "monitor.error-budget", "tier": "optional", "why": "Error budget allowed, used and left from good and bad events.", "section": "slo", "from": "monitoring", "version": "1.0.0", "summary": "How much of an SLO's error budget is allowed, used and left, from good and bad event counts or seconds.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "errorBudget" ], "signatures": [ "def error_budget(target_basis_points: int, total_events: int, bad_events: int) -> ErrorBudget" ], "reference": "from fune.monitor.error_budget import error_budget # monitor.error-budget@^1", "url": "http://www.functionalweave.com/functions/monitor.error-budget" }, { "id": "monitor.burn-rate", "tier": "optional", "why": "How fast the error budget burns, as a multiple of the allowed rate.", "section": "slo", "from": "monitoring", "version": "1.0.0", "summary": "How fast an SLO's error budget is burning: the error rate as a multiple of the rate the SLO allows, in thousandths.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "burnRate" ], "signatures": [ "def burn_rate(target_basis_points: int, total_events: int, bad_events: int) -> int" ], "reference": "from fune.monitor.burn_rate import burn_rate # monitor.burn-rate@^1", "url": "http://www.functionalweave.com/functions/monitor.burn-rate" }, { "id": "monitor.burn-rate-alert", "tier": "optional", "why": "Multiwindow, multi-burn-rate SLO alerting rules, Google SRE style.", "section": "slo", "from": "monitoring", "version": "2.0.0", "summary": "Multiwindow, multi-burn-rate SLO alerting: which rules fire, from event counts per window (Google SRE workbook).", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "burnRateAlert" ], "signatures": [ "def burn_rate_alert(target_basis_points: int, windows: Sequence[WindowCount], rules: Optional[Sequence[BurnRule]], min_events: Optional[int]) -> BurnAlert" ], "reference": "from fune.monitor.burn_rate_alert import burn_rate_alert # monitor.burn-rate-alert@^2", "url": "http://www.functionalweave.com/functions/monitor.burn-rate-alert" } ], "gaps": [] }, { "key": "metrics", "title": "Metrics and logs", "purpose": "Shape raw metrics and access logs for charts and rules.", "from": "monitoring", "members": [ { "id": "monitor.rollup", "tier": "optional", "why": "Aggregates a series into fixed time buckets: count, min, max, avg, sum, last.", "section": "metrics", "from": "monitoring", "version": "1.0.0", "summary": "Aggregate a metric series into fixed time buckets (count, min, max, avg, sum, last), empty buckets included.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "rollup" ], "signatures": [ "def rollup(samples: Sequence[MetricSample], from_: int, to: int, bucket_seconds: int) -> List[Bucket]" ], "reference": "from fune.monitor.rollup import rollup # monitor.rollup@^1", "url": "http://www.functionalweave.com/functions/monitor.rollup" }, { "id": "monitor.series-window", "tier": "optional", "why": "The samples between two moments, checking time order.", "section": "metrics", "from": "monitoring", "version": "1.0.0", "summary": "The samples of a time series from one moment up to (not including) another, checking they are in time order.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "seriesWindow" ], "signatures": [ "def series_window(samples: Sequence[MetricSample], from_: int, to: int) -> List[MetricSample]" ], "reference": "from fune.monitor.series_window import series_window # monitor.series-window@^1", "url": "http://www.functionalweave.com/functions/monitor.series-window" }, { "id": "monitor.counter-increase", "tier": "optional", "why": "Counter growth and rate per second, counting restarts.", "section": "metrics", "from": "monitoring", "version": "1.0.0", "summary": "How much a monotonic counter grew over a series of samples, counting restarts from zero, and its rate per second.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "counterIncrease" ], "signatures": [ "def counter_increase(samples: Sequence[MetricSample]) -> CounterIncrease" ], "reference": "from fune.monitor.counter_increase import counter_increase # monitor.counter-increase@^1", "url": "http://www.functionalweave.com/functions/monitor.counter-increase" }, { "id": "monitor.parse-access-log", "tier": "optional", "why": "Parses Apache/NCSA Common or Combined log lines.", "section": "metrics", "from": "monitoring", "version": "1.0.0", "summary": "Parse one Apache/NCSA Common or Combined Log Format access log line; null for a line in neither format.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "parseAccessLog" ], "signatures": [ "def parse_access_log(line: str) -> Optional[AccessLogEntry]" ], "reference": "from fune.monitor.parse_access_log import parse_access_log # monitor.parse-access-log@^1", "url": "http://www.functionalweave.com/functions/monitor.parse-access-log" }, { "id": "monitor.status-code-summary", "tier": "optional", "why": "Counts status codes by class and gives server and client error rates.", "section": "metrics", "from": "monitoring", "version": "1.0.0", "summary": "Count HTTP status codes by class (1xx to 5xx) and give the server error and client error rates in basis points.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "summariseStatusCodes" ], "signatures": [ "def summarise_status_codes(statuses: Sequence[int]) -> StatusCodeSummary" ], "reference": "from fune.monitor.status_code_summary import summarise_status_codes # monitor.status-code-summary@^1", "url": "http://www.functionalweave.com/functions/monitor.status-code-summary" } ], "gaps": [ { "key": "metrics-storage", "text": "Storing time series and logs (a TSDB, Prometheus, a database) and querying them.", "section": "metrics", "from": "monitoring" } ] }, { "key": "complete-charts", "title": "Whole charts", "purpose": "Get complete chart geometry in one call, for the common charts.", "from": "dashboards", "members": [ { "id": "charts.line-chart", "tier": "core", "why": "Plot area, number or date axes, gridlines, series paths, colours and legend for a line chart.", "section": "complete-charts", "from": "dashboards", "version": "1.0.0", "summary": "Complete line chart geometry as data: plot area, number or date axes, gridlines, series paths, colours, legend.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "lineChart" ], "signatures": [ "def line_chart(spec: LineChartSpec) -> LineChart" ], "reference": "from fune.charts.line_chart import line_chart # charts.line-chart@^1", "url": "http://www.functionalweave.com/functions/charts.line-chart" }, { "id": "charts.bar-chart", "tier": "core", "why": "Grouped or stacked bar chart geometry: axes, gridlines, bars, colours and legend.", "section": "complete-charts", "from": "dashboards", "version": "1.0.0", "summary": "Complete bar chart geometry as data, grouped or stacked: plot area, axes, gridlines, bar rectangles, colours, legend.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "barChart" ], "signatures": [ "def bar_chart(spec: BarChartSpec) -> BarChart" ], "reference": "from fune.charts.bar_chart import bar_chart # charts.bar-chart@^1", "url": "http://www.functionalweave.com/functions/charts.bar-chart" }, { "id": "charts.sparkline", "tier": "optional", "why": "A sparkline path and end marker for a series in a small box.", "section": "complete-charts", "from": "dashboards", "version": "1.0.0", "summary": "A sparkline's SVG path and end marker from a series, fitted into a box, with gaps left as breaks.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "sparkline" ], "signatures": [ "def sparkline(values: Sequence[Optional[float]], width: float, height: float, padding: float) -> Sparkline" ], "reference": "from fune.charts.sparkline import sparkline # charts.sparkline@^1", "url": "http://www.functionalweave.com/functions/charts.sparkline" } ], "gaps": [] }, { "key": "building-blocks", "title": "Chart building blocks", "purpose": "Compose charts of your own from the same parts.", "from": "dashboards", "members": [ { "id": "charts.scale", "tier": "core", "why": "Maps values to positions and back: linear, log, time, band and point scales, nice domains.", "section": "building-blocks", "from": "dashboards", "version": "1.1.0", "summary": "Map data values onto screen positions and back: linear, log, time, band and point scales, and nice domains.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "linearScale", "invertLinear", "niceDomain", "logScale", "timeScale", "bandScale", "pointScale" ], "signatures": [ "def linear_scale(domain: Sequence[float], range: Sequence[float], value: float, clamp: bool) -> float", "def invert_linear(domain: Sequence[float], range: Sequence[float], value: float) -> float", "def nice_domain(domain: Sequence[float], count: int) -> NiceDomain", "def log_scale(domain: Sequence[float], range: Sequence[float], value: float, clamp: bool) -> float", "def time_scale(domain: Sequence[str], range: Sequence[float], value: str, clamp: bool) -> float", "def band_scale(domain: Sequence[str], range: Sequence[float], value: str, padding_inner: float, padding_outer: float, align: float) -> Band", "def point_scale(domain: Sequence[str], range: Sequence[float], value: str, padding: float, align: float) -> float" ], "reference": "from fune.charts.scale import linear_scale, invert_linear, nice_domain, log_scale, time_scale, band_scale, point_scale # charts.scale@^1", "url": "http://www.functionalweave.com/functions/charts.scale" }, { "id": "charts.ticks", "tier": "core", "why": "Round tick steps and calendar ticks from days to years.", "section": "building-blocks", "from": "dashboards", "version": "1.0.0", "summary": "Axis ticks: a round step (1, 2 or 5 x 10^k), the ticks on it, and calendar ticks from days to years.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "tickStep", "niceTicks", "timeTickInterval", "timeTicks" ], "signatures": [ "def tick_step(start: float, stop: float, count: int) -> float", "def nice_ticks(start: float, stop: float, count: int) -> List[float]", "def time_tick_interval(start: str, stop: str, count: int) -> TimeTickInterval", "def time_ticks(start: str, stop: str, interval: TimeInterval, step: int) -> List[str]" ], "reference": "from fune.charts.ticks import tick_step, nice_ticks, time_tick_interval, time_ticks # charts.ticks@^1", "url": "http://www.functionalweave.com/functions/charts.ticks" }, { "id": "charts.axis", "tier": "core", "why": "Tick positions, labels and gridlines for number, time and category axes.", "section": "building-blocks", "from": "dashboards", "version": "1.0.1", "summary": "Axis geometry as data: tick positions, tick marks, label anchors and gridlines for number, time and category axes.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "axisFromTicks", "numberAxis", "timeAxis", "bandAxis", "gridLines" ], "signatures": [ "def axis_from_ticks(positions: Sequence[float], labels: Sequence[str], range: Sequence[float], orient: AxisOrient, position: float, tick_size: float) -> Axis", "def number_axis(domain: Sequence[float], range: Sequence[float], count: int, orient: AxisOrient, position: float, tick_size: float) -> Axis", "def time_axis(domain: Sequence[str], range: Sequence[float], count: int, orient: AxisOrient, position: float, tick_size: float) -> Axis", "def band_axis(domain: Sequence[str], range: Sequence[float], padding_inner: float, padding_outer: float, orient: AxisOrient, position: float, tick_size: float) -> Axis", "def grid_lines(axis: Axis, length: float) -> List[Line]" ], "reference": "from fune.charts.axis import axis_from_ticks, number_axis, time_axis, band_axis, grid_lines # charts.axis@^1", "url": "http://www.functionalweave.com/functions/charts.axis" }, { "id": "charts.shape", "tier": "optional", "why": "SVG paths for lines, areas, steps, curves, bars, arcs and pie slices.", "section": "building-blocks", "from": "dashboards", "version": "1.0.1", "summary": "SVG path strings for lines, areas, steps, monotone curves, bars, arcs and pie slices, identical in every language.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "linePath", "areaPath", "stepPath", "monotoneCurve", "barRects", "arcPath", "pieAngles" ], "signatures": [ "def line_path(points: Sequence[Point]) -> str", "def area_path(points: Sequence[AreaPoint]) -> str", "def step_path(points: Sequence[Point], position: StepPosition) -> str", "def monotone_curve(points: Sequence[Point]) -> str", "def bar_rects(bars: Sequence[BarSpec], orientation: Orientation) -> List[Rect]", "def arc_path(arc: Arc) -> str", "def pie_angles(values: Sequence[float], start_angle: float, end_angle: float, pad_angle: float) -> List[PieSlice]" ], "reference": "from fune.charts.shape import line_path, area_path, step_path, monotone_curve, bar_rects, arc_path, pie_angles # charts.shape@^1", "url": "http://www.functionalweave.com/functions/charts.shape" }, { "id": "charts.stack", "tier": "optional", "why": "Stacks series on zero, normalised to 100% or diverging.", "section": "building-blocks", "from": "dashboards", "version": "1.0.0", "summary": "Stack several series for stacked bars and areas: on zero, normalised to 100%, or diverging around zero.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "stack" ], "signatures": [ "def stack(series: Sequence[Sequence[float]], offset: StackOffset) -> List[List[StackedValue]]" ], "reference": "from fune.charts.stack import stack # charts.stack@^1", "url": "http://www.functionalweave.com/functions/charts.stack" }, { "id": "charts.layout", "tier": "optional", "why": "Plot area inside margins, legend rows, label collision avoidance.", "section": "building-blocks", "from": "dashboards", "version": "1.0.1", "summary": "Chart layout: the plot area inside margins, legend items wrapped into rows, and greedy label collision avoidance.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "plotArea", "legendRows", "avoidCollisions" ], "signatures": [ "def plot_area(width: float, height: float, margins: Margins) -> PlotArea", "def legend_rows(labels: Sequence[str], max_width: float, char_width: float, swatch_size: float, gap: float, row_height: float) -> List[LegendItem]", "def avoid_collisions(boxes: Sequence[LabelBox], padding: float) -> List[bool]" ], "reference": "from fune.charts.layout import plot_area, legend_rows, avoid_collisions # charts.layout@^1", "url": "http://www.functionalweave.com/functions/charts.layout" }, { "id": "charts.extent", "tier": "optional", "why": "Min and max of a series, skipping gaps.", "section": "building-blocks", "from": "dashboards", "version": "1.0.1", "summary": "The minimum and maximum of a series as [min, max], skipping gaps (null), or null when there is no value.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "extent" ], "signatures": [ "def extent(values: Sequence[Optional[float]]) -> Optional[List[float]]" ], "reference": "from fune.charts.extent import extent # charts.extent@^1", "url": "http://www.functionalweave.com/functions/charts.extent" }, { "id": "charts.histogram-bins", "tier": "optional", "why": "Bins values for a histogram (Sturges, Freedman-Diaconis or fixed width).", "section": "building-blocks", "from": "dashboards", "version": "1.0.0", "summary": "Bin values into histogram bins on round edges, by Sturges' rule, Freedman-Diaconis, or a fixed width.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "histogramBins" ], "signatures": [ "def histogram_bins(values: Sequence[float], method: BinMethod, bin_width: Optional[float]) -> List[Bin]" ], "reference": "from fune.charts.histogram_bins import histogram_bins # charts.histogram-bins@^1", "url": "http://www.functionalweave.com/functions/charts.histogram-bins" }, { "id": "charts.downsample", "tier": "optional", "why": "Thins a long series by LTTB so it draws fast but keeps its shape.", "section": "building-blocks", "from": "dashboards", "version": "1.0.0", "summary": "Reduce a long series to a few points that keep its visual shape, by Largest-Triangle-Three-Buckets (LTTB).", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "downsample" ], "signatures": [ "def downsample(points: Sequence[Sample], threshold: int) -> List[Sample]" ], "reference": "from fune.charts.downsample import downsample # charts.downsample@^1", "url": "http://www.functionalweave.com/functions/charts.downsample" } ], "gaps": [] }, { "key": "colour", "title": "Colour", "purpose": "Readable, colour-blind-safe colours.", "from": "dashboards", "members": [ { "id": "charts.palette", "tier": "core", "why": "n colour-blind-safe series colours (Okabe-Ito or Tol bright).", "section": "colour", "from": "dashboards", "version": "1.0.0", "summary": "A categorical palette of n colour-blind-safe colours for chart series: Okabe-Ito or Paul Tol's bright scheme.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "palette" ], "signatures": [ "def palette(scheme: str, count: int, cycle: bool) -> List[str]" ], "reference": "from fune.charts.palette import palette # charts.palette@^1", "url": "http://www.functionalweave.com/functions/charts.palette" }, { "id": "charts.interpolate-color", "tier": "optional", "why": "Colour along a sequential or diverging ramp, for heatmaps.", "section": "colour", "from": "dashboards", "version": "1.0.0", "summary": "The colour at a point along a sequential or diverging ramp, mixed in OKLab so steps look even; hex in, hex out.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "interpolateColor" ], "signatures": [ "def interpolate_color(ramp: Sequence[str], t: float) -> str" ], "reference": "from fune.charts.interpolate_color import interpolate_color # charts.interpolate-color@^1", "url": "http://www.functionalweave.com/functions/charts.interpolate-color" }, { "id": "charts.contrast", "tier": "optional", "why": "WCAG contrast ratio and the readable text colour on a background.", "section": "colour", "from": "dashboards", "version": "1.0.0", "summary": "WCAG 2.x contrast ratio between two colours, and which text colour reads best on a background.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "contrastRatio", "readableTextColor" ], "signatures": [ "def contrast_ratio(foreground: str, background: str) -> float", "def readable_text_color(background: str, candidates: Sequence[str]) -> str" ], "reference": "from fune.charts.contrast import contrast_ratio, readable_text_color # charts.contrast@^1", "url": "http://www.functionalweave.com/functions/charts.contrast" }, { "id": "charts.color", "tier": "optional", "why": "Hex to RGB and back, and sRGB to linear light.", "section": "colour", "from": "dashboards", "version": "1.0.1", "summary": "Hex colours to RGB and back, and sRGB channels to linear light and back, identically in every language.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "parseHex", "toHex", "srgbToLinear", "linearToSrgb" ], "signatures": [ "def parse_hex(hex: str) -> Rgb", "def to_hex(rgb: Rgb) -> str", "def srgb_to_linear(channel: int) -> float", "def linear_to_srgb(value: float) -> int" ], "reference": "from fune.charts.color import parse_hex, to_hex, srgb_to_linear, linear_to_srgb # charts.color@^1", "url": "http://www.functionalweave.com/functions/charts.color" } ], "gaps": [] }, { "key": "figures", "title": "Figures and statistics", "purpose": "The numbers in the tiles and tooltips.", "from": "dashboards", "members": [ { "id": "charts.format", "tier": "core", "why": "Tick and label text: SI prefixes (1.2k), percentages, dates and money.", "section": "figures", "from": "dashboards", "version": "1.0.0", "summary": "Axis and label text for charts: tick numbers, SI prefixes (1.2k, 3.4M), percentages, dates and money.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "formatTick", "formatSi", "formatPercent", "formatDate", "formatMoneyTick" ], "signatures": [ "def format_tick(value: float, step: float) -> str", "def format_si(value: float, significant: int) -> str", "def format_percent(value: float, decimals: int) -> str", "def format_date(iso: str, label: DateLabel) -> str", "def format_money_tick(minor: float, currency: str) -> str" ], "reference": "from fune.charts.format import format_tick, format_si, format_percent, format_date, format_money_tick # charts.format@^1", "url": "http://www.functionalweave.com/functions/charts.format" }, { "id": "stats.mean-median", "tier": "optional", "why": "Mean, median and mode, exactly.", "section": "figures", "from": "dashboards", "version": "1.0.0", "summary": "Mean, median and mode of a list of integers, with the mean and median as exact fractions.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "meanMedianMode" ], "signatures": [ "def mean_median_mode(values: Sequence[int]) -> CentralTendency" ], "reference": "from fune.stats.mean_median import mean_median_mode # stats.mean-median@^1", "url": "http://www.functionalweave.com/functions/stats.mean-median" }, { "id": "stats.percentile", "tier": "optional", "why": "Percentiles (nearest-rank or linear), for p95 tiles.", "section": "figures", "from": "dashboards", "version": "2.0.0", "summary": "Percentile of a list of numbers by a named method: nearest-rank, or linear interpolation (R-7, Excel PERCENTILE.INC).", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "percentile" ], "signatures": [ "def percentile(values: Sequence[float], p: float, method: PercentileMethod, decimals: int) -> float" ], "reference": "from fune.stats.percentile import percentile # stats.percentile@^2", "url": "http://www.functionalweave.com/functions/stats.percentile" }, { "id": "stats.moving-average", "tier": "optional", "why": "Simple and exponential moving averages for trend lines.", "section": "figures", "from": "dashboards", "version": "2.0.0", "summary": "Simple or exponential moving average over a series, one value per full window, rounded to stated decimals.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "movingAverage" ], "signatures": [ "def moving_average(values: Sequence[float], window: int, kind: MovingAverageKind, decimals: int) -> List[float]" ], "reference": "from fune.stats.moving_average import moving_average # stats.moving-average@^2", "url": "http://www.functionalweave.com/functions/stats.moving-average" }, { "id": "stats.standard-deviation", "tier": "optional", "why": "Standard deviation, for bands and variability.", "section": "figures", "from": "dashboards", "version": "2.0.0", "summary": "Population or sample standard deviation of a list of numbers, two-pass, rounded to stated decimals.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "standardDeviation" ], "signatures": [ "def standard_deviation(values: Sequence[float], kind: DeviationKind, decimals: int) -> float" ], "reference": "from fune.stats.standard_deviation import standard_deviation # stats.standard-deviation@^2", "url": "http://www.functionalweave.com/functions/stats.standard-deviation" }, { "id": "stats.weighted-average", "tier": "optional", "why": "Weighted averages with explicit rounding.", "section": "figures", "from": "dashboards", "version": "1.0.0", "summary": "Weighted average of integers, computed exactly and rounded once to stated decimals with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "weightedAverage" ], "signatures": [ "def weighted_average(values: Sequence[int], weights: Sequence[int], decimals: int, mode: RoundingMode) -> float" ], "reference": "from fune.stats.weighted_average import weighted_average # stats.weighted-average@^1", "url": "http://www.functionalweave.com/functions/stats.weighted-average" }, { "id": "math.percent-change", "tier": "optional", "why": "Change between two values in basis points, for \"up 4.2%\".", "section": "figures", "from": "dashboards", "version": "1.0.0", "summary": "Percentage change from one value to another, in basis points, with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "percentChange" ], "signatures": [ "def percent_change(from_value: int, to_value: int, mode: RoundingMode) -> Optional[int]" ], "reference": "from fune.math.percent_change import percent_change # math.percent-change@^1", "url": "http://www.functionalweave.com/functions/math.percent-change" }, { "id": "text.format-decimal", "tier": "optional", "why": "Plain decimal text with fixed places and grouping.", "section": "figures", "from": "dashboards", "version": "1.0.0", "summary": "Format a float as plain decimal text with fixed or trimmed places and optional grouping, identically in every language.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "formatDecimal" ], "signatures": [ "def format_decimal(value: float, decimals: int, trim_zeros: bool, group_separator: str) -> str" ], "reference": "from fune.text.format_decimal import format_decimal # text.format-decimal@^1", "url": "http://www.functionalweave.com/functions/text.format-decimal" }, { "id": "money.format", "tier": "optional", "why": "Money values in tiles with the currency's real decimals.", "section": "figures", "from": "dashboards", "version": "1.0.0", "summary": "Render a monetary amount as text, using the currency's real minor-unit precision.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "formatMoney" ], "signatures": [ "def format_money(amount: Money) -> str" ], "reference": "from fune.money.format import format_money # money.format@^1", "url": "http://www.functionalweave.com/functions/money.format" }, { "id": "collections.group-by-key", "tier": "optional", "why": "Groups records by a key before charting them.", "section": "figures", "from": "dashboards", "version": "1.0.0", "summary": "Group records by the value at one key, preserving input order inside each group.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "groupByKey" ], "signatures": [ "def group_by_key(records: Sequence[Mapping[str, Any]], key: str) -> Dict[str, List[Mapping[str, Any]]]" ], "reference": "from fune.collections.group_by_key import group_by_key # collections.group-by-key@^1", "url": "http://www.functionalweave.com/functions/collections.group-by-key" } ], "gaps": [] }, { "key": "date-arithmetic", "title": "Calendar arithmetic", "purpose": "Move and measure ISO dates exactly, with no date library and no clock reads.", "from": "dates-basics", "members": [ { "id": "dates.add-days", "tier": "core", "why": "Shifts a date by whole days, for due dates and windows.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Shift an ISO date by a whole number of days, forwards or backwards, with exact calendar arithmetic.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addDays" ], "signatures": [ "def add_days(iso: str, days: int) -> str" ], "reference": "from fune.dates.add_days import add_days # dates.add-days@^1", "url": "http://www.functionalweave.com/functions/dates.add-days" }, { "id": "dates.add-months", "tier": "core", "why": "Adds months clamping to month end, so 31 January plus a month is the end of February.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Add calendar months to an ISO date, clamping to the month end: 31 Jan + 1 month is 28 or 29 Feb.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addMonths" ], "signatures": [ "def add_months(iso: str, months: int) -> str" ], "reference": "from fune.dates.add_months import add_months # dates.add-months@^1", "url": "http://www.functionalweave.com/functions/dates.add-months" }, { "id": "dates.days-between", "tier": "core", "why": "Signed calendar days between two dates, for ages of invoices and stays.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar days from one ISO date to another, signed: negative when the second date is earlier.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "daysBetween" ], "signatures": [ "def days_between(start_iso: str, end_iso: str) -> int" ], "reference": "from fune.dates.days_between import days_between # dates.days-between@^1", "url": "http://www.functionalweave.com/functions/dates.days-between" }, { "id": "dates.month-boundaries", "tier": "core", "why": "First and last day of a date's month, for monthly periods and statements.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The first day, last day and length of the calendar month containing a date.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "monthBoundaries" ], "signatures": [ "def month_boundaries(iso: str) -> MonthBoundaries" ], "reference": "from fune.dates.month_boundaries import month_boundaries # dates.month-boundaries@^1", "url": "http://www.functionalweave.com/functions/dates.month-boundaries" }, { "id": "dates.day-of-week", "tier": "core", "why": "ISO weekday of a date, for weekend rules and opening hours.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The ISO 8601 day of the week for a date: 1 is Monday through 7 is Sunday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayOfWeek" ], "signatures": [ "def day_of_week(iso: str) -> int" ], "reference": "from fune.dates.day_of_week import day_of_week # dates.day-of-week@^1", "url": "http://www.functionalweave.com/functions/dates.day-of-week" }, { "id": "dates.is-leap-year", "tier": "optional", "why": "Whether a year is a leap year, for 365/366-day calculations.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Whether a year is a Gregorian leap year: every 4th, except centuries, except every 400th.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isLeapYear" ], "signatures": [ "def is_leap_year(year: int) -> bool" ], "reference": "from fune.dates.is_leap_year import is_leap_year # dates.is-leap-year@^1", "url": "http://www.functionalweave.com/functions/dates.is-leap-year" }, { "id": "dates.overlap", "tier": "optional", "why": "Days two date ranges share, for prorating and clash checks.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Days two date ranges have in common, with the end of each range stated as inclusive or exclusive.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "overlapDays" ], "signatures": [ "def overlap_days(a_start: str, a_end: str, b_start: str, b_end: str, end_inclusive: bool) -> int" ], "reference": "from fune.dates.overlap import overlap_days # dates.overlap@^1", "url": "http://www.functionalweave.com/functions/dates.overlap" }, { "id": "dates.age", "tier": "optional", "why": "Age in whole years on a date, handling 29 February birthdays.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Age in whole years on a given date, with 29 February birthdays ageing on 1 March in other years.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "age" ], "signatures": [ "def age(birth_date: str, on_date: str) -> int" ], "reference": "from fune.dates.age import age # dates.age@^1", "url": "http://www.functionalweave.com/functions/dates.age" } ], "gaps": [] }, { "key": "reporting-periods", "title": "Periods and reporting dates", "purpose": "Put dates into the periods reports are grouped by.", "from": "dates-basics", "members": [ { "id": "dates.quarter", "tier": "core", "why": "Calendar and fiscal quarter of a date for any year-start month.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar quarter and fiscal quarter of a date, with the fiscal year and quarter date ranges, for any start month.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "quarter" ], "signatures": [ "def quarter(iso: str, fiscal_year_start_month: int) -> Quarter" ], "reference": "from fune.dates.quarter import quarter # dates.quarter@^1", "url": "http://www.functionalweave.com/functions/dates.quarter" }, { "id": "dates.week-number", "tier": "optional", "why": "ISO week number and week-year, for weekly reports.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "ISO 8601 week number and week-numbering year of a date: weeks start Monday, week 1 holds the first Thursday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "weekNumber" ], "signatures": [ "def week_number(iso: str) -> IsoWeek" ], "reference": "from fune.dates.week_number import week_number # dates.week-number@^1", "url": "http://www.functionalweave.com/functions/dates.week-number" }, { "id": "dates.day-count-fraction", "tier": "optional", "why": "Year fraction by ACT/365F, ACT/360, 30/360 or ACT/ACT, for interest periods.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Year fraction between two dates by ACT/365F, ACT/360, 30/360, 30E/360 or ACT/ACT ISDA, as an exact fraction.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayCountFraction" ], "signatures": [ "def day_count_fraction(start_iso: str, end_iso: str, convention: DayCountConvention) -> YearFraction" ], "reference": "from fune.dates.day_count_fraction import day_count_fraction # dates.day-count-fraction@^1", "url": "http://www.functionalweave.com/functions/dates.day-count-fraction" } ], "gaps": [] }, { "key": "working-days", "title": "Working days and holidays", "purpose": "Skip weekends and public holidays when counting or adding days.", "from": "dates-basics", "members": [ { "id": "dates.bank-holidays", "tier": "core", "why": "UK bank holidays for a region and year, as gov.uk publishes them.", "section": "working-days", "from": "dates-basics", "version": "1.0.1", "summary": "UK bank and public holidays for a region and year, as published by gov.uk, including one-off holidays.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "bankHolidays" ], "signatures": [ "def bank_holidays(region: UkRegion, year: int) -> List[BankHoliday]" ], "reference": "from fune.dates.bank_holidays import bank_holidays # dates.bank-holidays@^1", "url": "http://www.functionalweave.com/functions/dates.bank-holidays" }, { "id": "dates.add-business-days", "tier": "core", "why": "Moves a date by working days, skipping weekends and a holiday list.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Move a date forward or back by working days, skipping weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addBusinessDays" ], "signatures": [ "def add_business_days(iso: str, days: int, holidays: Sequence[str]) -> str" ], "reference": "from fune.dates.add_business_days import add_business_days # dates.add-business-days@^1", "url": "http://www.functionalweave.com/functions/dates.add-business-days" }, { "id": "dates.business-days-between", "tier": "core", "why": "Working days between two dates, for SLAs and notice periods.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Working days between two dates, excluding weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "businessDaysBetween" ], "signatures": [ "def business_days_between(start_iso: str, end_iso: str, holidays: Sequence[str]) -> int" ], "reference": "from fune.dates.business_days_between import business_days_between # dates.business-days-between@^1", "url": "http://www.functionalweave.com/functions/dates.business-days-between" } ], "gaps": [] }, { "key": "repeating-dates", "title": "Repeating schedules", "purpose": "Generate the dates of something that repeats.", "from": "dates-basics", "members": [ { "id": "dates.recurrence", "tier": "optional", "why": "The next n dates of a rule: monthly on the 31st, last Friday, every two weeks.", "section": "repeating-dates", "from": "dates-basics", "version": "1.0.0", "summary": "The next n dates of a repeating rule: monthly on a day, last weekday of the month, every k days or weeks, yearly.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "recurrence" ], "signatures": [ "def recurrence(rule: RecurrenceRule, start_iso: str, count: int) -> List[str]" ], "reference": "from fune.dates.recurrence import recurrence # dates.recurrence@^1", "url": "http://www.functionalweave.com/functions/dates.recurrence" } ], "gaps": [] }, { "key": "times", "title": "Times and durations", "purpose": "Work with times of day, durations and timestamps.", "from": "dates-basics", "members": [ { "id": "time.duration", "tier": "optional", "why": "Parses and adds durations like 1h30m in whole minutes, and formats the total.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Parse durations written as 1h30m, 90m or 01:30, add them up in whole minutes, and format the total.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "duration" ], "signatures": [ "def duration(parts: Sequence[str]) -> Duration" ], "reference": "from fune.time.duration import duration # time.duration@^1", "url": "http://www.functionalweave.com/functions/time.duration" }, { "id": "time.minutes-between", "tier": "optional", "why": "Minutes between two local date-times, across midnight.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Minutes from one local date and time to another, correct across midnight; wall-clock time, no time zones.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "minutesBetween" ], "signatures": [ "def minutes_between(start_date: str, start_time: str, end_date: str, end_time: str) -> int" ], "reference": "from fune.time.minutes_between import minutes_between # time.minutes-between@^1", "url": "http://www.functionalweave.com/functions/time.minutes-between" }, { "id": "time.round-to-increment", "tier": "optional", "why": "Rounds minutes to a billing increment such as 6 or 15.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Round a duration in minutes to a billing increment such as 6 or 15 minutes, up, down or to nearest.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundToIncrement" ], "signatures": [ "def round_to_increment(minutes: int, increment: int, mode: RoundingMode) -> int" ], "reference": "from fune.time.round_to_increment import round_to_increment # time.round-to-increment@^1", "url": "http://www.functionalweave.com/functions/time.round-to-increment" }, { "id": "time.iso-to-unix", "tier": "optional", "why": "RFC 3339 timestamps to Unix seconds.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "An RFC 3339 timestamp with a Z or offset, such as 2026-09-26T13:00:00+01:00, to Unix time in whole seconds.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isoToUnix" ], "signatures": [ "def iso_to_unix(timestamp: str) -> int" ], "reference": "from fune.time.iso_to_unix import iso_to_unix # time.iso-to-unix@^1", "url": "http://www.functionalweave.com/functions/time.iso-to-unix" }, { "id": "time.unix-to-iso", "tier": "optional", "why": "Unix seconds to an ISO 8601 UTC timestamp.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Unix time in seconds to an ISO 8601 UTC timestamp such as 2026-09-26T12:00:00Z, for years 0001 to 9999.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "unixToIso" ], "signatures": [ "def unix_to_iso(seconds: int) -> str" ], "reference": "from fune.time.unix_to_iso import unix_to_iso # time.unix-to-iso@^1", "url": "http://www.functionalweave.com/functions/time.unix-to-iso" }, { "id": "time.countdown", "tier": "optional", "why": "Seconds left until a moment and a 4:05 style timer text.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Seconds left until a Unix time, whether it has passed, and a timer text like 4:05, for tokens or retry waits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "countdown" ], "signatures": [ "def countdown(until: int, now: int) -> Countdown" ], "reference": "from fune.time.countdown import countdown # time.countdown@^1", "url": "http://www.functionalweave.com/functions/time.countdown" } ], "gaps": [] } ], "gaps": [ { "key": "probes", "text": "Running the probes: HTTP requests, TLS handshakes and pings from several locations on a schedule are network I/O and yours.", "section": "checks", "from": "monitoring" }, { "key": "notifications", "text": "Delivering alerts by email, SMS, Slack, PagerDuty or webhooks, with retries and on-call schedules.", "section": "alerting", "from": "monitoring" }, { "key": "metrics-storage", "text": "Storing time series and logs (a TSDB, Prometheus, a database) and querying them.", "section": "metrics", "from": "monitoring" }, { "key": "scheduler", "text": "The loop that runs checks every minute and keeps state between runs.", "section": null, "from": "monitoring" }, { "key": "subscriber-updates", "text": "Status page subscriptions and incident updates written by people.", "section": null, "from": "monitoring" }, { "key": "rendering", "text": "Drawing: caps returns numbers and SVG path strings; putting them in SVG, canvas or a chart component is yours.", "section": null, "from": "dashboards" }, { "key": "interactivity", "text": "Tooltips, zoom, pan, brushing and animation.", "section": null, "from": "dashboards" }, { "key": "data-queries", "text": "Querying and aggregating the data at source (SQL, a metrics store); monitor.rollup covers time buckets in memory.", "section": null, "from": "dashboards" }, { "key": "pie-donut-chart", "text": "A complete pie or donut chart: charts.shape gives pieAngles and arcPath, assembling legend and labels is yours.", "section": null, "from": "dashboards" }, { "key": "time-zones", "text": "Time axes in local time zones: charts work in UTC dates and times.", "section": null, "from": "dashboards" }, { "key": "locale-formatting", "text": "Showing dates in a user's language and format (\"3 octobre 2026\"): caps returns ISO dates, not localised text.", "section": null, "from": "dates-basics" }, { "key": "non-uk-holidays", "text": "Public holidays outside the UK: dates.bank-holidays is UK only; pass another country's list to the working-day functions yourself.", "section": null, "from": "dates-basics" } ], "counts": { "members": 75, "core": 25, "optional": 50, "unreviewed": 0, "deprecated": [], "unavailable": [], "missing": [], "gaps": 12 }, "warnings": [], "url": "http://www.functionalweave.com/suites/monitoring", "owner": null }