Guide template

This page is not listed in meta.json, so it does not appear in the sidebar. It is the reference the Python, Node.js, Go and PHP guides are written against, so a reader who lands on any one of them finds the same shape.

Section order

Every SDK and framework guide has these sections, in this order. A guide may skip a section that genuinely does not apply (a framework with no built-in logging integration, for instance), but does not reorder the rest.

1. Prerequisites. Runtime version, package manager, an ingestion token already created.
2. Install. The OTel SDK and exporter packages for the language, plus any framework instrumentation package.
3. Configure. Exporter setup using the two placeholders below. Nothing else in this section is upzero-specific; it is standard OTel SDK configuration.
4. Logs. Wiring the language's logging integration into the OTel log exporter.
5. Traces. Creating a tracer and, where the framework has one, enabling its automatic instrumentation.
6. Metrics. Creating a meter and recording an instrument.
7. Verify. Running the app and confirming the signal, or pointing the reader at Verify ingestion for the full up0 ingest test / up0 tail walkthrough.
8. Troubleshooting. The failures the guide's author actually hit running it against a real stack, not a speculative list.

Placeholders

Every configure section uses exactly two placeholders, never a real host, port or header value:

• <UPZERO_OTLP_ENDPOINT> (the regional OTLP endpoint).
• <UPZERO_INGEST_TOKEN> (the ingestion token secret).

Both come from one place: the output of up0 tokens create (see Ingestion tokens). A guide states this once, in its Configure section, and does not repeat the explanation elsewhere on the page.

Endpoint policy

No page under instrument/ prints an ingestion endpoint host, port or header contract (PRD FR4, .claude/prds/upzero-docs.md). The token create output is the one place a real endpoint is legitimately shown to the customer, because it is their own org's value, not a shared one.

No configure snippet sets an insecure or insecure_skip_verify exporter option against <UPZERO_OTLP_ENDPOINT> (TELEMETRY_INGESTION_ARCHITECTURE.md §5.4). That flag exists in OTel SDKs for pointing at a local, unencrypted Collector during development. Showing it against a real endpoint would silently disable the one mechanism that lets the calling app verify it is really talking to upzero.