Versions Compared

Version Old Version 9 New Version Current
Changes made by

Sankaranarayanan Viswanathan

Sankaranarayanan Viswanathan

Saved on

Key

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

...

RUM session recordings can be stored recordings in an S3 bucket. Have the customer create an S3 bucket for this purpose and share with you the following:

...

  • Add a global.rum section

  • Code Block
      rum:
    enabled: true
    
    # This is a list of names and UUIDs. The customer can generate any
    # UUID. The same UUID will need to be referenced in the Kfuse frontend SDK
    # initialization call.
    applications:
      - name: kf-frontend
        id: 944f6a58-dbc2-45ad-bf93-def505aaff62
    
    # only if customer uses AWS S3
    sessionReplayStorage:
      type: s3
      useSecret: true
      
      # Below secret name references the secret created earlier
      secretName: "kfuse-rum-s3"
      
      # Below references the bucket name and region that customer has
      # created for session replay storage
      s3:
        region: us-west-2
        bucket: rum-session-replay-playground
        
    # only if customer uses Azure Blob
    sessionReplayStorage:
      type: azure
      useSecret: true
      
      # Below secret name references the secret created earlier
      secretName: "kfuse-rum-azure"
      
      # Below references the container that the customer has
      # created for session replay storage
      azure:
        container: rum-session-replay-playground
        
    # only if customer uses Google GCS
    sessionReplayStorage:
      type: gcs
      useSecret: true
      
      # Below secret name references the secret created earlier
      secretName: kfuse-rum-gcs
      
      # Below references the GCS bucket name that customer has
      # created for session replay storage
      gcs:
        bucket: rum-session-replay-playground

  • To generate a UUID above you can run command line uuidgen | tr 'A-Z' 'a-z'

  • Ensure RUM specific Kafka topics are listed in the customer YAML. You can use the configuration for the events stream as a reference for number of replicas and partitions. We have not done a performance evaluation for RUM so there is no proper guideline at the moment.

...

  • 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>',
        ...
    }
})