docs: add runtime telemetry contract#9
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds the versioned
runtime-telemetry/v1.mdcontract for direct HTTP telemetry export fromori-runtimeto the product backend.This documents the phone/lightweight deployment boundary separately from the existing gateway MQTT contract, including authority boundaries, HTTPS transport, HMAC headers, request body shape, retry/backpressure behavior, and the relationship to
gateway-api/v1.md.Why
The Phone Starter path needs a real product-backend ingestion contract for Android/Termux deployments without pretending the LAN gateway is present. Keeping this contract in
ori-specsprevents drift betweenori-runtime,ori-energy apps/api, and futureori-cloudwork.Testing
git diff --checkpassed locally.