LiveKit ChromeTester

A headless chrome image for simulating LiveKit subscribers.

Deprecation notice

This repo is no longer maintained. We no longer recommend using Chrome testers to simulate traffic to LiveKit.

Usage

It's designed to be used as a Docker image, by passing a few environment variables, ChromeTester will load https://example.livekit.io with parameters that will let it join a room as a subscriber.

The following environment vars are supported:

LIVEKIT_API_KEY: API key that matches server config
LIVEKIT_API_SECRET: API secret that matches server config
LIVEKIT_HOST: hostname of the LiveKit installation (e.g. wss://mylivekithost.com)
LIVEKIT_ROOM: the room to join
DURATION: (optional) amount of time to stay in the room before existing
LIVEKIT_IDENTITY_PREFIX: (optional) custom name prefix for the simulated subscriber
ENABLE_PUBLISH: (optional) enables a simulated publisher with audio and video
TABS: (optional) number of simultanious room connections

Kubernetes Example

To use it on Kubernetes, you'll need a deployment like the following. Note, each instance of the load tester uses approximately 200-500m CPU units and 100MB memory.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: livekit-chrome-tester
  labels:
    app: chrome-tester
spec:
  replicas: 5
  selector:
    matchLabels:
      app: chrome-tester
  template:
    metadata:
      labels:
        app: chrome-tester
    spec:
      containers:
      - name: chrome-tester
        image: livekit/chrometester
        imagePullPolicy: IfNotPresent
        env:
        - name: LIVEKIT_API_KEY
          value: <yourkey>
        - name: LIVEKIT_API_SECRET
          value: <yoursecret>
        - name: LIVEKIT_HOST
          value: <yourhost>
        - name: LIVEKIT_ROOM
          value: <roomname>
        - name: ENABLE_PUBLISH
          value: "true"
        - name: TABS
          value: "1"