docs(frontend): sync auto-configuration + apm client reference to the completed config contract - #891
Draft
Starefossen wants to merge 1 commit into
Draft
docs(frontend): sync auto-configuration + apm client reference to the completed config contract#891Starefossen wants to merge 1 commit into
Starefossen wants to merge 1 commit into
Conversation
… completed config contract auto-configuration.md (blocked on nais/naiserator#687 — the payload described here does not exist until that PR merges and deploys): - schemaVersion + environment fields, versioned-contract note - new 'Generated JSON file' section (nais.json sibling mount, initFromConfigUrl consumption, cache guidance) - NOTE: this page previously documented app.namespace, which the generator did not actually emit until #687 apm-client-api.md (true as of @nais/apm v0.5.0): - corrected the meta-tag claim: rendered by the app's own server (NaisMetaTags helpers), never injected by the platform - resolution chain updated: NAIS_FRONTEND_TELEMETRY_COLLECTOR_URL, tenant fallback (cluster/hostname), dev-mode vs loud-failure split, debug resolution table - new API docs: initFromConfigUrl, fromNaisConfig, NaisMetaTags SSR helpers; init options tenant + debug
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.
The auto-configuration reference changes describe the completed generatedConfig payload (
schemaVersion,app.namespace,environment, thenais.jsonsibling file) — none of which exists in clusters until nais/naiserator#687 merges and deploys per tenant. Merging early would repeat the drift this fixes: the page previously documentedapp.namespace, which naiserator never actually emitted.What's in here
observability/frontend/reference/auto-configuration.md(gated on #687):schemaVersion: 1,environment, versioned-contract notenais.jsonmounted next tomountPath,initFromConfigUrl('/nais.json')consumption, cache-control guidanceobservability/apm/reference/apm-client-api.md(already true as of@nais/apmv0.5.0 — can be split out and merged now if preferred):<NaisMetaTags />/getNaisMetaTags()helpersNAIS_FRONTEND_TELEMETRY_COLLECTOR_URL, tenant fallback (cluster + hostname,tenantoption), local-dev-mode vs loud-failure split,debug: truetableinitFromConfigUrl,fromNaisConfig,NaisMetaTagsSSR helpersContext: ADR-0001 in nais/apm, PRDs nais/grafana-apm-app#133 / #134.