Miosa.Benchmarks (Miosa v1.0.1)

Copy Markdown View Source

Admin-triggered platform benchmark runs.

Routes live under /api/v1/admin/benchmarks/ and require an admin credential (msk_a_* / msk_p_* or admin JWT). Available run kinds include cold_boot, fleet_routing, concurrent_create, and full_e2e.

Summary

Functions

cancel(client, benchmark_id)

Cancel a running benchmark (POST /admin/benchmarks/:benchmark_id/cancel).

compare(client, left_id, right_id, opts \\ %{})

Compare two benchmark runs (POST /admin/benchmarks/compare).

create(client, attrs)

Start a new benchmark run (POST /admin/benchmarks).

get(client, benchmark_id)

Get a benchmark run by ID (GET /admin/benchmarks/:benchmark_id).

list(client, filters \\ %{})

List all benchmark runs (GET /admin/benchmarks).

samples(client, benchmark_id, filters \\ %{})

Return per-iteration timing samples for a benchmark run (GET /admin/benchmarks/:benchmark_id/samples).

Functions

cancel(client, benchmark_id)

@spec cancel(Miosa.Client.t(), String.t()) :: Miosa.Client.result(map())

Cancel a running benchmark (POST /admin/benchmarks/:benchmark_id/cancel).

compare(client, left_id, right_id, opts \\ %{})

@spec compare(Miosa.Client.t(), String.t(), String.t(), map()) ::
  Miosa.Client.result(map())

Compare two benchmark runs (POST /admin/benchmarks/compare).

create(client, attrs)

@spec create(Miosa.Client.t(), map()) :: Miosa.Client.result(map())

Start a new benchmark run (POST /admin/benchmarks).

Pass kind: and run-specific options. E.g.:

Miosa.Benchmarks.create(client, %{kind: "cold_boot", count: 10})

get(client, benchmark_id)

@spec get(Miosa.Client.t(), String.t()) :: Miosa.Client.result(map())

Get a benchmark run by ID (GET /admin/benchmarks/:benchmark_id).

list(client, filters \\ %{})

@spec list(Miosa.Client.t(), map()) :: Miosa.Client.result(list())

List all benchmark runs (GET /admin/benchmarks).

Accepts optional filter params (e.g. %{kind: "cold_boot"}).

samples(client, benchmark_id, filters \\ %{})

@spec samples(Miosa.Client.t(), String.t(), map()) :: Miosa.Client.result(list())

Return per-iteration timing samples for a benchmark run (GET /admin/benchmarks/:benchmark_id/samples).