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