Enable RUM on Kloudfuse for AWS S3

Create Session Replay

You can store RUM session recordings in an AWS S3 container. Follow these steps to create an S3 bucket:

1. Follow instructions in AWS documentation on Creating a bucket.

2. Save for following tasks this information:

• S3 accessKey and secretKey; use them to create a secret on the Kloudfuse.
  • S3 bucketName and awsRegion where the bucket exists

Create Secret for Kloudfuse Namespace

Run the following command in the cluster that runs Kloudfuse:

Create a Secret for Kloudfuse Namespace

kubectl create secret generic kfuse-rum-s3 --from-literal=accessKey=<accessKey> --from-literal=secretKey='<secretKey>'

Configure the custom-values.yaml File

1. Generate a UUID by running the following command:

uuidgen | tr 'A-Z' 'a-z'

2. Add a global.rum section to the custom-values.yaml file:

     rum:
       enabled: true
       applications:
      - name: kf-frontend
        id: 944f6a58-dbc2-45ad-bf93-def505aaff62

sessionReplayStorage:
      type: s3
      useSecret: true
      secretName: "kfuse-rum-s3"
      s3:
        region: us-west-2 (2)
        bucket: rum-session-replay-playground (3)

3. List RUM-specific Kafka topics in the custom-values.yaml file.

Use the configuration for the events stream as a reference for the number of replicas and partitions.

    - name: kf_rum_session_replay_topic
      partitions: 3
      replicationFactor: 2
    - name: kf_rum_views_topic
      partitions: 3
      replicationFactor: 2
    - name: kf_rum_actions_topic
      partitions: 3
      replicationFactor: 2
    - name: kf_rum_resources_topic
      partitions: 3
      replicationFactor: 2
    - name: kf_rum_longtasks_topic
      partitions: 3
      replicationFactor: 2
    - name: kf_rum_errors_topic
      partitions: 3
      replicationFactor: 2

4. Specify the TLS configuration in the tls section of the custom-values.yaml file, and ensure you use a public host.

tls:
     enabled: true (1)
     host: playground.kloudfuse.io (2)
     email: admin@kloudfuse.com
     clusterIssuer: playground-letsencrypt-prod

5. Specify the Ingress configuration in the ingress section of the custom-values.yaml file.

RUM must have a public ingest endpoint where the frontend browser posts data.

ingress:
     controller:
       service:
         external:
           enabled: true (1)
         externalTrafficPolicy: Local (2)

6. Enable RUM in the ingester section of the custom-values.yaml file:

ingester:
     config:
       rum:
         enabled: true
         # you can ignore the datadog section below from the PR since
         # this is the default
         datadog:
           proxyToDatadogEnabled: false

7. To ingest frontend logs into Kloudfuse, add parsing rules in the log-parser section of the custom-values.yaml file.

Include these rules verbatim, along with existing rules.

      - remap:
          args:
            kf_additional_tags:
              - "$.origin"
              - "$.application_id"
              - "$.session_id"
              - "$.view.id"
              - "$.view.url"
              - "$.view.referrer"
              - "$.error.handling"
              - "$.error.kind"
              - "$.error.stack"
              - "$.error.message"
              - "$.http.method"
              - "$.http.status_code"
              - "$.http.url"
          conditions:
            - matcher: "__kf_agent"
              value: "datadog"
              op: "=="
      - transform:
          args:
            - action: "replace"
            - sourceLabels: "#ddsource"
            - targetLabel: "source"
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "error.kind"
            - facetName: "error_kind"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "error.stack"
            - facetName: "error_stack"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "error.message"
            - facetName: "error_message"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "http.method"
            - facetName: "@http_method"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "http.status_code"
            - facetName: "http_status_code"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "http.url"
            - facetName: "http_url"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "session_id"
            - facetName: "sessionid"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "application_id"
            - facetName: "applicationid"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "view.url"
            - facetName: "view_url"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "view.referrer"
            - facetName: "view_referrer"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "view.id"
            - facetName: "view_id"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "error.handling"
            - facetName: "@error_handling"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="
      - moveLabelToFacet:
          args:
            - name: "origin"
            - facetName: "event_origin"
            - agentFacet: true
          conditions:
            - matcher: "#__kf_ddrum"
              value: "true"
              op: "=="

8. Enable RUM in the ui section of the custom-values.yaml file:

ui:
     config:
       rum:
         enabled: true

9. Upgrade the cluster using these changes, and ensure that all pods are active.

Instrument the Frontend Application

To set up the Frontend SDK for RUM, see instructions in RUM Setup.

Here is guide to the parameters to configure for SDK initialization:

applicationId

applicationId: '<APPLICATION_ID>'

Must match the application id defined above under the customer yaml global.rum.applications section

clientToken

clientToken: '<CLIENT_TOKEN>'

Use the string dummy as a value 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: '<SITE>'

Use empty string.

proxy

proxy: '<KFUSE_RUM_ENDPOINT>'

Must be of the form https://<customers-kfuse-hostname>/ddrumproxy.

Example: Kloudfuse Playground cluster has the value of https://playground.kloudfuse.io/ddrumproxy.

service

service: '<APPLICATION_NAME>'

Must match the application name, and cannot contain any white space.

Example: kf-frontend

env

env: 'production'

This value depends on the type of deployment: test, production, staging, and so on.

version

version: '1.0.0'

If the frontend application has an identifier, use a string value that represents the version.

Otherwise, use the default value of 1.0.0.

sessionSampleRate

sessionSampleRate: 100

We recommend a small number if the site has many users.

enableSessionRecording

enableSessionRecording: true

We recommend a value of true to use the session capture and replay feature.

enableLogCollection

enableLogCollection: true

We recommend a value of true to get frontend logs into their Kloudfuse cluster.

Enable Authenticated Ingestion

(Optional)

By default, this feature is disabled.

When you enable authenticated ingestion on the Kloudfuse platform, you must enable it globally, and add authentication tokens.

Follow these steps:

1. To enable ingestion authentication, set global authConfig to true in the custom-values.yaml file:

global:
     authConfig:
       enabled: true (1)

2. Generate a new authentication token:

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

3. Configure one or more client tokens in the ingester config rum section of the custom-values.yaml file:

ingester:
     config:
       rum:
         enabled: true (1)
         clientTokens: (2)
        - rumauthkey1: <unique authtoken value>
        - rumauthkey2: <unique authtoken value>

4. Match the generated auth tokens to the clientToken value in the frontend RUM SDK configuration:

kfuseRumSDK.init({
       config: {
           applicationId: '<application id>', (1)
           clientToken: '<unique authtoken value>', (2)
           ...
       }
})