Minor cleanup (#56)

* Rename config struct params to be more descriptive.
* Document new config struct.
* Update upstream project URLs to new homepage.

Signed-off-by: SuperQ <[email protected]>

Author: SuperQ

README.md

@@ -2,8 +2,9 @@
 
 [![Build Status](https://circleci.com/gh/SuperQ/chrony_exporter/tree/main.svg?style=svg)](https://circleci.com/gh/SuperQ/chrony_exporter/tree/main)
 [![Docker Repository on Quay](https://quay.io/repository/superq/chrony-exporter/status "Docker Repository on Quay")](https://quay.io/repository/superq/chrony-exporter)
+[![Go Reference](https://pkg.go.dev/badge/github.com/superq/chrony_exporter.svg)](https://pkg.go.dev/github.com/superq/chrony_exporter)
 
-This is a [Prometheus Exporter](https://prometheus.io) for [Chrony NTP](https://chrony.tuxfamily.org/).
+This is a [Prometheus Exporter](https://prometheus.io) for [Chrony NTP](https://chrony-project.org/).
 
 ## Installation
 
@@ -67,7 +68,7 @@ When the exporter is run as root the flag `collector.chmod-socket` is needed as
 
 You can use [Prometheus rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) to pre-compute some values.
 
-For example, the maximum clock error can be computed from several metrics as [documented in the Chrony man pages](https://chrony.tuxfamily.org/doc/4.3/chronyc.html).
+For example, the maximum clock error can be computed from several metrics as [documented in the Chrony man pages](https://chrony-project.org/doc/4.4/chrony.conf.html).
 
 ```yaml
 groups:

collector/collector.go

@@ -49,10 +49,10 @@ type Exporter struct {
 	address string
 	timeout time.Duration
 
-	collectSources     bool
-	collectTracking    bool
-	collectChmodSocket bool
-	collectDNSLookups  bool
+	collectSources  bool
+	collectTracking bool
+	chmodSocket     bool
+	dnsLookups      bool
 
 	logger log.Logger
 }
@@ -66,25 +66,33 @@ func (d *typedDesc) mustNewConstMetric(value float64, labels ...string) promethe
 	return prometheus.MustNewConstMetric(d.desc, d.valueType, value, labels...)
 }
 
+// ChronyCollectorConfig configures the exporter parameters.
 type ChronyCollectorConfig struct {
+	// Address is the Chrony server UDP command port.
 	Address string
+	// Timeout configures the socket timeout to the Chrony server.
 	Timeout time.Duration
 
-	CollectSource      bool
-	CollectTracking    bool
-	CollectChmodSocket bool
-	CollectDNSLookups  bool
+	// ChmodSocket will set the unix datagram socket to mode `0666` when true.
+	ChmodSocket bool
+	// DNSLookups will reverse resolve IP addresses to names when true.
+	DNSLookups bool
+
+	// CollectSources will configure the exporter to collect `chronyc sources`.
+	CollectSources bool
+	// CollectTracking will configure the exporter to collect `chronyc tracking`.
+	CollectTracking bool
 }
 
 func NewExporter(conf ChronyCollectorConfig, logger log.Logger) Exporter {
 	return Exporter{
 		address: conf.Address,
 		timeout: conf.Timeout,
 
-		collectSources:     conf.CollectSource,
-		collectTracking:    conf.CollectTracking,
-		collectChmodSocket: conf.CollectChmodSocket,
-		collectDNSLookups:  conf.CollectDNSLookups,
+		collectSources:  conf.CollectSources,
+		collectTracking: conf.CollectTracking,
+		chmodSocket:     conf.ChmodSocket,
+		dnsLookups:      conf.DNSLookups,
 
 		logger: logger,
 	}
@@ -106,7 +114,7 @@ func (e Exporter) dial() (net.Conn, error, func()) {
 		if err != nil {
 			return nil, err, func() { os.Remove(local) }
 		}
-		if e.collectChmodSocket {
+		if e.chmodSocket {
 			if err := os.Chmod(local, 0666); err != nil {
 				return nil, err, func() { conn.Close(); os.Remove(local) }
 			}

collector/sources.go

@@ -122,7 +122,7 @@ func (e Exporter) getSourcesMetrics(ch chan<- prometheus.Metric, client chrony.C
 	for _, r := range results {
 		sourceAddress := r.IPAddr.String()
 		sourceName := sourceAddress
-		if e.collectDNSLookups {
+		if e.dnsLookups {
 			// Ignore reverse lookup errors.
 			sourceNames, _ := net.LookupAddr(sourceAddress)
 			sort.Strings(sourceNames)

collector/tracking.go

@@ -166,7 +166,7 @@ func (e Exporter) chronyFormatName(tracking chrony.Tracking) string {
 	if tracking.IPAddr.IsUnspecified() {
 		return chrony.RefidToString(tracking.RefID)
 	}
-	if !e.collectDNSLookups {
+	if !e.dnsLookups {
 		return tracking.IPAddr.String()
 	}
 

main.go

@@ -55,16 +55,16 @@ func main() {
 	kingpin.Flag(
 		"collector.sources",
 		"Collect sources metrics",
-	).Default("false").BoolVar(&conf.CollectSource)
+	).Default("false").BoolVar(&conf.CollectSources)
 
 	kingpin.Flag(
 		"collector.chmod-socket",
 		"Chmod 0666 the receiving unix datagram socket",
-	).Default("false").BoolVar(&conf.CollectChmodSocket)
+	).Default("false").BoolVar(&conf.ChmodSocket)
 
 	kingpin.Flag(
 		"collector.dns-lookups", "do reverse DNS lookups",
-	).Default("true").BoolVar(&conf.CollectDNSLookups)
+	).Default("true").BoolVar(&conf.DNSLookups)
 
 	metricsPath := kingpin.Flag(
 		"web.telemetry-path",
@@ -99,7 +99,7 @@ func main() {
 					Text:    "Metrics",
 				},
 				{
-					Address: "https://chrony.tuxfamily.org/",
+					Address: "https://chrony-project.org/",
 					Text:    "Chrony NTP",
 				},
 			},