Improve GoDoc

xonvanetta · Mar 15, 2023 · 860e334 · 860e334
1 parent 14c2b96
commit 860e334
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 0 deletions.
diff --git a/collectors/collector_manager.go b/collectors/collector_manager.go
@@ -18,6 +18,7 @@ type Collector interface {
 	Collect(context.Context, chan<- prometheus.Metric) (err error)
 }
 
+// CollectorManager is a collector that executes all other collectors
 type CollectorManager struct {
 	collectors      map[string]Collector
 	scrapeDurations *prometheus.SummaryVec
@@ -41,6 +42,8 @@ func getCollectors(client logstashclient.Client) map[string]Collector {
 	return collectors
 }
 
+// Collect executes all collectors and sends the collected metrics to the provided channel.
+// It also sends the duration of the collection to the scrapeDurations collector.
 func (manager *CollectorManager) Collect(ch chan<- prometheus.Metric) {
 	ctx, cancel := context.WithTimeout(context.Background(), config.HttpTimeout)
 

diff --git a/collectors/nodeinfo/nodeinfo_collector.go b/collectors/nodeinfo/nodeinfo_collector.go
@@ -13,6 +13,7 @@ import (
 	"github.com/kuskoman/logstash-exporter/prometheus_helper"
 )
 
+// NodestatsCollector is a custom collector for the /_node/stats endpoint
 type NodestatsCollector struct {
 	client logstashclient.Client
 

diff --git a/collectors/nodestats/nodestats_collector.go b/collectors/nodestats/nodestats_collector.go
@@ -18,6 +18,7 @@ var (
 	namespace = config.PrometheusNamespace
 )
 
+// NodestatsCollector is a custom collector for the /_node/stats endpoint
 type NodestatsCollector struct {
 	client               logstashclient.Client
 	pipelineSubcollector *PipelineSubcollector

diff --git a/collectors/nodestats/pipeline_subcollector.go b/collectors/nodestats/pipeline_subcollector.go
@@ -11,6 +11,9 @@ import (
 	"github.com/kuskoman/logstash-exporter/prometheus_helper"
 )
 
+// PipelineSubcollector is a subcollector that collects metrics about the
+// pipelines of a logstash node.
+// The collector is created once for each pipeline of the node.
 type PipelineSubcollector struct {
 	EventsOut               *prometheus.Desc
 	EventsFiltered          *prometheus.Desc

diff --git a/config/env_helper.go b/config/env_helper.go
@@ -6,6 +6,7 @@ import (
 	"github.com/joho/godotenv"
 )
 
+// InitializeEnv loads the environment variables from the .env file
 func InitializeEnv() error {
 	return godotenv.Load()
 }

diff --git a/config/http_config.go b/config/http_config.go
@@ -2,4 +2,5 @@ package config
 
 import "time"
 
+// HttpTimeout is the timeout for http requests utilized by multiple contexts
 const HttpTimeout = time.Second * 2
diff --git a/prometheus_helper/prometheus_helper.go b/prometheus_helper/prometheus_helper.go
@@ -12,19 +12,25 @@ type SimpleDescHelper struct {
 	Subsystem string
 }
 
+// NewDesc creates a new prometheus.Desc with the namespace and subsystem. The help text is set to the name.
 func (h *SimpleDescHelper) NewDesc(name string) *prometheus.Desc {
 	help := name
 	return prometheus.NewDesc(prometheus.BuildFQName(h.Namespace, h.Subsystem, name), help, nil, nil)
 }
 
+// NewDescWithHelp creates a new prometheus.Desc with the namespace and subsystem.
 func (h *SimpleDescHelper) NewDescWithHelp(name string, help string) *prometheus.Desc {
 	return prometheus.NewDesc(prometheus.BuildFQName(h.Namespace, h.Subsystem, name), help, nil, nil)
 }
 
+// NewDescWithLabel creates a new prometheus.Desc with the namespace and subsystem.
+// Labels are used to differentiate between different sources of the same metric.
 func (h *SimpleDescHelper) NewDescWithHelpAndLabel(name, help, label string) *prometheus.Desc {
 	return prometheus.NewDesc(prometheus.BuildFQName(h.Namespace, h.Subsystem, name), help, []string{label}, nil)
 }
 
+// ExtractFqName extracts the fqName from a prometheus.Desc string.
+// This is useful for testing collectors.
 func ExtractFqName(metric string) (string, error) {
 	regex := regexp.MustCompile(`fqName:\s*"([a-zA-Z_-]+)"`)
 	matches := regex.FindStringSubmatch(metric)

diff --git a/server/server.go b/server/server.go
@@ -8,6 +8,10 @@ import (
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
+// NewAppServer creates a new http server with the given host and port
+// and registers the prometheus handler and the healthcheck handler
+// to the server's mux. The prometheus handler is managed under the
+// hood by the prometheus client library.
 func NewAppServer(host, port string) *http.Server {
 	mux := http.NewServeMux()
 	mux.Handle("/metrics", promhttp.Handler())
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ package config

		import "time"

		// HttpTimeout is the timeout for http requests utilized by multiple contexts
		const HttpTimeout = time.Second * 2