xref: /freebsd/sys/contrib/openzfs/cmd/zed/zed.d/zed.rc (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1##
2# zed.rc – ZEDLET configuration.
3##
4# shellcheck disable=SC2034
5
6##
7# Absolute path to the debug output file.
8#
9#ZED_DEBUG_LOG="/tmp/zed.debug.log"
10
11##
12# Email address of the zpool administrator for receipt of notifications;
13#   multiple addresses can be specified if they are delimited by whitespace.
14# Email will only be sent if ZED_EMAIL_ADDR is defined.
15# Enabled by default; comment to disable.
16#
17ZED_EMAIL_ADDR="root"
18
19##
20# Name or path of executable responsible for sending notifications via email;
21#   the mail program must be capable of reading a message body from stdin.
22# Email will only be sent if ZED_EMAIL_ADDR is defined.
23#
24#ZED_EMAIL_PROG="mail"
25
26##
27# Command-line options for ZED_EMAIL_PROG.
28# The string @ADDRESS@ will be replaced with the recipient email address(es).
29# The string @SUBJECT@ will be replaced with the notification subject;
30#   this should be protected with quotes to prevent word-splitting.
31# Email will only be sent if ZED_EMAIL_ADDR is defined.
32# If @SUBJECT@ was omited here, a "Subject: ..." header will be added to notification
33#
34#ZED_EMAIL_OPTS="-s '@SUBJECT@' @ADDRESS@"
35
36##
37# Default directory for zed lock files.
38#
39#ZED_LOCKDIR="/var/lock"
40
41##
42# Minimum number of seconds between notifications for a similar event.
43#
44#ZED_NOTIFY_INTERVAL_SECS=3600
45
46##
47# Notification verbosity.
48#   If set to 0, suppress notification if the pool is healthy.
49#   If set to 1, send notification regardless of pool health.
50#
51#ZED_NOTIFY_VERBOSE=0
52
53##
54# Send notifications for 'ereport.fs.zfs.data' events.
55# Disabled by default, any non-empty value will enable the feature.
56#
57#ZED_NOTIFY_DATA=
58
59##
60# Pushbullet access token.
61# This grants full access to your account -- protect it accordingly!
62#   <https://www.pushbullet.com/get-started>
63#   <https://www.pushbullet.com/account>
64# Disabled by default; uncomment to enable.
65#
66#ZED_PUSHBULLET_ACCESS_TOKEN=""
67
68##
69# Pushbullet channel tag for push notification feeds that can be subscribed to.
70#   <https://www.pushbullet.com/my-channel>
71# If not defined, push notifications will instead be sent to all devices
72#   associated with the account specified by the access token.
73# Disabled by default; uncomment to enable.
74#
75#ZED_PUSHBULLET_CHANNEL_TAG=""
76
77##
78# Slack Webhook URL.
79# This allows posting to the given channel and includes an access token.
80#   <https://api.slack.com/incoming-webhooks>
81# Disabled by default; uncomment to enable.
82#
83#ZED_SLACK_WEBHOOK_URL=""
84
85##
86# Pushover token.
87# This defines the application from which the notification will be sent.
88#   <https://pushover.net/api#registration>
89# Disabled by default; uncomment to enable.
90# ZED_PUSHOVER_USER, below, must also be configured.
91#
92#ZED_PUSHOVER_TOKEN=""
93
94##
95# Pushover user key.
96# This defines which user or group will receive Pushover notifications.
97#  <https://pushover.net/api#identifiers>
98# Disabled by default; uncomment to enable.
99# ZED_PUSHOVER_TOKEN, above, must also be configured.
100#ZED_PUSHOVER_USER=""
101
102##
103# Default directory for zed state files.
104#
105#ZED_RUNDIR="/var/run"
106
107##
108# Turn on/off enclosure LEDs when drives get DEGRADED/FAULTED.  This works for
109# device mapper and multipath devices as well.  This works with JBOD enclosures
110# and NVMe PCI drives (assuming they're supported by Linux in sysfs).
111#
112ZED_USE_ENCLOSURE_LEDS=1
113
114##
115# Run a scrub after every resilver
116# Disabled by default, 1 to enable and 0 to disable.
117#ZED_SCRUB_AFTER_RESILVER=0
118
119##
120# The syslog priority (e.g., specified as a "facility.level" pair).
121#
122#ZED_SYSLOG_PRIORITY="daemon.notice"
123
124##
125# The syslog tag for marking zed events.
126#
127#ZED_SYSLOG_TAG="zed"
128
129##
130# Which set of event subclasses to log
131# By default, events from all subclasses are logged.
132# If ZED_SYSLOG_SUBCLASS_INCLUDE is set, only subclasses
133# matching the pattern are logged. Use the pipe symbol (|)
134# or shell wildcards (*, ?) to match multiple subclasses.
135# Otherwise, if ZED_SYSLOG_SUBCLASS_EXCLUDE is set, the
136# matching subclasses are excluded from logging.
137#ZED_SYSLOG_SUBCLASS_INCLUDE="checksum|scrub_*|vdev.*"
138ZED_SYSLOG_SUBCLASS_EXCLUDE="history_event"
139
140##
141# Use GUIDs instead of names when logging pool and vdevs
142# Disabled by default, 1 to enable and 0 to disable.
143#ZED_SYSLOG_DISPLAY_GUIDS=1
144
145