Skip to content

edgee-cloud/plausible-component

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plausible component for Edgee

Coverage Status GitHub issues Edgee Component Registry

This component enables seamless integration between Edgee and Plausible, allowing you to collect and forward analytics events to your Plausible instance.

Quick Start

  1. Download the latest component version from our releases page
  2. Place the plausible.wasm file in your server (e.g., /var/edgee/components)
  3. Add the following configuration to your edgee.toml:
[[components.data_collection]]
id = "plausible"
file = "/var/edgee/components/plausible.wasm"
# settings.instance_url = "https://plausible.io"
settings.domain = "YOUR_SITE_DOMAIN"

Event Handling

Event Mapping

The component maps Edgee events to plausible Event as follows:

Edgee Event plausible Event Description
Page pageview pageview event with url as property
Track Your event name A event with your custom event name
User user Sets all the data for the user

Configuration Options

Basic Configuration

[[components.data_collection]]
id = "plausible"
file = "/var/edgee/components/plausible.wasm"
# settings.instance_url = "https://plausible.io"
settings.domain = "YOUR_SITE_DOMAIN"

Event Controls

Control which events are forwarded to plausible:

settings.edgee_page_event_enabled = true   # Enable/disable page view tracking
settings.edgee_track_event_enabled = true  # Enable/disable custom event tracking
settings.edgee_user_event_enabled = true   # Enable/disable user identification

Development

Building from Source

Prerequisites:

Build command:

edgee components build

Test commands:

edgee components test
cargo test

Test coverage command:

cargo llvm-cov --all-features

Contributing

Interested in contributing? Read our contribution guidelines

Security

Report security vulnerabilities to security@edgee.cloud

About

Plausible Edgee Component

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages