# Migrate to v7.0

This major version introduces several important changes. registerHoneycombInstrumentation now returns a client instance. The standalone setGlobalSpanAttribute and setGlobalSpanAttributes functions has been moved to the client, telemetry correlation ids are no longer implicitly added to traces, and global variables for third-party integrations have been deprecated. To attach telemetry correlation ids to traces, you must now provide a TelemetryContext instance. Third-party libraries such as Squide and the Platform widgets should also be explicitly provided with the returned client instance to integrate with Workleap's Honeycomb instrumentation.

• Removed the setGlobalSpanAttribute and setGlobalSpanAttributes standalone functions, use the client setGlobalSpanAttribute and setGlobalSpanAttributes methods instead.

• The window.__WLP_HONEYCOMB_INSTRUMENTATION_IS_REGISTERED__ global variable have been deprecated. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_HONEYCOMB_REGISTER_DYNAMIC_FETCH_REQUEST_HOOK__ global variable have been deprecated. Instead, provide a client instance to the third-party libraries.
• The window.__WLP_HONEYCOMB_REGISTER_DYNAMIC_FETCH_REQUEST_HOOK_AT_START__ global variable have been deprecated. Instead, provide a client instance to the third-party libraries.

• The telemetryId and deviceId correlation ids are no longer implicitly attached to Honeycomb traces. To attach these ids, provide a TelemetryContext instance to the registerHoneycombInstrumentation function. You can create a TelemetryContext instance using the createTelemetryContext utility function.
• If your application is a React application, you must now import everything from @workleap/honeycomb/react rather than @workleap/honeycomb.

The registerHoneycombInstrumentation function now returns a client that must be forwarded to the HoneycombInstrumentationProvider. In addition, a TelemetryContext instance must be manually provided to the registration function to ensure correlation ids continue being attached to Honeycomb traces.

Before:

import { registerHoneycombInstrumentation } from "@workleap/honeycomb";
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import { App } from "./App.tsx";

const honeycombInstrumentationClient = registerHoneycombInstrumentation("sample", "my-app", [/.+/g,], {
    proxy: "https://sample-proxy"
});

const root = createRoot(document.getElementById("root")!);

root.render(
    <StrictMode>
        <App />
    </StrictMode>
);

Now:

import { registerHoneycombInstrumentation, HoneycombInstrumentationProvider, createTelemetryContext } from "@workleap/honeycomb/react";
import { registerLogRocketInstrumentation } from "@workleap/logrocket/react";
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import { App } from "./App.tsx";

const logRocketInstrumentationClient = registerLogRocketInstrumentation("app-id");

const honeycombInstrumentationClient = registerHoneycombInstrumentation("sample", "my-app", [/.+/g,], {
    proxy: "https://sample-proxy",
    telemetryContext: createTelemetryContext(),
    logRocketInstrumentationClient
});

const root = createRoot(document.getElementById("root")!);

root.render(
    <StrictMode>
        <HoneycombInstrumentationProvider client={client}>
            <App />
        </HoneycombInstrumentationProvider>
    </StrictMode>
);

The setGlobalSpanAttribute and setGlobalSpanAttributes standalone functions are not exported anymore. Use the client setGlobalSpanAttribute and setGlobalSpanAttributes methods instead.

Before:

import { setGlobalSpanAttributes } from "@workleap/honeycomb";

setGlobalSpanAttribute("app.user_id", "123");

Now:

import { useHoneycombInstrumentationClient } from "@workleap/honeycomb/react";

const client = useHoneycombInstrumentationClient();

client.setGlobalSpanAttribute("app.user_id", "123");

client.setGlobalSpanAttributes({
    "app.user_id": "123"
})

• A new HoneycombInstrumentationProvider React context provider is available to forward a HoneycombInstrumentationClient instance.
• A new useHoneycombInstrumentationClient hook is available to retrieve the provided HoneycombInstrumentatonClient instance.