blob: 80e22da37e797368f0a333e502a837560542b133 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
<!--
title: "Send Netdata notifications to Matrix network rooms"
description: "Stay aware of warning or critical anomalies by sending health alarms to Matrix network rooms with Netdata's health monitoring watchdog."
sidebar_label: "Matrix"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md"
learn_status: "Published"
learn_topic_type: "Tasks"
learn_rel_path: "Setup/Notification/Agent"
learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Matrix
Send notifications to [Matrix](https://matrix.org/) network rooms.
The requirements for this notification method are:
1. The url of the homeserver (`https://homeserver:port`).
2. Credentials for connecting to the homeserver, in the form of a valid access token for your account (or for a
dedicated notification account). These tokens usually don't expire.
3. The room ids that you want to sent the notification to.
To obtain the access token, you can use the following `curl` command:
```bash
curl -XPOST -d '{"type":"m.login.password", "user":"example", "password":"wordpass"}' "https://homeserver:8448/_matrix/client/r0/login"
```
The room ids are unique identifiers and can be obtained from the room settings in a Matrix client (e.g. Riot). Their
format is `!uniqueid:homeserver`.
Multiple room ids can be defined by separating with a space character.
Detailed information about the Matrix client API is available at the [official
site](https://matrix.org/docs/guides/client-server.html).
Your `health_alarm_notify.conf` should look like this:
```conf
###############################################################################
# Matrix notifications
#
# enable/disable Matrix notifications
SEND_MATRIX="YES"
# The url of the Matrix homeserver
# e.g https://matrix.org:8448
MATRIX_HOMESERVER="https://matrix.org:8448"
# A access token from a valid Matrix account. Tokens usually don't expire,
# can be controlled from a Matrix client.
# See https://matrix.org/docs/guides/client-server.html
MATRIX_ACCESSTOKEN="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
# Specify the default rooms to receive the notification if no rooms are provided
# in a role's recipients.
# The format is !roomid:homeservername
DEFAULT_RECIPIENT_MATRIX="!XXXXXXXXXXXX:matrix.org"
```
|
