OpenReplay Administration

CLI

Section titled CLI

The CLI is helpful for managing basic aspects of your OpenReplay instance, things such as restarting or reinstalling a service, accessing a component’s logs or simply checking the status of your backend services.

Run the CLI with the -h option:

openreplay -h

And see the list of all available options:

  ___                   ____            _
 / _ \ _ __   ___ _ __ |  _ \ ___ _ __ | | __ _ _   _
| | | | '_ \ / _ \ '_ \| |_) / _ \ '_ \| |/ _` | | | |
| |_| | |_) |  __/ | | |  _ <  __/ |_) | | (_| | |_| |
 \___/| .__/ \___|_| |_|_| \_\___| .__/|_|\__,_|\__, |
      |_|                        |_|            |___/

[INFO]
  Usage: openreplay [ -h | --help ]
                    [ -s | --status ]
                    [ -i | --install DOMAIN_NAME ]
                    [ -u | --upgrade ]
                    [ -U | --deprecated-upgrade /path/to/old_vars.yaml]
                    [ -r | --restart ]
                    [ -R | --Reload ]
                    [ -c | --cleanup N (in days) ]
                    [ -e | --edit ]
                    [ -p | --install-packages ]
                    [ -l | --logs SERVICE ]
         Services: alerts assets assist chalice
                   db ender frontend heuristics
                   http integrations nginx-controller
                   peers sink sourcemapreader storage

OpenReplay backend relies on the below components/services:

ServiceDescription
httpIngests events and session recordings
sinkReads data from the streaming pipeline (Redis or Kafka for enterprise edition) and inserts into a temp storage (NFS)
storageMoves the temp session recording files to the object storage service
assetsFor caching assets (CSS, fonts and icons) to properly render the recordings
dbReads and writes into various databases (Postgres + ClickHouse for enterprise edition)
enderTerminates user sessions if inactive or disconnected
chaliceAPI for serving the frontend
alertsSends notifications (email, slack, in-app, webhook) when a user set threshold is reached on any of the performance metrics
integrationsPushes and pulls data from the supported third-party APIs (Sentry, Elastic, GitHub, Jira, etc.)

Helpful Commands

Section titled Helpful Commands
  • Check the health status of the OpenReplay
openreplay -s
  • Check logs of services
openreplay -l <service name>

Increase service capacity

Section titled Increase service capacity

It’s possible to increase the capacity of any service by overriding the default cpu/memory allocation values. These latter are determined during the setup process based on your instance capacity and should fit the needs of most installations.

If you have a high volume and a big fat machine, simply run openreplay -e file and override the service’s resources. In the below example, we do it for the http worker. But this can be done for any service (i.e. sink, storage, postgresql, redis, etc.) by uncommenting and updating the below block. If you have to do it for more than one service, then simply copy and rename/update the same block (mind duplications).

http:
  resources:
    limits:
      cpu: 4096m
      memory: 8192Mi
    requests:
      cpu: 1024m
      memory: 2056Mi

Finally, reinstall the service for the new limits to take effect (your data won’t be lost):

openreplay -R

Uninstall OpenReplay

Section titled Uninstall OpenReplay

Run the below commands to uninstall OpenReplay:

sudo k3s-uninstall.sh

All the configuration stored in /var/lib/openreplay/.

sudo rm -rf /var/lib/openreplay/openreplay