Openpanel-dev / Openpanel-dev/openpanel

feature request: rrweb canvas tracking

Open
#369 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
7k
Forks
481
Avg merge
1d 3h
Merged PRs (30d)
21

Description

Hey,
currently im in a need of tracking interactions with canvas elements which current openpanel rrweb setup does not allow. There are few options according to their docs here https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/canvas.md.

Ideal setup from my point of view would be to allow selfhosting users to set it up in their own way.

More specifically:

  • let users create
    • config-api.js/config-api.ts
    • config-panel.js/config-panel.ts
  • expose config utils to setup the openpanel through javascript/typescript in said config files
  • load said config files upon start of api or the admin panel

This would allow not only custom config for rrweb but also a way to customize more things related to other functionalities. It would definitely be a successor to the numerous of env vars.

WDYT? Im open to create first draft of implementation - either the proposed config or a simple way to enable the canvas recording/replay

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked rrweb canvas recipe and inspect how the API and admin panel currently initialize rrweb and other configuration. Compare the proposed config-api.js/config-api.ts and config-panel.js/config-panel.ts approach with the simpler canvas recording/replay option. Done criteria need to be agreed: the issue does not yet choose an implementation or identify existing files and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
analytics
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.