alice-analytics 0.2.0

High-performance telemetry & probabilistic statistical estimation — HyperLogLog++, DDSketch, Count-Min Sketch, local differential privacy, streaming anomaly detection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

name: CI

# scripts/preflight.sh runs the same commands with the same arguments locally;
# a step added here is added there in the same commit.

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always

jobs:
  test:
    name: Test (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        # - macos-latest      → aarch64-apple-darwin
        # - ubuntu-24.04-arm  → aarch64-unknown-linux-gnu
        # - ubuntu-latest     → x86_64-unknown-linux-gnu
        # - windows-latest    → x86_64-pc-windows-msvc
        os: [macos-latest, ubuntu-24.04-arm, ubuntu-latest, windows-latest]
    steps:
      - uses: actions/checkout@v5
      # the toolchain itself comes from rust-toolchain.toml
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - name: Test (unit + integration + doc, every feature)
        run: cargo test --all-features

      - name: Test (unit + integration + doc, default features)
        run: cargo test

      # The library is no_std, so its unit tests must also compile and run
      # without the `std` feature: that is the only lane that executes the
      # `libm` rounding path (`sqrt` / `ceil` / `floor` / `round` / `mul_add`)
      # on a host. `--lib` only, so this stays a few seconds per OS.
      - name: Test (lib unit tests, no_std)
        run: cargo test --lib --no-default-features
      - name: Test (lib unit tests, no_std + law)
        run: cargo test --lib --no-default-features --features law

      - name: Example (residual_summary, law feature)
        run: cargo run --example residual_summary --features law

  no-std:
    name: Build (no_std, host + thumbv7em-none-eabihf)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: dtolnay/rust-toolchain@stable
      # installs the target for the toolchain pinned in rust-toolchain.toml
      - name: Add thumbv7em-none-eabihf
        run: rustup target add thumbv7em-none-eabihf
      - uses: Swatinem/rust-cache@v2
      - name: Check (lib, no_std, host)
        run: cargo check --lib --no-default-features
      - name: Check (lib, no_std + law, host)
        run: cargo check --lib --no-default-features --features law
      # a bare-metal target has no std at all, so this is the build that proves
      # the library compiles without it
      - name: Build (lib, no_std, thumbv7em-none-eabihf)
        run: cargo build --lib --no-default-features --target thumbv7em-none-eabihf
      - name: Build (lib, no_std + law, thumbv7em-none-eabihf)
        run: cargo build --lib --no-default-features --features law --target thumbv7em-none-eabihf
      - name: Clippy (lib, no_std + law, thumbv7em-none-eabihf)
        run: cargo clippy --lib --no-default-features --features law --target thumbv7em-none-eabihf -- -W clippy::pedantic -D warnings

  feature-powerset:
    name: Feature powerset (cargo-hack, depth 2)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - name: Install cargo-hack
        uses: taiki-e/install-action@v2
        with:
          tool: cargo-hack
      - name: cargo hack check (lib, feature powerset, depth 2)
        run: cargo hack check --lib --feature-powerset --depth 2

  clippy:
    name: Clippy (pedantic, -D warnings)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - name: Clippy (default features, all targets)
        run: cargo clippy --all-targets -- -W clippy::pedantic -D warnings
      - name: Clippy (all features, all targets)
        run: cargo clippy --all-targets --all-features -- -W clippy::pedantic -D warnings

  # The declared `rust-version` compiled with exactly that toolchain. Bump
  # `rust-version` in Cargo.toml and the version below in the same commit.
  msrv:
    name: MSRV (rust-version = 1.87)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: dtolnay/rust-toolchain@1.87
      - uses: Swatinem/rust-cache@v2
      - name: cargo check on MSRV (lib, default features)
        run: cargo +1.87 check --lib
      - name: cargo check on MSRV (lib, all features)
        run: cargo +1.87 check --lib --all-features

  doc:
    name: Doc (RUSTDOCFLAGS=-Dwarnings)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - name: cargo doc (no-deps, default features)
        run: cargo doc --lib --no-deps
        env:
          RUSTDOCFLAGS: "-Dwarnings"
      - name: cargo doc (no-deps, all features)
        run: cargo doc --lib --no-deps --all-features
        env:
          RUSTDOCFLAGS: "-Dwarnings"

  docs-lint:
    # run on every OS so a locale or path difference in the checker itself
    # shows up here rather than as a silent pass
    name: Docs lint (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-python@v6
        with:
          python-version: '3.11'
      - name: Docs lint (tests)
        run: python scripts/test_docs_lint.py
      - name: Docs lint (public documents, CHANGELOG structure)
        run: python scripts/docs_lint.py --check

  fmt:
    name: Format
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - name: Check formatting
        run: cargo fmt --all -- --check

  actionlint:
    name: actionlint (workflow YAML)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - name: Run actionlint
        uses: reviewdog/action-actionlint@v1
        with:
          fail_level: error
          reporter: github-check