Workleap Telemetry (wl-telemetry)

@workleap/telemetry is an umbrella package that integrates Honeycomb, LogRocket, and Mixpanel with consistent correlation IDs for unified debugging and analysis.

Core Concepts

Correlation Values

Two automatic correlation IDs unify all telemetry platforms:

If LogRocket is enabled, Honeycomb and Mixpanel automatically receive app.logrocket_session_url / LogRocket Session URL.

Platform Roles

• Honeycomb: Distributed traces, performance monitoring, RUM metrics (LCP, CLS, INP)
• LogRocket: Session replay, frontend debugging, user experience investigation
• Mixpanel: Product analytics, event tracking, user behavior insights

Quick Start

import { initializeTelemetry, TelemetryProvider } from "@workleap/telemetry/react";

const telemetryClient = initializeTelemetry("wlp", {
  logRocket: { appId: "your-app-id" },
  honeycomb: {
    namespace: "your-namespace",
    serviceName: "your-service",
    apiServiceUrls: [/.+/g],
    options: { proxy: "https://your-otel-proxy" }
  },
  mixpanel: {
    envOrTrackingApiBaseUrl: "production"
  }
});

// Wrap application
<TelemetryProvider client={telemetryClient}>
  <App />
</TelemetryProvider>

Using Platform Clients

// Access via hooks
const telemetryClient = useTelemetryClient();
const honeycombClient = useHoneycombInstrumentationClient();
const logRocketClient = useLogRocketInstrumentationClient();
const mixpanelClient = useMixpanelClient();
const track = useMixpanelTrackingFunction();

Storybook/Testing (Noop Clients)

import { NoopTelemetryClient, TelemetryProvider } from "@workleap/telemetry/react";

const telemetryClient = new NoopTelemetryClient();

<TelemetryProvider client={telemetryClient}>
  <Story />
</TelemetryProvider>

Detailed References

• Full API Reference: See references/api.md for complete APIs
• Integration Patterns: See references/integrations.md for platform-specific patterns
• Usage Examples: See references/examples.md for common patterns

Critical Rules

1. Use umbrella package – Always use @workleap/telemetry, not standalone packages
2. Do not invent APIs – Only use documented APIs from references
3. Correlation is automatic – Never manually set Telemetry Id or Device Id
4. Noop for non-production – Use NoopTelemetryClient in Storybook/tests
5. Privacy matters – Never log PII to LogRocket; use data-public/data-private attributes
6. productFamily is required – initializeTelemetry requires "wlp" or "sg" as the first argument