GUIDES.md

Guides

Additional simplified guides on setting up various things so you don't have to go googling.

Getting telemetry with Grafana

1. Sign up for a free account at grafana.com
2. Once you get to the dashboard, click on "Configure OTLP".
3. Keep track of the endpoint you will use to send OTLP signals.
4. Keep track of the instance ID you will use to send OTLP signals.
5. Create a "Password / API Token", keep track of the token they show you.
6. When you then want to configure telemetry with telemetry.json5, it should look something like this.

{
    otlp: {
        traces: {
            http_endpoint: "https://<domain>/otlp/v1/traces",
            headers: {
                Authorization: "Basic <base64 instanceID:token>"
            }
        },
        metrics: {
            http_endpoint: "https://<domain>/otlp/v1/metrics",
            headers: {
                Authorization: "Basic <base64 instanceID:token>"
            }
        }
    },
}