Skip to content

Commit fb1946c

Browse files
committed
create readme for alerts plugin
1 parent 29f79c9 commit fb1946c

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

plugins/alerts/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Alerts plugin
2+
3+
The Alerts plugin is designed to monitor various metrics and events within the Countly analytics platform. It provides a structured way to set up alerts for different types of data, ensuring that users are notified when specific conditions are met. Below is a detailed breakdown of the plugin's file structure and its components:
4+
5+
## File structure
6+
File structure follows usual Countly plugin structure
7+
```
8+
alerts/
9+
├── api/
10+
├── alertModules/
11+
│ ├── cohorts.js # cohort alert checker
12+
│ ├── crashes.js # crash alert checker
13+
│ ├── dataPoints.js # data points alert checker
14+
│ ├── events.js # events alert checker
15+
│ ├── nps.js # NPS alert checker
16+
│ ├── rating.js # rating alert checker
17+
│ ├── revenue.js # revenue alert checker
18+
│ ├── sessions.js # sessions alert checker
19+
│ ├── survey.js # survey alert checker
20+
│ ├── users.js # users alert checker
21+
│ └── views.js # views alert checker
22+
├── jobs/monitor.js # alert monitoring job
23+
├── parts/
24+
│ ├── common-lib.js
25+
│ └── utils.js
26+
└── api.js # alert management API and all API endpoints
27+
├── frontend/
28+
│ ├── public/
29+
│ │ ├── javascripts
30+
│ │ │ ├── countly.models.js # model code. Facilitates requests to backend (CRUD)
31+
│ │ │ └── countly.views.js # views code. Alerts view, Dashboard home widget
32+
│ │ ├── localization # All localization files
33+
│ │ ├── stylesheets
34+
│ │ └── templates
35+
│ │ ├── email.html # template for email
36+
│ │ └── vue-main.html # template for Alerts view (including home and drawer)
37+
│ └── app.js
38+
├── install.js
39+
├── package.json
40+
├── README.md
41+
└── tests.js # plugin tests
42+
```
43+
44+
## Generate alerts job
45+
46+
Job name: alerts:monitor
47+
48+
Job is set to run each hour, each day or each month according to the configuration set in the creation of alerts. It checks all the alert conditions defined by the users periodically and triggers email notifications if any conditions are met.

0 commit comments

Comments
 (0)