1
0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00
Files
nttgin-BGPalerter/config.yml.example
2019-11-28 18:09:44 +01:00

161 lines
4.7 KiB
Plaintext

environment: production
connectors:
- file: connectorRIS
name: ris
params:
carefulSubscription: true
url: wss://ris-live.ripe.net/v1/ws/
subscription:
moreSpecific: true
type: UPDATE
host:
socketOptions:
includeRaw: false
monitors:
- file: monitorHijack
channel: hijack
name: basic-hijack-detection
params:
thresholdMinPeers: 2
- file: monitorNewPrefix
channel: newprefix
name: prefix-detection
params:
thresholdMinPeers: 2
- file: monitorPath
channel: path
name: path-matching
params:
thresholdMinPeers: 0
- file: monitorVisibility
channel: visibility
name: withdrawal-detection
params:
thresholdMinPeers: 10
- file: MonitorAS
channel: misconfiguration
name: asn-monitor
params:
thresholdMinPeers: 2
reports:
- file: reportFile
channels:
- hijack
- newprefix
- visibility
- path
- misconfiguration
# - file: reportEmail
# channels:
# - hijack
# - newprefix
# - visibility
# - path
# - misconfiguration
# params:
# showPaths: 5 # Amount of AS_PATHs to report in the alert
# senderEmail: bgpalerter@xxxx
# # BGPalerter uses nodemailer.
# # The smtp section can be configured with all the parameters available at https://nodemailer.com/smtp/
# # the following are just the most useful one
# smtp:
# host: localhost
# port: 25
# secure: false # If true the connection will use TLS when connecting to server. If false it will be still possible doing connection upgrade via STARTTLS
# ignoreTLS: false # If true TLS will be completely disabled, including STARTTLS. Set this to true if you see certificate errors in the logs.
# auth:
# user: username
# pass: password
# type: login
# tls:
# rejectUnauthorized: true # Reject unauthorized certificates
# notifiedEmails:
# default:
# - joe@example.org
# - noc@example.org
# - file: reportSlack
# channels:
# - hijack
# - newprefix
# - visibility
# - path
# - misconfiguration
# params:
# colors:
# hijack: '#d60b1c'
# newprefix: '#fa9548'
# visibility: '#fad648'
# path: '#42cbf5'
# hooks:
# default: _YOUR_SLACK_WEBHOOK_URL_
# - file: reportKafka
# channels:
# - hijack
# - newprefix
# - visibility
# - path
# - misconfiguration
# params:
# host: localhost:9092
# topics:
# default: bgpalerter
############################
# Notification settings:
# - notificationIntervalSeconds
# Defines the amount of seconds after which an alert can be repeated. An alert is repeated only if the event that
# triggered it is not yet solved. Please, don't set this value to Infinity, use instead alertOnlyOnce.
#
# - alertOnlyOnce - A boolean that, if set to true, will prevent repetitions of the same alert even if the event that
# triggered it is not yet solved. In this case notificationIntervalSeconds will be ignored.
# If set to true, the signature of all alerts will be cached in order to recognize if they already happened in
# the past. This may lead to a memory leak if the amount of alerts is considerable.
notificationIntervalSeconds: 7200
alertOnlyOnce: false
############################
# Below the files containing the monitored prefixes. Please see prefixes.yml for an example.
# This is an array (use new lines and dashes!)
monitoredPrefixesFiles:
- prefixes.yml
logging:
directory: logs
logRotatePattern: YYYY-MM-DD # Whenever the pattern changes, a new file is created and the old one rotated
zippedArchive: true
maxSize: 80m
maxFiles: 14d
checkForUpdatesAtBoot: true
############################
# Uptime monitor settings:
# The uptime monitor enables an API (http://localhost:8011/status) which shows the current status of BGPalerter
# If any component reports an invalid state, the "warning" field will be set to true and the HTTP status code will be 500.
#
# - active - A boolean that if set to true enables the monitor. When set to false none of the monitoring components
# and dependencies are loaded (and no port has to be open).
# - useStatusCodes - A boolean that if set to true enables HTTP status codes in the response. Nothing changes in the
# JSON output provided by the API.
# - port - The port on which the API will be reachable.
uptimeMonitor:
active: false
useStatusCodes: true
port: 8011
############################