Skip to content

Commit

Permalink
Added FreeBSD zfs support per prometheus#1063. (prometheus#1394)
Browse files Browse the repository at this point in the history 
Based on the solaris implementation.  There's a lot of other sysctls
available on FreeBSD that aren't reported here.  It'll be easy to add,
if they're useful.  All of the sysctls are uint64.

Signed-off-by: Derek Marcotte <554b8425@razorfever.net>
  • Loading branch information
@derekmarcotte @oblitorum
derekmarcotte authored and oblitorum committed Apr 9, 2024
1 parent 62bac74 commit 6e76174
Showing 1 changed file with 260 additions and 0 deletions.
260 changes: 260 additions & 0 deletions collector/zfs_freebsd.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,260 @@
// Copyright 2019 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package collector

import (
"fmt"

"github.com/prometheus/client_golang/prometheus"
)

type zfsCollector struct {
sysctls []bsdSysctl
}

const (
zfsCollectorSubsystem = "zfs"
)

func init() {
registerCollector("zfs", defaultEnabled, NewZfsCollector)
}

func NewZfsCollector() (Collector, error) {
return &zfsCollector{
sysctls: []bsdSysctl{
{
name: "abdstats_linear_count_total",
description: "ZFS ARC buffer data linear count",
mib: "kstat.zfs.misc.abdstats.linear_cnt",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "abdstats_linear_data_bytes",
description: "ZFS ARC buffer data linear data size",
mib: "kstat.zfs.misc.abdstats.linear_data_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "abdstats_scatter_chunk_waste_bytes",
description: "ZFS ARC buffer data scatter chunk waste",
mib: "kstat.zfs.misc.abdstats.scatter_chunk_waste",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "abdstats_scatter_count_total",
description: "ZFS ARC buffer data scatter count",
mib: "kstat.zfs.misc.abdstats.scatter_cnt",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "abdstats_scatter_data_bytes",
description: "ZFS ARC buffer data scatter data size",
mib: "kstat.zfs.misc.abdstats.scatter_data_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "abdstats_struct_bytes",
description: "ZFS ARC buffer data struct size",
mib: "kstat.zfs.misc.abdstats.struct_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_anon_bytes",
description: "ZFS ARC anon size",
mib: "kstat.zfs.misc.arcstats.anon_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_c_bytes",
description: "ZFS ARC target size",
mib: "kstat.zfs.misc.arcstats.c",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_c_max_bytes",
description: "ZFS ARC maximum size",
mib: "kstat.zfs.misc.arcstats.c_max",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_c_min_bytes",
description: "ZFS ARC minimum size",
mib: "kstat.zfs.misc.arcstats.c_min",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_data_bytes",
description: "ZFS ARC data size",
mib: "kstat.zfs.misc.arcstats.data_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_demand_data_hits_total",
description: "ZFS ARC demand data hits",
mib: "kstat.zfs.misc.arcstats.demand_data_hits",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_demand_data_misses_total",
description: "ZFS ARC demand data misses",
mib: "kstat.zfs.misc.arcstats.demand_data_misses",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_demand_metadata_hits_total",
description: "ZFS ARC demand metadata hits",
mib: "kstat.zfs.misc.arcstats.demand_metadata_hits",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_demand_metadata_misses_total",
description: "ZFS ARC demand metadata misses",
mib: "kstat.zfs.misc.arcstats.demand_metadata_misses",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_hdr_bytes",
description: "ZFS ARC header size",
mib: "kstat.zfs.misc.arcstats.hdr_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_hits_total",
description: "ZFS ARC hits",
mib: "kstat.zfs.misc.arcstats.hits",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_misses_total",
description: "ZFS ARC misses",
mib: "kstat.zfs.misc.arcstats.misses",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_mfu_ghost_hits_total",
description: "ZFS ARC MFU ghost hits",
mib: "kstat.zfs.misc.arcstats.mfu_ghost_hits",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_mfu_ghost_size",
description: "ZFS ARC MFU ghost size",
mib: "kstat.zfs.misc.arcstats.mfu_ghost_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_mfu_bytes",
description: "ZFS ARC MFU size",
mib: "kstat.zfs.misc.arcstats.mfu_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_mru_ghost_hits_total",
description: "ZFS ARC MRU ghost hits",
mib: "kstat.zfs.misc.arcstats.mru_ghost_hits",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "arcstats_mru_ghost_bytes",
description: "ZFS ARC MRU ghost size",
mib: "kstat.zfs.misc.arcstats.mru_ghost_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_mru_bytes",
description: "ZFS ARC MRU size",
mib: "kstat.zfs.misc.arcstats.mru_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_other_bytes",
description: "ZFS ARC other size",
mib: "kstat.zfs.misc.arcstats.other_size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_p_bytes",
description: "ZFS ARC MRU target size",
mib: "kstat.zfs.misc.arcstats.p",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "arcstats_size_bytes",
description: "ZFS ARC size",
mib: "kstat.zfs.misc.arcstats.size",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.GaugeValue,
},
{
name: "zfetchstats_hits_total",
description: "ZFS cache fetch hits",
mib: "kstat.zfs.misc.zfetchstats.hits",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
{
name: "zfetchstats_misses_total",
description: "ZFS cache fetch misses",
mib: "kstat.zfs.misc.zfetchstats.misses",
dataType: bsdSysctlTypeUint64,
valueType: prometheus.CounterValue,
},
},
}, nil
}

func (c *zfsCollector) Update(ch chan<- prometheus.Metric) error {
for _, m := range c.sysctls {
v, err := m.Value()
if err != nil {
return fmt.Errorf("couldn't get sysctl: %s", err)
}

ch <- prometheus.MustNewConstMetric(
prometheus.NewDesc(
prometheus.BuildFQName(namespace, zfsCollectorSubsystem, m.name),
m.description,
nil, nil,
), m.valueType, v)
}

return nil
}

0 comments on commit 6e76174

Please sign in to comment.