Chapter 2. 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.
- Always use descriptive avatars.
If no avatar is passed, a tilde(~) symbol will show up.
Instead, use descriptive avatars. Use a robot for server side stuff, normal emojis to convey user actions and emotions, etc.
- Make sure your event names don’t have user properties
This is wrong:
Do this instead:
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.
- 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}
ORuser ${name of event}
- Append server before any server specific event,
server: started
ORserver: startup failed