Operational

DocsGithub Open app

Operational

Github Articles Pitch Usecases Playground API

Contents

Start here
Setup
Get started Send your first event Structured Events Actions Contexts Log limits and errors
Events API
API
Error handling Event parametersPOST Log event Sending actions in events
The Manual
Introduction PWA & push notifications Conventions Setup Manage projects and teammates Categories and search View events in your project Setup PWA on phone Test mode Notifications
Integrations
Nodejs SDK PHP SDK Wordpress plugin
Self hosting
Introduction Install locally Install on VPS Install on Render Install via Docker Install via Docker and Coolify Onboarding Setup .env Setup PWA & push notifications Best practices Durability testing
Other
Vision Roadmap Contributing

Conventions

Ops is all about customization. No two businesses are same, and hence ops comes many options. However, in the beginning, its best to stick to some conventions.

  1. Always use descriptive avatars.

If no avatar is passed, a tilde(~) symbol will show up.

~
12:00 amserver started

Instead, use descriptive avatars. Use a robot for server side stuff, normal emojis to convey user actions and emotions, etc.

🤖
12:00 amserver started
😀
12:00 amUser signed up
🤑
12:00 amuser subscribed
😢
12:00 amuser unsubscribed
  1. Make sure your event names don’t have user properties

This is wrong:

😀
12:00 amShash signed up

Do this instead:

😀
12:00 amuser signed up
Shash

Event names should be specific. If you add a user property or some other dynamic text inside the event name, it will become a lot harder to search for events.

Also we’re developing event aggregrations and not following this pattern means you won’t be able to aggregrate events in the near future, eg: x number of “user signed up” events happened.

  1. Use common conventions for event names

Over time, you’ll have many events. This will affect everything including how quickly you can search through events, understand them and much more.

Keep common conventions for events. Here are a few examples:

  • Denote cron jobs by cron: {name of the cronjob}
  • Append user before any user specific events user: {name of event} OR user ${name of event}
  • Append server before any server specific event, server: started OR server: startup failed
PWA & push notificationsSetup

Operational

PrivacyTerms
About the product
  • Use cases
  • Playground
  • API
  • Pitch
  • Pricing
  • Wordpress plugin
Related to the product
  • Open Source
  • Articles
  • VS Logsnag
Useful articles for your SaaS
  • My experience running a Commercial OSS project
  • Force post: The Payment Hack that lets Merchants charge you without approval
  • 6 Best practices for early stage B2B SaaS customer support
  • Setup event notifications for your SaaS