Versions Compared

Key

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

...

  • applicationId: '<APPLICATION_ID>' - this needs to match the application id defined above under the customer yaml global.rum.applications section

  • clientToken: '<CLIENT_TOKEN>' - use the string dummy as a value (this is update we implement auth ingest for RUM and actually validate)if the kloudfuse installation does not have authenticated ingest enabled. If authenticated ingestion is enabled please follow the additional instructions noted on Step 5: Enable authenticated ingest below.

  • site: '<SITE>' - use empty string

  • proxy: '<KFUSE_RUM_ENDPOINT>' - this needs to be https://<customers-kfuse-hostname>/ddrumproxy e.g. for the playground cluster this value will be https://playground.kloudfuse.io/ddrumproxy

  • service: '<APPLICATION_NAME>' - match the application name (should not contain any white-space e.g. kf-frontend)

  • env: 'production' - whatever the customer wants (e.g. test or production or staging etc)

  • version: '1.0.0' - if the customer has a way to identify the version of their frontend application then that version string should come here. Otherwise just use a default like 1.0.0

  • Code Block
    # recommend small number if site has many users
    sessionSampleRate: 100
    
    # recommend true to get session capture and replay feature
    enableSessionRecording: true,
    
    # recommend true to get frontend logs into their kfuse cluster
    enableLogCollection: true,

Step 5: Enable authenticated ingest (optional)

Additional configuration is necessary when authenticated ingestion is enabled on the kloudfuse platform (i.e. if the following setting is enabled):

Code Block
global:
  authConfig:
    enabled: false

First generate a new auth token as follows:

Code Block
uuidgen | tr -d '-' | tr 'A-Z' 'a-z' | sed 's/^/pub/'

Configure one or more client tokens under the following section:

Code Block
ingester:
  config:
    rum:
      enabled: true
      clientTokens:
        - rumauthkey1: <unique authtoken value generated above>
        - rumauthkey2: <unique authtoken value generated above>

These generated auth tokens need to match the clientToken value used in the frontend RUM SDK configuration:

Code Block
kfuseRumSDK.init({
    config: {
        applicationId: '<application id>',
        clientToken: '<unique authtoken value generated above>',
        ...
    }
})