archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-10 08:07:34 +00:00
Code Issues Projects Releases Wiki Activity

Assorted fixes for integrations templates. ()

Browse source 
* Fix missing endif in template.

* Add h2 to setup template.

* Reduce duplication within the troubleshooting template.

* Add missing troubleshooting section for agent notifications.

* Fix path checking in troubleshooting template.
This commit is contained in:
Austin S. Hemmelgarn 2023-08-02 10:01:04 -04:00 • committed by GitHub
parent 296e608d3f
commit 6bba90a532
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
28 changed files with 88 additions and 49 deletions

3
health/notifications/alerta/metadata.yaml
View file

@ -85,3 +85,6 @@
ALERTA_WEBHOOK_URL="http://yourserver/alerta/api"
ALERTA_API_KEY="INSERT_YOUR_API_KEY_HERE"
DEFAULT_RECIPIENT_ALERTA="Production"
troubleshooting:
problems:
list: []

3
health/notifications/awssns/metadata.yaml
View file

@ -132,3 +132,6 @@
AWSSNS_MESSAGE_FORMAT="${status} on ${host} at ${date}: ${chart} ${value_string}"
DEFAULT_RECIPIENT_AWSSNS="arn:aws:sns:us-east-2:123456789012:MyTopic"
```
troubleshooting:
problems:
list: []

3
health/notifications/custom/metadata.yaml
View file

@ -164,3 +164,6 @@
fi
done
}
troubleshooting:
problems:
list: []

3
health/notifications/discord/metadata.yaml
View file

@ -71,3 +71,6 @@
SEND_DISCORD="YES"
DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/XXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
DEFAULT_RECIPIENT_DISCORD="alerts"
troubleshooting:
problems:
list: []

3
health/notifications/dynatrace/metadata.yaml
View file

@ -87,3 +87,6 @@
DYNATRACE_TAG_VALUE="SERVERTAG"
DYNATRACE_ANNOTATION_TYPE="Netdata Alert"
DYNATRACE_EVENT="AVAILABILITY_EVENT"
troubleshooting:
problems:
list: []

3
health/notifications/email/metadata.yaml
View file

@ -68,3 +68,6 @@
EMAIL_SENDER="example@domain.com"
SEND_EMAIL="YES"
DEFAULT_RECIPIENT_EMAIL="recipient@example.com"
troubleshooting:
problems:
list: []

3
health/notifications/flock/metadata.yaml
View file

@ -67,3 +67,6 @@
SEND_FLOCK="YES"
FLOCK_WEBHOOK_URL="https://api.flock.com/hooks/sendMessage/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
DEFAULT_RECIPIENT_FLOCK="alarms"
troubleshooting:
problems:
list: []

3
health/notifications/gotify/metadata.yaml
View file

@ -55,3 +55,6 @@
SEND_GOTIFY="YES"
GOTIFY_APP_TOKEN="XXXXXXXXXXXXXXX"
GOTIFY_APP_URL="https://push.example.domain/"
troubleshooting:
problems:
list: []

3
health/notifications/irc/metadata.yaml
View file

@ -95,3 +95,6 @@
IRC_NETWORK="irc.freenode.net"
IRC_NICKNAME="netdata-alarm-user"
IRC_REALNAME="netdata-user"
troubleshooting:
problems:
list: []

3
health/notifications/kavenegar/metadata.yaml
View file

@ -77,3 +77,6 @@
KAVENEGAR_API_KEY="XXXXXXXXXXXX"
KAVENEGAR_SENDER="YYYYYYYY"
DEFAULT_RECIPIENT_KAVENEGAR="0912345678"
troubleshooting:
problems:
list: []

3
health/notifications/matrix/metadata.yaml
View file

@ -86,3 +86,6 @@
MATRIX_HOMESERVER="https://matrix.org:8448"
MATRIX_ACCESSTOKEN="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
DEFAULT_RECIPIENT_MATRIX="!XXXXXXXXXXXX:matrix.org"
troubleshooting:
problems:
list: []

3
health/notifications/messagebird/metadata.yaml
View file

@ -74,3 +74,6 @@
MESSAGEBIRD_ACCESS_KEY="XXXXXXXX"
MESSAGEBIRD_NUMBER="XXXXXXX"
DEFAULT_RECIPIENT_MESSAGEBIRD="+15555555555"
troubleshooting:
problems:
list: []

3
health/notifications/msteams/metadata.yaml
View file

@ -74,3 +74,6 @@
SEND_MSTEAMS="YES"
MSTEAMS_WEBHOOK_URL="https://outlook.office.com/webhook/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX@XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/IncomingWebhook/CHANNEL/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
DEFAULT_RECIPIENT_MSTEAMS="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
troubleshooting:
problems:
list: []

3
health/notifications/ntfy/metadata.yaml
View file

@ -65,3 +65,6 @@
config: |
SEND_NTFY="YES"
DEFAULT_RECIPIENT_NTFY="https://ntfy.sh/netdata-X7seHg7d3Tw9zGOk https://ntfy.sh/netdata-oIPm4IK1IlUtlA30"
troubleshooting:
problems:
list: []

3
health/notifications/opsgenie/metadata.yaml
View file

@ -55,3 +55,6 @@
SEND_OPSGENIE="YES"
OPSGENIE_API_KEY="11111111-2222-3333-4444-555555555555"
OPSGENIE_API_URL=""
troubleshooting:
problems:
list: []

3
health/notifications/pagerduty/metadata.yaml
View file

@ -68,3 +68,6 @@
SEND_PD="YES"
DEFAULT_RECIPIENT_PD="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
USE_PD_VERSION="2"
troubleshooting:
problems:
list: []

3
health/notifications/prowl/metadata.yaml
View file

@ -66,3 +66,6 @@
SEND_PROWL="YES"
DEFAULT_RECIPIENT_PROWL="XXXXXXXXXX"
troubleshooting:
problems:
list: []

3
health/notifications/pushbullet/metadata.yaml
View file

@ -71,3 +71,6 @@
SEND_PUSHBULLET="YES"
PUSHBULLET_ACCESS_TOKEN="XXXXXXXXX"
DEFAULT_RECIPIENT_PUSHBULLET="admin1@example.com admin3@somemail.com #examplechanneltag #anotherchanneltag"
troubleshooting:
problems:
list: []

3
health/notifications/pushover/metadata.yaml
View file

@ -73,3 +73,6 @@
SEND_PUSHOVER="YES"
PUSHOVER_APP_TOKEN="XXXXXXXXX"
DEFAULT_RECIPIENT_PUSHOVER="USERTOKEN"
troubleshooting:
problems:
list: []

3
health/notifications/rocketchat/metadata.yaml
View file

@ -70,3 +70,6 @@
SEND_ROCKETCHAT="YES"
ROCKETCHAT_WEBHOOK_URL="<your_incoming_webhook_url>"
DEFAULT_RECIPIENT_ROCKETCHAT="monitoring_alarms"
troubleshooting:
problems:
list: []

3
health/notifications/slack/metadata.yaml
View file

@ -58,3 +58,6 @@
SEND_SLACK="YES"
SLACK_WEBHOOK_URL="https://hooks.slack.com/services/XXXXXXXX/XXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
DEFAULT_RECIPIENT_SLACK="#alarms"
troubleshooting:
problems:
list: []

3
health/notifications/smstools3/metadata.yaml
View file

@ -79,3 +79,6 @@
# SMS Server Tools 3 (smstools3) global notification options
SEND_SMS="YES"
DEFAULT_RECIPIENT_SMS="1234567890"
troubleshooting:
problems:
list: []

3
health/notifications/syslog/metadata.yaml
View file

@ -83,3 +83,6 @@
SEND_SYSLOG="YES"
SYSLOG_FACILITY='local6'
DEFAULT_RECIPIENT_SYSLOG="daemon.notice@loghost6:514/netdata"
troubleshooting:
problems:
list: []

3
health/notifications/telegram/metadata.yaml
View file

@ -72,3 +72,6 @@
SEND_TELEGRAM="YES"
TELEGRAM_BOT_TOKEN="111122223:7OpFlFFRzRBbrUUmIjj5HF9Ox2pYJZy5"
DEFAULT_RECIPIENT_TELEGRAM="-100233335555"
troubleshooting:
problems:
list: []

3
health/notifications/twilio/metadata.yaml
View file

@ -78,3 +78,6 @@
TWILIO_ACCOUNT_TOKEN="xxxxxxxxxx"
TWILIO_NUMBER="xxxxxxxxxxx"
DEFAULT_RECIPIENT_TWILIO="+15555555555"
troubleshooting:
problems:
list: []

4
integrations/integrations.js
View file

File diff suppressed because one or more lines are too long

2
integrations/templates/setup.md
View file

@ -1,3 +1,5 @@
## Setup
[% if entry.setup.description %]
[[ entry.setup.description ]]
[% else %]

56
integrations/templates/troubleshooting.md
View file

@ -1,10 +1,10 @@
[% if entry.integration_type == 'collector' %]
[% if entry.meta.plugin_name == 'go.d.plugin' %]
[% if entry.meta.plugin_name is in(['go.d.plugin', 'python.d.plugin', 'charts.d.plugin']) %]
## Troubleshooting
### Debug Mode
To troubleshoot issues with the `[[ entry.module_name ]]` collector, run the `go.d.plugin` with the debug option enabled. The output
To troubleshoot issues with the `[[ entry.meta.module_name ]]` collector, run the `[[ entry.meta.plugin_name ]]` with the debug option enabled. The output
should give you clues as to why the collector isn't working.
- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
@ -20,66 +20,28 @@ should give you clues as to why the collector isn't working.
sudo -u netdata -s
```
[% if entry.meta.plugin_name == 'go.d.plugin' %]
- Run the `go.d.plugin` to debug the collector:
```bash
./go.d.plugin -d -m [[ entry.module_name ]]
./go.d.plugin -d -m [[ entry.meta.module_name ]]
```
[% elif entry.meta.plugin_name == 'python.d.plugin' %]
## Troubleshooting
### Debug Mode
To troubleshoot issues with the `[[ entry.module_name ]]` collector, run the `python.d.plugin` with the debug option enabled. The output
should give you clues as to why the collector isn't working.
- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
```bash
cd /usr/libexec/netdata/plugins.d/
```
- Switch to the `netdata` user.
```bash
sudo -u netdata -s
```
- Run the `python.d.plugin` to debug the collector:
```bash
./python.d.plugin [[ entry.module_name ]] debug trace
./python.d.plugin [[ entry.meta.module_name ]] debug trace
```
[% elif entry.meta.plugin_name == 'charts.d.plugin' %]
## Troubleshooting
### Debug Mode
To troubleshoot issues with the `[[ entry.module_name ]]` collector, run the `charts.d.plugin` with the debug option enabled. The output
should give you clues as to why the collector isn't working.
- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
```bash
cd /usr/libexec/netdata/plugins.d/
```
- Switch to the `netdata` user.
```bash
sudo -u netdata -s
```
- Run the `charts.d.plugin` to debug the collector:
```bash
./charts.d.plugin debug 1 [[ entry.module_name ]]
./charts.d.plugin debug 1 [[ entry.meta.module_name ]]
```
[% endif %]
[% else %]
[% if entry.troubleshooting.problems.list %]
## Troubleshooting
@ -87,7 +49,7 @@ should give you clues as to why the collector isn't working.
[% endif %]
[% endif %]
[% elif entry.integration_type == 'notification' %]
[% if 'cloud-notifications' in entry._src_path %]
[% if 'cloud-notifications' in entry._src_path|string %]
[% if entry.troubleshooting.problems.list %]
## Troubleshooting
@ -115,6 +77,7 @@ export NETDATA_ALARM_NOTIFY_DEBUG=1
Note that this will test _all_ alert mechanisms for the selected role.
[% endif %]
[% elif entry.integration_type == 'exporter' %]
[% if entry.troubleshooting.problems.list %]
## Troubleshooting
@ -127,4 +90,3 @@ Note that this will test _all_ alert mechanisms for the selected role.
[[ description ]]
[% endfor %]
[% endif %]