xref: /freebsd/sys/contrib/openzfs/cmd/zed/zed.d/zed.rc (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1##
2# zed.rc
3#
4# This file should be owned by root and permissioned 0600.
5##
6
7##
8# Absolute path to the debug output file.
9#
10#ZED_DEBUG_LOG="/tmp/zed.debug.log"
11
12##
13# Email address of the zpool administrator for receipt of notifications;
14#   multiple addresses can be specified if they are delimited by whitespace.
15# Email will only be sent if ZED_EMAIL_ADDR is defined.
16# Disabled by default; uncomment to enable.
17#
18#ZED_EMAIL_ADDR="root"
19
20##
21# Name or path of executable responsible for sending notifications via email;
22#   the mail program must be capable of reading a message body from stdin.
23# Email will only be sent if ZED_EMAIL_ADDR is defined.
24#
25#ZED_EMAIL_PROG="mail"
26
27##
28# Command-line options for ZED_EMAIL_PROG.
29# The string @ADDRESS@ will be replaced with the recipient email address(es).
30# The string @SUBJECT@ will be replaced with the notification subject;
31#   this should be protected with quotes to prevent word-splitting.
32# Email will only be sent if ZED_EMAIL_ADDR is defined.
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# Default directory for zed state files.
87#
88#ZED_RUNDIR="/var/run"
89
90##
91# Turn on/off enclosure LEDs when drives get DEGRADED/FAULTED.  This works for
92# device mapper and multipath devices as well.  Your enclosure must be
93# supported by the Linux SES driver for this to work.
94#
95ZED_USE_ENCLOSURE_LEDS=1
96
97##
98# Run a scrub after every resilver
99# Disabled by default, 1 to enable and 0 to disable.
100#ZED_SCRUB_AFTER_RESILVER=0
101
102##
103# The syslog priority (e.g., specified as a "facility.level" pair).
104#
105#ZED_SYSLOG_PRIORITY="daemon.notice"
106
107##
108# The syslog tag for marking zed events.
109#
110#ZED_SYSLOG_TAG="zed"
111
112##
113# Which set of event subclasses to log
114# By default, events from all subclasses are logged.
115# If ZED_SYSLOG_SUBCLASS_INCLUDE is set, only subclasses
116# matching the pattern are logged. Use the pipe symbol (|)
117# or shell wildcards (*, ?) to match multiple subclasses.
118# Otherwise, if ZED_SYSLOG_SUBCLASS_EXCLUDE is set, the
119# matching subclasses are excluded from logging.
120#ZED_SYSLOG_SUBCLASS_INCLUDE="checksum|scrub_*|vdev.*"
121ZED_SYSLOG_SUBCLASS_EXCLUDE="history_event"
122
123##
124# Use GUIDs instead of names when logging pool and vdevs
125# Disabled by default, 1 to enable and 0 to disable.
126#ZED_SYSLOG_DISPLAY_GUIDS=1
127
128