Skip to content

GET /v1/stats and the simlock stats --csv ledger #348

Closed as not planned
Closed as not planned

Description

@V3RON

Part of #329.

Scope

After this PR, GET /v1/stats answers the same figures as simlock stats --json for the same window, and simlock stats --csv writes one row per lease request in the window, a file a spreadsheet opens.

Technical spec

Modules touched

  • src/http/app.ts — GET /v1/stats?since=<duration> or ?from=<ISO>&to=<ISO>, with &ledger=1 to include the ledger; to defaults to now; both forms together, or neither, follow the CLI's rules (neither means the last 24 hours). The handler parses the query with the shared duration parser, dispatches usage.get, and returns its output as JSON. HISTORY_NOT_KEPT takes its status from the contract's error table, as every error does; a bad window is 400.
  • src/contract/operations.ts — usage.get input gains includeLedger: boolean, default false; the output carries requests[] only when it is true, so a console or a plain simlock stats call never receives the ledger.
  • src/core/usage/ — computeUsage output gains requests[] when asked, the ledger: { requestId, requester, label?, platform, model, workerId?, source?, requestedAt, grantedAt?, endedAt?, waitMs?, heldMs?, turnaroundMs?, outcome: "granted" | "rejected" | "open", reason?, endReason? }, one entry per lease.requested in the window.
  • src/cli/index.ts — --csv on simlock stats asks for the ledger and writes it as RFC 4180 CSV to stdout, one header row, a column per ledger field in that order, timestamps as ISO 8601, empty cell for an absent value. --csv with --json is a usage error.
  • docs/HTTP-API.md (route, query, errors, gateway behaviour), docs/CLI.md (--csv), docs/CLIENT.md if the ledger shows in the client type.

Contract and event changes

  • usage.get input gains includeLedger (default false); output gains requests[] when it is set. Additive.
  • New route GET /v1/stats. Operator token; an agent token gets 403 as every operator route does.

Rules in play

  • safety.md rule 10: since, from, to are wire input, parsed and bounded before dispatch.
  • architecture.md rule 10: the window rules are the CLI's and the route's through one shared function, not two copies.

Tests

  • computeUsage lists one ledger entry per request with the timestamps and durations of its grant and end, and open for a request still waiting at the window's end
  • the CSV writer quotes a field containing a comma, a quote or a newline, and writes an empty cell for an absent value
  • simlock stats --csv prints a header row and one row per request, and rejects --csv --json
  • GET /v1/stats?since=1h returns the same body as usage.get for that window, without requests[]; &ledger=1 adds it
  • GET /v1/stats?from=&to= with from later than to returns 400 naming the parameter
  • GET /v1/stats with no window returns the last 24 hours
  • GET /v1/stats with a window that ends before the oldest held event returns HISTORY_NOT_KEPT with the status the error table gives it
  • GET /v1/stats with an agent token returns 403
  • (e2e) after a scripted run, curl GET /v1/stats?since=1h and simlock stats --since 1h --json print equal figures
  • (e2e) simlock stats --csv --since 1h has as many data rows as lease.requested events in the window

Done when

  • After a scripted run against the fake driver, GET /v1/stats?since=1h with an operator token returns the same figures as simlock stats --since 1h --json.
  • simlock stats --csv --since 1h > run.csv writes a file with one header row and one row per lease request, which a spreadsheet opens with the columns separated.
  • An agent token gets 403 on the route; a window older than the kept history gets 422 with the oldest kept time in the body.
  • docs/HTTP-API.md describes the route under Operator routes, and docs/CLI.md describes --csv.

Out of scope

  • The console view (next task).
  • A Prometheus or OpenMetrics endpoint.

Depends on

Approval

  • Approved for delivery

Written by an agent.

Activity

  1. added
    task:draftScope written; technical spec or its spec check missing.
    on Oct 5, 2026
  2. V3RON commented on Oct 10, 2026

    @V3RON
    ContributorAuthor

    Spec updated: Depends on gains #442, the last task of #428 (physical devices), because both edit the same files.

    Written by an agent.

  3. V3RON commented on Oct 12, 2026

    @V3RON
    ContributorAuthor

    Spec updated: Depends on gains #473. Feature #466 (agent-device through simlock) edits the same files or bumps the protocol, and the maintainer chose to deliver it first.

    Written by an agent.

  4. V3RON commented on Oct 16, 2026

    @V3RON
    ContributorAuthor

    Superseded by #623. The figures move to a SQLite history with projections (ADR 0032, PR #626), so this task is replaced by #623's tasks.

    Written by an agent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    task:draftScope written; technical spec or its spec check missing.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions