Add zpool_influxdb command

A zpool_influxdb command is introduced to ease the collection
of zpool statistics into the InfluxDB time-series database.
Examples are given on how to integrate with the telegraf
statistics aggregator, a companion to influxdb.

Finally, a grafana dashboard template is included to show
how pool latency distributions can be visualized in a
ZFS + telegraf + influxdb  + grafana environment.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: Richard Elling <Richard.Elling@RichardElling.com>
Closes #10786
This commit is contained in:
Richard Elling
2020-10-09 09:29:21 -07:00
committed by GitHub
parent b7ab7ae241
commit e9527d44e6
20 changed files with 3102 additions and 2 deletions
+2 -1
View File
@@ -188,7 +188,8 @@ export ZFS_FILES='zdb
zgenhostid
zstream
zstreamdump
zfs_ids_to_path'
zfs_ids_to_path
zpool_influxdb'
export ZFSTEST_FILES='badsend
btree_test
@@ -82,6 +82,7 @@ SUBDIRS = \
vdev_zaps \
write_dirs \
xattr \
zpool_influxdb \
zvol
if BUILD_LINUX
@@ -0,0 +1,5 @@
pkgdatadir = $(datadir)/@PACKAGE@/zfs-tests/tests/functional/zpool_influxdb
dist_pkgdata_SCRIPTS = \
setup.ksh \
cleanup.ksh \
zpool_influxdb.ksh
@@ -0,0 +1,29 @@
#!/bin/ksh -p
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at
# https://opensource.org/licenses/CDDL-1.0
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#
# Copyright 2020 Richard Elling
#
. $STF_SUITE/include/libtest.shlib
default_cleanup
+29
View File
@@ -0,0 +1,29 @@
#!/bin/ksh -p
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at
# https://opensource.org/licenses/CDDL-1.0
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#
# Copyright 2020 Richard Elling
#
. $STF_SUITE/include/libtest.shlib
default_raidz_setup $DISKS
@@ -0,0 +1,71 @@
#!/bin/ksh -p
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at
# https://opensource.org/licenses/CDDL-1.0
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#
# Copyright 2020 Richard Elling
#
. $STF_SUITE/include/libtest.shlib
typeset tmpfile=$TEST_BASE_DIR/zpool_influxdb.out.$$
function cleanup
{
if [[ -f $tmpfile ]]; then
rm -f $tmpfile
fi
}
log_onexit cleanup
log_assert "zpool_influxdb gathers statistics"
if ! is_global_zone ; then
TESTPOOL=${TESTPOOL%%/*}
fi
function check_for
{
grep "^${1}," $tmpfile >/dev/null 2>/dev/null
if [ $? -ne 0 ]; then
log_fail "cannot find stats for $1"
fi
}
# by default, all stats and histograms for all pools
log_must zpool_influxdb > $tmpfile
STATS="
zpool_io_size
zpool_latency
zpool_stats
zpool_vdev_queue
zpool_vdev_stats
"
for stat in $STATS; do
check_for $stat
done
# scan stats aren't expected to be there until after a scan has started
zpool scrub $TESTPOOL
zpool_influxdb > $tmpfile
check_for zpool_scan_stats
log_pass "zpool_influxdb gathers statistics"