feat: add web tracing to default instruments

[codecapitano]

Why

Work in process

For easy of use include the web-tracing instrumentation in the default instrumentations.

If existing users already use the web-tracing package Faro takes care of removing the default web-tracing package

This how the config changes

new way with web-tracing auto instrumentation if no customization is needed

  const faro = coreInit({
    url: `http://localhost:${env.faro.portAppReceiver}/collect`,
    apiKey: env.faro.apiKey,
    trackWebVitalsAttribution: true,
    app: {
      name: env.client.packageName,
      namespace: env.client.packageNamespace,
      version: env.package.version,
      environment: env.mode.name,
    },
  });

New way, with web-tracing auto instrumentation and additional tracing configuration

initializeFaro({
    url: `http://localhost:${env.faro.portAppReceiver}/collect`,
    apiKey: env.faro.apiKey,
    trackWebVitalsAttribution: true,
    app: {
      name: env.client.packageName,
      namespace: env.client.packageNamespace,
      version: env.package.version,
      environment: env.mode.name,
    },

    webTracingInstrumentation: {
      enabled: true, // default true
      instrumentationOptions: {
        propagateTraceHeaderCorsUrls: ['...'],
        fetchInstrumentationOptions: {
          ignoreNetworkEvents: true,
        },
      },
    },
  });

Current state

initializeFaro({
    url: `http://localhost:${env.faro.portAppReceiver}/collect`,
    apiKey: env.faro.apiKey,
    trackWebVitalsAttribution: true,
    instrumentations: [
      ...getWebInstrumentations({
        captureConsole: true,
      }),

      new TracingInstrumentation({
        instrumentationOptions: {
          propagateTraceHeaderCorsUrls: ['...'],
          fetchInstrumentationOptions: {
            ignoreNetworkEvents: true,
          },
        },
      }),
    ],
    app: {
      name: env.client.packageName,
      namespace: env.client.packageNamespace,
      version: env.package.version,
      environment: env.mode.name,
    },
  });

What

Links

Checklist

• Tests added
• Changelog updated
• Documentation updated

[codecapitano]

Breaking change bc customers who have no tracing today will get it by default.
May bring implications with the browser security as well where remotes will reject requests with unknown headers.

Edit:
The config has an enabled attribute which can default to false.
Bringing it up for discussion.

[eskirk]

just so I understand why do we need to do this in a few places?

[codecapitano]

Yes this came with otel dependendencies

[eskirk]

this just makes sure the old tracing instrumentation is not enabled?

[codecapitano]

This to disable the internal tracing instrumentation if the standalone web-tracing package is already in use.

[eskirk]

this part is in web-sdk - is this a leftover from copy paste?

[codecapitano]

Ned to adjust the text

[eskirk]

looks good just a couple questions for my own understanding