From 526d3fb6348ced1b886a1a1b5de5c8c4053d410c Mon Sep 17 00:00:00 2001 From: Matt Layher Date: Sun, 10 Jan 2016 15:35:53 -0500 Subject: [PATCH] Add doc comments, clarify error log messages, use collectors package name --- collectors/cluster_usage.go | 2 +- collectors/doc.go | 3 +++ collectors/health.go | 2 +- collectors/monitors.go | 2 +- collectors/pool_usage.go | 2 +- exporter.go | 11 ++++++----- 6 files changed, 13 insertions(+), 9 deletions(-) create mode 100644 collectors/doc.go diff --git a/collectors/cluster_usage.go b/collectors/cluster_usage.go index 5457958..eb1c3ca 100644 --- a/collectors/cluster_usage.go +++ b/collectors/cluster_usage.go @@ -159,7 +159,7 @@ func (c *ClusterUsageCollector) Describe(ch chan<- *prometheus.Desc) { // cluster usage over to the provided prometheus Metric channel. func (c *ClusterUsageCollector) Collect(ch chan<- prometheus.Metric) { if err := c.collect(); err != nil { - log.Println("failed collecting metrics:", err) + log.Println("failed collecting cluster usage metrics:", err) return } diff --git a/collectors/doc.go b/collectors/doc.go new file mode 100644 index 0000000..ec135e5 --- /dev/null +++ b/collectors/doc.go @@ -0,0 +1,3 @@ +// Package collectors provides a number of Prometheus collectors which are +// capable of retrieving metrics from a Ceph cluster. +package collectors diff --git a/collectors/health.go b/collectors/health.go index 849c5fc..f124a45 100644 --- a/collectors/health.go +++ b/collectors/health.go @@ -312,7 +312,7 @@ func (c *ClusterHealthCollector) Describe(ch chan<- *prometheus.Desc) { // It requires the caller to handle synchronization. func (c *ClusterHealthCollector) Collect(ch chan<- prometheus.Metric) { if err := c.collect(); err != nil { - log.Println("failed collecting metrics:", err) + log.Println("failed collecting cluster health metrics:", err) return } diff --git a/collectors/monitors.go b/collectors/monitors.go index a216be2..4da6959 100644 --- a/collectors/monitors.go +++ b/collectors/monitors.go @@ -338,7 +338,7 @@ func (m *MonitorCollector) Describe(ch chan<- *prometheus.Desc) { // channel. func (m *MonitorCollector) Collect(ch chan<- prometheus.Metric) { if err := m.collect(); err != nil { - log.Println("failed collecting metrics:", err) + log.Println("failed collecting monitor metrics:", err) return } diff --git a/collectors/pool_usage.go b/collectors/pool_usage.go index b9ea13e..155b5ec 100644 --- a/collectors/pool_usage.go +++ b/collectors/pool_usage.go @@ -175,7 +175,7 @@ func (p *PoolUsageCollector) Describe(ch chan<- *prometheus.Desc) { // prometheus channel. func (p *PoolUsageCollector) Collect(ch chan<- prometheus.Metric) { if err := p.collect(); err != nil { - log.Println("failed collecting metrics:", err) + log.Println("failed collecting pool usage metrics:", err) return } diff --git a/exporter.go b/exporter.go index 2418b7a..c03850d 100644 --- a/exporter.go +++ b/exporter.go @@ -12,6 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Command ceph_exporter provides a Prometheus exporter for a Ceph cluster. package main import ( @@ -20,7 +21,7 @@ import ( "net/http" "sync" - ceph_collectors "github.com/digitalocean/ceph_exporter/collectors" + "github.com/digitalocean/ceph_exporter/collectors" "github.com/ceph/go-ceph/rados" "github.com/prometheus/client_golang/prometheus" @@ -45,10 +46,10 @@ var _ prometheus.Collector = &CephExporter{} func NewCephExporter(conn *rados.Conn) *CephExporter { return &CephExporter{ collectors: []prometheus.Collector{ - ceph_collectors.NewClusterUsageCollector(conn), - ceph_collectors.NewPoolUsageCollector(conn), - ceph_collectors.NewClusterHealthCollector(conn), - ceph_collectors.NewMonitorCollector(conn), + collectors.NewClusterUsageCollector(conn), + collectors.NewPoolUsageCollector(conn), + collectors.NewClusterHealthCollector(conn), + collectors.NewMonitorCollector(conn), }, } }