Orkestia
Blog
Lumen

Plans, usage and API keys in the Cockpit app

This month's Lumen usage, storage against the cap, the Free / Pro / Enterprise comparison, how plan changes are made, and minting or revoking API keys

Account → Usage & API keys in Lumen mode shows what the organization sent this month, what its plan allows, and the keys that send data in. It never takes card details: paid plan changes happen on the web.

This month

Usage here is not the toolbar's time range. It counts the current calendar month in UTC (GET /api/usage from the 1st): billable entries are log entries plus metric points.

TileSource
EntriesTotal for the month, with the split into logs and metric points
Included in planThe plan's included entries per month, and the percentage used; amber past 100%
Monthly capThe organization's entry cap and the percentage of it used; red at or past the cap
Retained storageEstimated retained bytes against the storage cap, or "no cap"; red when over the cap

A meter under the tiles shows entries against the included allowance and storage against its cap (amber past 85%). When retained storage is over the cap the page says new data may be dropped. Below, Entries per day charts the month day by day; hover a bar for logs, metric points and the total.

Plan limits (included, cap) come from the plan row on api-core and need an organization admin; a plain member sees usage but "–" for the limits.

On a very large organization the month's count can take up to 45 seconds and can time out ("Lumen took too long to answer"). The page says so while it counts. Retained storage loads in its own request, so it can arrive, or fail ("unavailable"), independently of the entry count.

Platform administrators also see Usage by organization (last 30 days, logs, metrics and events per organization id).

Plans

The plan card compares the three tiers and marks the current one. The limits are each tier's defaults, as api-lumen defines them:

FreeProEnterprise
Log retention7 days30 days90 days
Entries / month1 million25 million250 million
Metric points / month10 million300 million3 billion
Storage1 GB25 GB250 GB
Ingest rate600 / min20,000 / min120,000 / min

These match Enable → Plans. The plan actually in force comes from the server: if an organization has more entries or storage than the tier default (extra entry packs, storage GB, longer retention), those are added through billing and the usage tiles use the organization's real caps. See Billing and seats.

If the organization is on a plan, the card's header shows Billed $X/month — but only when the billing summary's Lumen plan is the same tier as the plan row. When they disagree, the figure is left out rather than shown beside a different plan.

Changing the plan

You wantWhat the app does
Enable Free on an organization where Lumen is not switched onAsks to confirm, then calls PUT /api/lumen/subscription on api-core with { "plan": "free", "enabled": true, "retention_days": 0 } (0 means the tier default). No checkout. Limits apply within a minute
Pro or Enterprise, an upgrade, or any change to a plan already in place (including a downgrade)Opens app.orkestia.dev → Governance → Observability in your browser. Checkout and changes happen there, as described in Enable

The app does not send paid-tier changes itself. The buttons on the other tiers read Upgrade to Pro, Upgrade to Enterprise or Switch to Free, with an external-link icon, and each opens that page. Pausing Lumen and purging its data are also done there.

Only organization admins and owners can see or change the plan; others see "Only organization admins can see or change the plan." The plan card calls api-core with your session (cookie style), not the Lumen bearer token: how the app authenticates.

API keys

The key list (GET /api/api-keys for your organization) shows name, the key's visible prefix, scope, created, and last used (never, or "3h ago"). A revoked key shows revoked.

ScopePrefixCan do
readlumk_Query only
ingestlumk_Send logs and metrics
productlump_Send Pulse events

Creating a key: type a name, choose the scope (read — query data, ingest — send logs and metrics, product — Pulse analytics) and Create key. The plaintext key appears once, in a bar with Copy and Dismiss; after you dismiss it or leave the page it cannot be shown again. For a browser Pulse key bound to site addresses and a project, use Pulse → Setup instead.

Revoke turns a key off at once. The app asks you to confirm first, naming the key; anything still sending with that key should start failing authentication (401). Mint a new key for a replacement. Never put an ingest key in a browser (Enable).

Only organization admins and owners can list, create or revoke keys; others see "Only organization admins can manage keys." The key list and the new key are scoped to the active organization.