docs(observability): fix frontend + apm review findings#880
Merged
Conversation
- frontend: reframe raw Faro as the lower-level path; @nais/apm now wraps
trace propagation (init({ tracing: true })), so drop the stale 'doesn't
wrap tracing' framing and 0.1.0 version markers
- custom-metrics: move context to PushMeasurementOptions (second arg) in the
render-time example so it is no longer silently dropped
- trace-propagation: add required namespace to the Faro init example
- setup-nextjs: standardize the init guard on if (faro.api) return
- apm-client-api: document namespace (team) in InitOptions, the meta-tag
block (nais-team/nais-namespace) and env list (NAIS_TEAM/NAIS_NAMESPACE)
- create-alerts: slo-burn-rate is shipped — add the 5th template row and
drop the false 'burn-rate not shipped' note
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.
Fixes verified review findings in the frontend and APM observability docs. Code claims were grounded against the
@nais/apmSDK source (apm-client/src) and the plugin (pkg/plugin/alerttemplates.go,src/pages/tabs/AlertsTab.tsx).Frontend (
docs/observability/frontend/)@nais/apmviainit({ tracing: true })(lazy@grafana/faro-web-tracing, same-origin +*.nav.nopropagation floor). Raw Faro is now framed only as the lower-level path.0.1.0version markers (docs track0.4.0).contextinside the measurement payload (nocontextfield there → silently dropped). Moved it to the second argument (PushMeasurementOptions), matching the correct earlier example.namespaceto the Faroappinit example.if (faro.api) return;(matchesreference/troubleshooting.md).APM (
docs/observability/apm/)namespace(team), effectively required (without it telemetry resolves tounknown-team): added it to the InitOptions table, the meta-tag block (nais-team/nais-namespace), the env-var list (NAIS_TEAM/NAIS_NAMESPACE), the resolution sentences, and the init example. Left the limitations / version-marker sections untouched to minimize conflict with the unmerged DRY PR docs: Sentry to @nais/apm migration guide #877.slo-burn-rateis a shipped template (fast/slow buttons inAlertsTab.tsx,sloBurnRateDefaultsinalerttemplates.go). Corrected the false "not shipped / only four templates" note and added the 5th row to the templates table.Verification
mise run build nav ssb— green.