Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
npm install --save kf-rum-sdk

Before the SDK The SDK needs to be initialized before it begins gathering frontend telemetry it needs to be initialized. This initialization should occur as early as possible in your application. To initialize the SDK customize applications loading phase. Customize and include the below code snippet:

Code Block
languagejs
import kfuseRumSDK from 'kf-browser-sdk';

kfuseRumSDK.init({
  applicationId: '<APPLICATION_ID>',
  clientToken: '<CLIENT_TOKEN>',
  site: '<DATADOG_SITE>',
  proxy: '<KFUSE_RUM_ENDPOINT>',
  service: '<APPLICATION_NAME>',
  env: 'production',
  version: '1.0.0',
  sessionSampleRate: 100,
  enableSessionRecording: true,
  enableLogCollection: true,
});

...

  • applicationId: a UUID that uniquely identifies a specific frontend application. All RUM telemetry will be associated with it.

  • clientToken: (currently unused) a token that identifies valid producers of RUM telemetry .site: (currently unusedit is currently used so you may supply the value dummy here)

  • proxy: the Kloudfuse ingest endpoint for RUM events. Its value would be https://<kfuse-public-endpoint>/ddrumproxy

  • service: a friendly name unique to the the frontend application being instrumented

  • env: a name identifying a logical source of RUM events (e.g. test environment or production environment)

  • version: a string representing the unique frontend application build (e.g. 1.0.0)

  • sessionSampleRate: what percentage of user session sessions that will generate RUM telemetry (0 to 100)

  • enableSessionRecording: controls whether the users session will be recorded

  • enableLogCollection: controls whether frontend logs will be collected or not

Associating User Information

...