Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Fathom Analytics to Explorer #839

Closed
pmjanus opened this issue Mar 28, 2024 · 0 comments
Closed

Add Fathom Analytics to Explorer #839

pmjanus opened this issue Mar 28, 2024 · 0 comments
Assignees

Comments

@pmjanus
Copy link
Contributor

pmjanus commented Mar 28, 2024

Description:

As our explorer codebase is open-source and can be deployed by different networks, we want to introduce a per-network metrics feature using Fathom Analytics. This will allow deployers to track and analyze usage for their specific network deployment, providing valuable insights and enabling data-driven decision-making.

High-level Requirements:

  • Configurable Fathom Site ID: Provide a way for deployers to set a unique Fathom Analytics site ID for their network deployment.
  • Fathom Analytics Integration: Integrate Fathom Analytics into the explorer's codebase.
  • Dynamic Fathom Site ID: Dynamically set the Fathom site ID based on the deployer's configuration.
  • Easy Configuration: Allow deployers to easily configure and manage their Fathom site ID without modifying the core codebase.

Acceptance Criteria:

  • Deployers can configure a unique Fathom Analytics site ID for their network deployment by modifying a configuration file or setting an environment variable.
  • The Fathom Analytics tracking script is included in the explorer's codebase and is dynamically loaded with the configured site ID.
  • The Fathom site ID is properly set based on the deployer's configuration, ensuring that metrics are tracked separately for each deployment.
  • Deployers can easily set up and manage their Fathom site ID by following the provided documentation and instructions.
  • The documentation is updated to include instructions for deployers on how to set up and utilize the per-network metrics feature with Fathom Analytics.
  • The per-network metrics feature using Fathom Analytics is deployed on the testnet and mainnet Telos Zero explorer versions with the following site IDs:
    • VMVLEWFD for mainnet
    • HKAXCRJB for testnet

The Fathom Analytics tracking script should be included in the explorer's codebase as follows:

<script src="https://cdn.usefathom.com/script.js" data-spa="auto" data-site="SITE_ID" defer></script>

Replace SITE_ID with the appropriate Fathom Analytics site ID based on the network (mainnet or testnet).

Links

https://usefathom.com/docs

pmjanus added a commit that referenced this issue Apr 17, 2024
@pmjanus pmjanus closed this as completed May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants