Deprecating events

Deprecating events help emit warnings when applications track them, allowing developers a grace period to clean them up in a predictable manner.

Challenges#

As product development evolves, so do the events being tracked. Sometimes, we need to deprecate an event because it is no longer needed to be tracked, but we aren't also ready to remove it completely.

At the same time, we also wish to give a grace period to the developers to clean them up.

Deprecate#

In Eventvisor, events can be deprecated by adding deprecated: true to the event definition:

# ...
deprecated: true

Clean up#

Once the grace period is over, and you notice that no deprecation warnings are being emitted in the applications any more, you can archive or delete the event definition safely.