Skip to content

Commit

Permalink
add documentation on lark alerter
Browse files Browse the repository at this point in the history
  • Loading branch information
seanyinx committed Oct 7, 2023
1 parent 20caf50 commit 04298fb
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
20 changes: 20 additions & 0 deletions docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2697,6 +2697,26 @@ Example usage::
- My Custom Value 1
- My Custom Value 2

Lark
~~~~~~~~

Lark alerter will send notification to a predefined bot in Lark application. The body of the notification is formatted the same as with other alerters.

Required:

``lark_bot_id``: Lark bot id.

Optional:

``lark_msgtype``: Lark msgtype, currently only ``text`` supported.

Example usage::

alert:
- "lark"
lark_bot_id: "your lark bot id"
lark_msgtype: "text"

Line Notify
~~~~~~~~~~~

Expand Down
3 changes: 2 additions & 1 deletion elastalert/schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,8 @@ properties:
jira_bump_after_inactivity: {type: number}

### Lark
lark_bot_id: {type: string, enum: ['text']}
lark_bot_id: { type: string }
lark_msgtype: { type: string, enum: [ 'text' ] }

### Line Notify
linenotify_access_token: {type: string}
Expand Down

0 comments on commit 04298fb

Please sign in to comment.