]>
git.proxmox.com Git - mirror_zfs.git/blob - cmd/zed/zed.d/zed-functions.sh
2 # shellcheck disable=SC2039
5 # ZED helper functions for use in ZEDLETs
10 : "${ZED_LOCKDIR:="/var/lock"}"
11 : "${ZED_NOTIFY_INTERVAL_SECS:=3600}"
12 : "${ZED_NOTIFY_VERBOSE:=0}"
13 : "${ZED_RUNDIR:="/var/run"}"
14 : "${ZED_SYSLOG_PRIORITY:="daemon.notice"}"
15 : "${ZED_SYSLOG_TAG:="zed"}"
20 # zed_check_cmd (cmd, ...)
22 # For each argument given, search PATH for the executable command [cmd].
23 # Log a message if [cmd] is not found.
26 # cmd: name of executable command for which to search
29 # 0 if all commands are found in PATH and are executable
30 # n for a count of the command executables that are not found
38 if ! command -v "${cmd}" >/dev
/null
2>&1; then
39 zed_log_err
"\"${cmd}\" not installed"
47 # zed_log_msg (msg, ...)
49 # Write all argument strings to the system log.
60 logger
-p "${ZED_SYSLOG_PRIORITY}" -t "${ZED_SYSLOG_TAG}" -- "$@"
64 # zed_log_err (msg, ...)
66 # Write an error message to the system log. This message will contain the
67 # script name, EID, and all argument strings.
79 logger
-p "${ZED_SYSLOG_PRIORITY}" -t "${ZED_SYSLOG_TAG}" -- "error:" \
80 "$(basename -- "$0"):""${ZEVENT_EID:+" eid=${ZEVENT_EID}:"}" "$@"
84 # zed_lock (lockfile, [fd])
86 # Obtain an exclusive (write) lock on [lockfile]. If the lock cannot be
87 # immediately acquired, wait until it becomes available.
89 # Every zed_lock() must be paired with a corresponding zed_unlock().
91 # By default, flock-style locks associate the lockfile with file descriptor 8.
92 # The bash manpage warns that file descriptors >9 should be used with care as
93 # they may conflict with file descriptors used internally by the shell. File
94 # descriptor 9 is reserved for zed_rate_limit(). If concurrent locks are held
95 # within the same process, they must use different file descriptors (preferably
96 # decrementing from 8); otherwise, obtaining a new lock with a given file
97 # descriptor will release the previous lock associated with that descriptor.
100 # lockfile: pathname of the lock file; the lock will be stored in
101 # ZED_LOCKDIR unless the pathname contains a "/".
102 # fd: integer for the file descriptor used by flock (OPTIONAL unless holding
115 local fd
="${2:-${ZED_FLOCK_FD}}"
119 [ -n "${lockfile}" ] ||
return
120 if ! expr "${lockfile}" : '.*/' >/dev
/null
2>&1; then
121 lockfile
="${ZED_LOCKDIR}/${lockfile}"
127 # Obtain a lock on the file bound to the given file descriptor.
129 eval "exec ${fd}> '${lockfile}'"
130 err
="$(flock --exclusive "${fd}" 2>&1)"
131 # shellcheck disable=SC2181
132 if [ $?
-ne 0 ]; then
133 zed_log_err
"failed to lock \"${lockfile}\": ${err}"
140 # zed_unlock (lockfile, [fd])
142 # Release the lock on [lockfile].
145 # lockfile: pathname of the lock file
146 # fd: integer for the file descriptor used by flock (must match the file
147 # descriptor passed to the zed_lock function call)
159 local fd
="${2:-${ZED_FLOCK_FD}}"
162 [ -n "${lockfile}" ] ||
return
163 if ! expr "${lockfile}" : '.*/' >/dev
/null
2>&1; then
164 lockfile
="${ZED_LOCKDIR}/${lockfile}"
167 # Release the lock and close the file descriptor.
168 err
="$(flock --unlock "${fd}" 2>&1)"
169 # shellcheck disable=SC2181
170 if [ $?
-ne 0 ]; then
171 zed_log_err
"failed to unlock \"${lockfile}\": ${err}"
177 # zed_notify (subject, pathname)
179 # Send a notification via all available methods.
182 # subject: notification subject
183 # pathname: pathname containing the notification message (OPTIONAL)
186 # 0: notification succeeded via at least one method
187 # 1: notification failed
188 # 2: no notification methods configured
197 zed_notify_email
"${subject}" "${pathname}"; rv
=$?
198 [ "${rv}" -eq 0 ] && num_success
=$
((num_success
+ 1))
199 [ "${rv}" -eq 1 ] && num_failure
=$
((num_failure
+ 1))
201 zed_notify_pushbullet
"${subject}" "${pathname}"; rv
=$?
202 [ "${rv}" -eq 0 ] && num_success
=$
((num_success
+ 1))
203 [ "${rv}" -eq 1 ] && num_failure
=$
((num_failure
+ 1))
205 [ "${num_success}" -gt 0 ] && return 0
206 [ "${num_failure}" -gt 0 ] && return 1
211 # zed_notify_email (subject, pathname)
213 # Send a notification via email to the address specified by ZED_EMAIL_ADDR.
215 # Requires the mail executable to be installed in the standard PATH, or
216 # ZED_EMAIL_PROG to be defined with the pathname of an executable capable of
217 # reading a message body from stdin.
219 # Command-line options to the mail executable can be specified in
220 # ZED_EMAIL_OPTS. This undergoes the following keyword substitutions:
221 # - @ADDRESS@ is replaced with the space-delimited recipient email address(es)
222 # - @SUBJECT@ is replaced with the notification subject
225 # subject: notification subject
226 # pathname: pathname containing the notification message (OPTIONAL)
234 # 0: notification sent
235 # 1: notification failed
241 local pathname
="${2:-"/dev/null"}"
243 : "${ZED_EMAIL_PROG:="mail"}"
244 : "${ZED_EMAIL_OPTS:="-s '@SUBJECT@' @ADDRESS@"}"
246 # For backward compatibility with ZED_EMAIL.
247 if [ -n "${ZED_EMAIL}" ] && [ -z "${ZED_EMAIL_ADDR}" ]; then
248 ZED_EMAIL_ADDR
="${ZED_EMAIL}"
250 [ -n "${ZED_EMAIL_ADDR}" ] ||
return 2
252 zed_check_cmd
"${ZED_EMAIL_PROG}" ||
return 1
254 [ -n "${subject}" ] ||
return 1
255 if [ ! -r "${pathname}" ]; then
257 "$(basename "${ZED_EMAIL_PROG}") cannot read \"${pathname}\""
261 ZED_EMAIL_OPTS
="$(echo "${ZED_EMAIL_OPTS}" \
262 | sed -e "s
/@ADDRESS@
/${ZED_EMAIL_ADDR}/g
" \
263 -e "s
/@SUBJECT@
/${subject}/g
")"
265 # shellcheck disable=SC2086
266 eval "${ZED_EMAIL_PROG}" ${ZED_EMAIL_OPTS} < "${pathname}" >/dev
/null
2>&1
268 if [ "${rv}" -ne 0 ]; then
269 zed_log_err
"$(basename "${ZED_EMAIL_PROG}") exit=${rv}"
276 # zed_notify_pushbullet (subject, pathname)
278 # Send a notification via Pushbullet <https://www.pushbullet.com/>.
279 # The access token (ZED_PUSHBULLET_ACCESS_TOKEN) identifies this client to the
280 # Pushbullet server. The optional channel tag (ZED_PUSHBULLET_CHANNEL_TAG) is
281 # for pushing to notification feeds that can be subscribed to; if a channel is
282 # not defined, push notifications will instead be sent to all devices
283 # associated with the account specified by the access token.
285 # Requires awk, curl, and sed executables to be installed in the standard PATH.
288 # https://docs.pushbullet.com/
289 # https://www.pushbullet.com/security
292 # subject: notification subject
293 # pathname: pathname containing the notification message (OPTIONAL)
296 # ZED_PUSHBULLET_ACCESS_TOKEN
297 # ZED_PUSHBULLET_CHANNEL_TAG
300 # 0: notification sent
301 # 1: notification failed
304 zed_notify_pushbullet
()
307 local pathname
="${2:-"/dev/null"}"
313 local url
="https://api.pushbullet.com/v2/pushes"
315 [ -n "${ZED_PUSHBULLET_ACCESS_TOKEN}" ] ||
return 2
317 [ -n "${subject}" ] ||
return 1
318 if [ ! -r "${pathname}" ]; then
319 zed_log_err
"pushbullet cannot read \"${pathname}\""
323 zed_check_cmd
"awk" "curl" "sed" ||
return 1
325 # Escape the following characters in the message body for JSON:
326 # newline, backslash, double quote, horizontal tab, vertical tab,
327 # and carriage return.
329 msg_body
="$(awk '{ ORS="\\n
" } { gsub(/\\/, "\\\\"); gsub(/"/, "\\\"");
330 gsub
(/\t/, "\\t"); gsub
(/\f/, "\\f"); gsub
(/\r/, "\\r"); print
}' \
333 # Push to a channel if one is configured.
335 [ -n "${ZED_PUSHBULLET_CHANNEL_TAG}" ] && msg_tag="$(printf \
336 '"channel_tag": "%s", ' "${ZED_PUSHBULLET_CHANNEL_TAG}")"
338 # Construct the JSON message for pushing a note.
340 msg_json="$(printf '{%s
"type": "note", "title": "%s", "body": "%s"}' \
341 "${msg_tag}" "${subject}" "${msg_body}")"
343 # Send the POST request and check for errors.
345 msg_out="$(curl -u "${ZED_PUSHBULLET_ACCESS_TOKEN}:" -X POST "${url}" \
346 --header "Content-Type: application/json" --data-binary "${msg_json}" \
348 if [ "${rv}" -ne 0 ]; then
349 zed_log_err "curl exit=${rv}"
352 msg_err="$(echo "${msg_out}" \
353 | sed -n -e 's
/.
*"error" *:.
*"message" *: *"\([^"]*\
)".*/\1/p')"
354 if [ -n "${msg_err}" ]; then
355 zed_log_err
"pushbullet \"${msg_err}"\"
362 # zed_rate_limit (tag, [interval])
364 # Check whether an event of a given type [tag] has already occurred within the
365 # last [interval] seconds.
367 # This function obtains a lock on the statefile using file descriptor 9.
370 # tag: arbitrary string for grouping related events to rate-limit
371 # interval: time interval in seconds (OPTIONAL)
374 # ZED_NOTIFY_INTERVAL_SECS
378 # 0 if the event should be processed
379 # 1 if the event should be dropped
387 local interval
="${2:-${ZED_NOTIFY_INTERVAL_SECS}}"
388 local lockfile
="zed.zedlet.state.lock"
390 local statefile
="${ZED_RUNDIR}/zed.zedlet.state"
396 [ -n "${tag}" ] ||
return 0
398 zed_lock
"${lockfile}" "${lockfile_fd}"
399 time_now
="$(date +%s)"
400 time_prev
="$(egrep "^
[0-9]+;${tag}\$
" "${statefile}" 2>/dev/null \
401 | tail -1 | cut -d\; -f1)"
403 if [ -n "${time_prev}" ] \
404 && [ "$((time_now - time_prev))" -lt "${interval}" ]; then
409 egrep -v "^[0-9]+;${tag}\$" "${statefile}" 2>/dev
/null \
411 echo "${time_now};${tag}" >> "${statefile}.$$"
412 mv -f "${statefile}.$$" "${statefile}"
416 zed_unlock
"${lockfile}" "${lockfile_fd}"
421 # zed_guid_to_pool (guid)
423 # Convert a pool GUID into its pool name (like "tank")
425 # guid: pool GUID (decimal or hex)
432 if [ -z "$1" ] ; then
436 guid
=$
(printf "%llu" "$1")
437 if [ ! -z "$guid" ] ; then
438 $ZPOOL get
-H -ovalue,name guid |
awk '$1=='"$guid"' {print $2}'