xref: /freebsd/sys/contrib/openzfs/cmd/zed/zed.d/zed.rc (revision 716fd348)
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#
33#ZED_EMAIL_OPTS="-s '@SUBJECT@' @ADDRESS@"
34
35##
36# Default directory for zed lock files.
37#
38#ZED_LOCKDIR="/var/lock"
39
40##
41# Minimum number of seconds between notifications for a similar event.
42#
43#ZED_NOTIFY_INTERVAL_SECS=3600
44
45##
46# Notification verbosity.
47#   If set to 0, suppress notification if the pool is healthy.
48#   If set to 1, send notification regardless of pool health.
49#
50#ZED_NOTIFY_VERBOSE=0
51
52##
53# Send notifications for 'ereport.fs.zfs.data' events.
54# Disabled by default, any non-empty value will enable the feature.
55#
56#ZED_NOTIFY_DATA=
57
58##
59# Pushbullet access token.
60# This grants full access to your account -- protect it accordingly!
61#   <https://www.pushbullet.com/get-started>
62#   <https://www.pushbullet.com/account>
63# Disabled by default; uncomment to enable.
64#
65#ZED_PUSHBULLET_ACCESS_TOKEN=""
66
67##
68# Pushbullet channel tag for push notification feeds that can be subscribed to.
69#   <https://www.pushbullet.com/my-channel>
70# If not defined, push notifications will instead be sent to all devices
71#   associated with the account specified by the access token.
72# Disabled by default; uncomment to enable.
73#
74#ZED_PUSHBULLET_CHANNEL_TAG=""
75
76##
77# Slack Webhook URL.
78# This allows posting to the given channel and includes an access token.
79#   <https://api.slack.com/incoming-webhooks>
80# Disabled by default; uncomment to enable.
81#
82#ZED_SLACK_WEBHOOK_URL=""
83
84##
85# Pushover token.
86# This defines the application from which the notification will be sent.
87#   <https://pushover.net/api#registration>
88# Disabled by default; uncomment to enable.
89# ZED_PUSHOVER_USER, below, must also be configured.
90#
91#ZED_PUSHOVER_TOKEN=""
92
93##
94# Pushover user key.
95# This defines which user or group will receive Pushover notifications.
96#  <https://pushover.net/api#identifiers>
97# Disabled by default; uncomment to enable.
98# ZED_PUSHOVER_TOKEN, above, must also be configured.
99#ZED_PUSHOVER_USER=""
100
101##
102# Default directory for zed state files.
103#
104#ZED_RUNDIR="/var/run"
105
106##
107# Turn on/off enclosure LEDs when drives get DEGRADED/FAULTED.  This works for
108# device mapper and multipath devices as well.  This works with JBOD enclosures
109# and NVMe PCI drives (assuming they're supported by Linux in sysfs).
110#
111ZED_USE_ENCLOSURE_LEDS=1
112
113##
114# Run a scrub after every resilver
115# Disabled by default, 1 to enable and 0 to disable.
116#ZED_SCRUB_AFTER_RESILVER=0
117
118##
119# The syslog priority (e.g., specified as a "facility.level" pair).
120#
121#ZED_SYSLOG_PRIORITY="daemon.notice"
122
123##
124# The syslog tag for marking zed events.
125#
126#ZED_SYSLOG_TAG="zed"
127
128##
129# Which set of event subclasses to log
130# By default, events from all subclasses are logged.
131# If ZED_SYSLOG_SUBCLASS_INCLUDE is set, only subclasses
132# matching the pattern are logged. Use the pipe symbol (|)
133# or shell wildcards (*, ?) to match multiple subclasses.
134# Otherwise, if ZED_SYSLOG_SUBCLASS_EXCLUDE is set, the
135# matching subclasses are excluded from logging.
136#ZED_SYSLOG_SUBCLASS_INCLUDE="checksum|scrub_*|vdev.*"
137ZED_SYSLOG_SUBCLASS_EXCLUDE="history_event"
138
139##
140# Use GUIDs instead of names when logging pool and vdevs
141# Disabled by default, 1 to enable and 0 to disable.
142#ZED_SYSLOG_DISPLAY_GUIDS=1
143
144