Features
Plans and licensing
SRE Orbit has a free plan with a size limit and paid plans that an offline license key unlocks. Whatever
happens to the license, SRE Orbit keeps collecting and keeps your data. This page covers what each plan
includes, what orbit-api counts, how you get and apply a key, and what happens past a limit.
Plans
| Plan | Covers | Includes | Runs in |
|---|---|---|---|
| Free | up to 250 vCPU across every cluster | metrics, logs, traces, APM, dashboards, alerts, FinOps, Orbit SQL and the SQL editor on your databases, MySQL monitoring (collection, DB load by wait, calls, latency, errors), the S3 archive, SSO and custom roles, unlimited users and clusters | your clusters |
| Enterprise | the vCPU in your key | everything in Free, plus Nocturne AI, the MySQL statement views (each statement's SQL text, live sessions, EXPLAIN plans), archive rehydration and a named engineer | your clusters, air-gapped included |
| Enterprise Cloud | the vCPU in your key | everything in Enterprise, installed, upgraded and backed up by us | our cloud |
Paid plans are priced per vCPU per month, billed yearly. Ask for a quote through the contact form with your company name and vCPU count.
Free has no retention cap: your data stays as long as your storage keeps it.
Database monitoring covers MySQL (performance_schema). PostgreSQL connections work in the SQL editor on
every plan; SRE Orbit does not monitor PostgreSQL. See docs/databases.md.
What is metered
One unit: the vCPU of the nodes SRE Orbit monitors.
- Each node counts its
status.capacity.cpu(itsstatus.allocatable.cpuwhen a node reports no capacity). A node that is NotReady still counts while it exists. orbit-apireads the node caches it already keeps for every cluster it serves, every 5 minutes, starting about 30 seconds after it starts. It skips a cluster whose cache has not filled yet.orbit-apikeeps one document per UTC day in its data directory (usage/<YYYY-MM-DD>.json): per cluster, the number of samples, their sum and maximum, and the node count. It keeps 400 days.- The billable figure is the average of the daily averages over the last 30 days, summed over clusters. Days without a sample do not count. A burst of autoscaled nodes for an afternoon barely moves it.
Count yours before you install:
kubectl get nodes -o jsonpath='{range .items[*]}{.status.capacity.cpu}{"\n"}{end}' \ | awk '{s+=$1} END {print s " vCPU"}'Admin > License shows the same count per cluster, the 30-day average next to the plan's limit and the daily history.
Trial, limits and grace
In every case below, ingest keeps running, your data stays and nobody gets signed out.
| Situation | What happens |
|---|---|
| First 30 days without a key | Enterprise trial with no vCPU cap. It starts the first time orbit-api runs a version with licensing, on a new install and on an upgrade alike. |
| Free, above 250 vCPU | Every Free feature keeps working. Every Deck user sees a notice with the 30-day average until a key goes in or the average drops below 250. |
| Licensed, above the key's vCPU | Nothing changes in the product. Admins see the overage in the Deck, and we settle it at renewal. |
| Key expired | The key's plan keeps running for 30 more days, with a notice to admins. Then the installation runs as Free. |
| Free (trial over, no usable key) | Three things switch off, listed below. Everything else keeps running, database connections, the SQL editor and the MySQL collectors included. |
On Free:
nocturneshowsswitchedOffBy: "plan"inGET /api/v1/features, its routes answer 403plan_required, and its pods park when the chart letsorbit-apipark them.- The MySQL statement views answer 403
plan_required:GET /api/v1/databases/{id}/digests,GET /api/v1/databases/{id}/activity,POST /api/v1/databases/{id}/explainandPOST /api/v1/databases/{id}/reveal. The Deck's database page still shows DB load by wait, calls, latency and errors, and shows a notice where the statements and sessions would be. The collectors keep collecting, so a key opens those views on data you already have. - Starting or restoring an archive rehydration answers 403
plan_required. Data rehydrated earlier stays readable, and archiving continues on every plan.
The moment a valid key goes in, all three come back.
orbit-api keeps the trial's start, the Deck key and the usage history in its data directory. With
components.orbit-api.persistence.enabled=false that directory is an emptyDir, so a new pod starts a new
trial and an empty history. Keep persistence on in production; it also keeps users and the audit trail.
License keys
A key is one line that starts with SO1.: a JSON payload and an Ed25519 signature over it, both
base64url. The payload carries id, customer, plan (enterprise or cloud), vcpu, issuedAt and
expiresAt. orbit-api verifies the signature offline against the public keys compiled into it. It never
calls home.
orbit-api refuses a key when:
- someone changed a character after we signed it, or a key we do not hold signed it;
- the plan is not
enterpriseorcloud, the vCPU is 0, or the payload carries an unknown field; - a date falls outside 2020-01-01 to 2200-01-01, or the key expires before it was issued;
- it is already past
expiresAtwhen an admin applies it.
Get a key
Ask through the contact form with your company name and the vCPU count Admin > License shows. We sign the key offline with a private key that never leaves us and send it back. It carries your company name, plan, vCPU limit and expiry date.
Apply a key in the Deck
Admin > License, paste the key, Apply. It needs settings.manage. A refused key changes nothing and
says why. Remove takes the key out and the installation goes back to the trial or to Free.
Apply a key with Helm
The chart takes the key inline or from a Secret you manage:
license:
key: "" # SO1...., rendered into the <release>-sreorbit-license Secret
existingSecret: "" # or a Secret you manage
secretKey: license-key # the key in that Secretkubectl -n sreorbit create secret generic sreorbit-license --from-literal=license-key='SO1....'helm upgrade sreorbit deploy/helm/sreorbit --reuse-values --set license.existingSecret=sreorbit-licenseorbit-api reads ORBIT_LICENSE_KEY at start. A key in values rolls the pod through its checksum; after
changing an existing Secret, restart orbit-api. A key set by the chart wins over one applied in the
Deck, and the Deck shows it as set by the chart. If orbit-api refuses a chart key, it logs the reason
and ignores the key: the installation keeps running on the trial or on Free.
Audit
Each key applied in the Deck, removed, or refused is one license.apply or license.remove event in the
audit trail, with keyId, plan, vcpu, customer and expiresAt. orbit-api audits a chart key once
per change, at start, with source: "chart". The trail, the logs and the API answers never carry the key
itself.
API
| Route | Permission | What it does |
|---|---|---|
GET /api/v1/license | settings.manage | the plan in force, the key (never the key string), the usage and its history |
PUT /api/v1/license | settings.manage | {"key": "SO1...."}: verifies and applies; 400 license_invalid or license_expired, 409 license_from_chart |
DELETE /api/v1/license | settings.manage | removes the key applied in the Deck |
GET /api/v1/features also carries plan (plan, state, limitVcpu, billableVcpu, over,
locked and the trial, grace and expiry dates), which the Deck uses for its notice. locked lists what
the plan holds off right now: nocturne, dbm and rehydration on Free, nothing otherwise.
Upgrading an existing installation
The first start of a version with licensing begins the 30-day trial, so an installation keeps every feature it uses today for 30 days. Admin > License shows the trial's end date. Apply a key before that date and nothing changes. Without one, Nocturne AI, the MySQL statement views and new rehydrations switch off. Database connections, the SQL editor, the MySQL collectors and everything else keep running.