Before you start
You need:- A Nuon BYOC deployment and access to its cloud secret manager.
- An observability backend that accepts logs, metrics, or traces over OTLP/HTTP, with an HTTP(S) endpoint and an
Authorizationheader if authentication is required. - An application configured to emit OpenTelemetry data, or a Collector that gathers it.
1. Add your backend credentials
Update these existing secrets in the cloud account hosting your Nuon BYOC deployment, not in each customer’s install:telemetry_otlp_endpoint: your backend’s HTTP(S) OTLP/HTTP base URL, such ashttps://otel.example.com/otlp. Do not append/v1/logs,/v1/metrics, or/v1/traces.telemetry_otlp_authorization: the completeAuthorizationheader value, including theBasicorBearerprefix. This can be empty if your backend does not require authentication.
- AWS
- GCP
- Open AWS Secrets Manager in the account and region hosting your Nuon BYOC deployment.
- Find the secrets corresponding to
telemetry_otlp_endpointandtelemetry_otlp_authorizationfor your BYOC install. - Update each secret with the value from your backend and save the changes.
If the secrets do not exist, ask Nuon to help update your BYOC stack first. Keep credentials out of app inputs,
component configurations, and source control. You do not need to send Nuon the secret values.
2. Have Nuon enable the relay
Tell Nuon the secrets are ready. Nuon syncs them, checks the configuration, enables the relay, and verifies its deployment and HTTPS endpoint. Wait for confirmation before enabling telemetry on customer installs. Your application will send data to a private endpoint in its own install, not directly to this relay.3. Check the install endpoint
Choose a customer install to start with. Current install stacks provision private telemetry ingress by default; update older stacks or re-enable ingress if the customer previously disabled it.- AWS CloudFormation
- Azure
- GCP Terraform
Use current VPC and runner stack templates with EnableTelemetryIngress set to
true (the default).
The endpoint is private to the install VPC.telemetry_endpoint. You can check with:
4. Connect your application
Set these environment variables for your application’s OpenTelemetry SDK or agent in its component configuration:telemetry_endpoint output instead. If you use your own
Collector, configure its OTLP/HTTP exporter to use that endpoint.
Deploy the updated application configuration. You do not need backend credentials or runner tokens in your
application.
5. Enable telemetry and check your backend
Follow Manage Install Telemetry to enable your first install from the dashboard or its install config. You can also set an org default when you are ready to enable collection more broadly.
Enable telemetry under the install's Settings → Configuration. Here it is enabled through the org default.
nuon.install.id resource
attribute. Check each signal you intend to collect.
If data does not appear, see troubleshooting.