Comment on page

Using Dialect Monitor to Detect Events

Option 1: Use Dialect's Open Source Monitoring Tooling

Dialect has sophisticated, open-source tools for detecting events about changes to data (on- or off-chain) and turning those events into notification messages.
The first piece of this tooling is the Monitor library, an open-source Typescript package that makes it easy to extract and transform data streams into targeted, timely smart messages.
The monitor library provides a rich, high-level API for unbounded data-stream processing to analyze extracted on-chain data or data from other off-chain services.
Data-stream processing features include:
  • Windowing: fixed size, fixed time, fixed size sliding
  • Aggregation: average, min, max
  • Thresholding: rising edge, falling edge
  • Rate limiting
The Monitor library is best learned by examples. This section describes how to use Dialect monitor to build monitoring apps by showing you various example apps in the examples/ folder of the repository. Follow along in this section, and refer to the code in those examples.
Dapp developer's integrating Dialect notifications should first familiarize themselves with the Monitor library, and then decide which strategies can be used for your use-cases. Alternatively, it may also be helpful to dive straight into an existing open-source implementation detailed in this section, especially if a use-case similar to yours has already been demonstrated.
Once you have completed these sections and implemented the Monitor for your use-case, don't forget to visit this section to view Dialect's Monitor Service hosting recommendations.
We hope you find these sections useful, and would love your contributions to the Monitor library as you may choose to add custom features for your specific use-cases.