Azure Service Bus telemetry

Test the integration

Send and verify events with Azure Service Bus telemetry

Use Azure Service Bus telemetry where your app knows the final result. Collect only the fields you need, then verify a test event before building charts.

1
Choose the outcome
Service Bus delivery reliability
2
Define the contract
message_id, message_type, entity_name, session_id_category, and release
3
Log the final result
A send acknowledgement and a receive settlement describe different boundaries; record the final business outcome separately when it occurs later.
4
Check the stored event
Exercise a known fixture, then inspect service_bus_message_completed for one correctly typed terminal row.

Before you start

@azure/service-bus and telemetry-sh initialized in a trusted producer or processor
Stable entity, message-type, workflow, and logical outcome definitions
Idempotent processing with explicit complete, abandon, defer, and dead-letter policies

Delivery setup

Install and initialize server-side

Import telemetry-sh in server-only code and initialize it once with process.env.TELEMETRY_API_KEY. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

azure-service-bus-install

npm installation

bash

npm install telemetry-sh

1Create one reusable server-side client. Set its timeout and retry limit.
2Log an event when the operation succeeds, fails, retries, or times out.
3Send test events with known results and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

azure-service-bus

Azure Service Bus telemetry event

javascript

await telemetry.log("service_bus_message_completed", {
  message_id: message.messageId,
  message_type: "customer_import",
  entity_name: "customer-imports",
  status: "success",
  delivery_count: message.deliveryCount,
  wait_ms: Date.now() - message.enqueuedTimeUtc.getTime(),
  duration_ms: Math.round(performance.now() - startedAt),
  lock_lost: false,
  settlement: "completed",
  workflow: "customer_import",
  service: "import-worker",
  release: process.env.APP_RELEASE,
});

Event schema

message_id, message_type, entity_name, session_id_category, and release

status, delivery_count, wait_ms, duration_ms, lock_lost, and error_type

settlement, dead_letter_reason_category, workflow, service, and environment

Check your setup

Checkpoint 1

A send acknowledgement and a receive settlement describe different boundaries; record the final business outcome separately when it occurs later.

Checkpoint 2

Message locks can expire and deliveries can repeat, so keep message_id, delivery_count, lock-lost status, and settlement outcome.

Checkpoint 3

Do not log message bodies, application properties with private values, connection strings, SAS tokens, or unrestricted dead-letter descriptions.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

azure-service-bus-verification

Azure Service Bus telemetry verification query

sql

SELECT *
FROM service_bus_message_completed
ORDER BY timestamp_utc DESC
LIMIT 20;

Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.

Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.

Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.

Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Background job monitoring Dead-letter growth SQL Delivery and idempotency Service Bus message transfers, locks, and settlement Service Bus message loss and duplicate detection

Where to log

Keep the outcome event small and recoverable

This pattern provides

Record the outcome as an event you can query with SQL.
Stable fields for dashboards, alerts, and cross-event correlation.
Test events for checking success, failure, retries, and timeouts.

This pattern does not provide

An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
Exactly-once delivery merely because the payload contains an event ID.
Permission to collect raw provider payloads, user content, credentials, or regulated data.

Delivery and idempotency Batching and shutdown Troubleshoot ingestion

Example event schemas

Check what each event records, when to send it, and which field types it needs. Review the example payload and privacy checklist before using it in production.

Async reliability11 fields