Fixed revive warning

cmd/pgscv.go

@@ -1,3 +1,4 @@
+// Package main is a pgSCV main package
 package main
 
 import (

internal/collector/collector.go

@@ -1,3 +1,4 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (

internal/collector/collector_common.go

@@ -1,16 +1,18 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"database/sql"
-	"github.com/jackc/pgx/v4"
+	"regexp"
+	"strconv"
+	"strings"
+
 	"github.com/cherts/pgscv/internal/filter"
 	"github.com/cherts/pgscv/internal/log"
 	"github.com/cherts/pgscv/internal/model"
 	"github.com/cherts/pgscv/internal/store"
+	"github.com/jackc/pgx/v4"
 	"github.com/prometheus/client_golang/prometheus"
-	"regexp"
-	"strconv"
-	"strings"
 )
 
 // labels is a local wrapper over prometheus.Labels which is a simple map[string]string.

internal/collector/config.go

@@ -1,3 +1,4 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (

internal/collector/filesystem_common.go

@@ -1,12 +1,14 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"bufio"
 	"fmt"
-	"github.com/cherts/pgscv/internal/log"
 	"io"
 	"os"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/log"
 )
 
 // mount describes properties of mounted filesystems

internal/collector/linux_cpu.go

@@ -1,18 +1,20 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"bufio"
 	"bytes"
 	"fmt"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"io"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strconv"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 type cpuCollector struct {

internal/collector/linux_diskstats.go

@@ -1,19 +1,21 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"bufio"
 	"bytes"
 	"fmt"
-	"github.com/cherts/pgscv/internal/filter"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"io"
 	"os"
 	"path/filepath"
 	"regexp"
 	"strconv"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/filter"
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 const (

internal/collector/linux_filesystem.go

@@ -1,16 +1,18 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"errors"
 	"fmt"
-	"github.com/cherts/pgscv/internal/filter"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"io"
 	"os"
 	"syscall"
 	"time"
+
+	"github.com/cherts/pgscv/internal/filter"
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 var (

internal/collector/linux_load_average.go

@@ -1,13 +1,15 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"fmt"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"os"
 	"strconv"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 type loadaverageCollector struct {

internal/collector/linux_memory.go

@@ -1,17 +1,19 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"bufio"
 	"fmt"
-	"github.com/cherts/pgscv/internal/filter"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"io"
 	"os"
 	"regexp"
 	"strconv"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/filter"
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 type meminfoCollector struct {

internal/collector/linux_netdev.go

@@ -1,16 +1,18 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"bufio"
 	"fmt"
-	"github.com/cherts/pgscv/internal/filter"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"io"
 	"os"
 	"strconv"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/filter"
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 type netdevCollector struct {

internal/collector/linux_network.go

@@ -1,19 +1,22 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"fmt"
+	"net"
+	"strings"
+
 	"github.com/cherts/pgscv/internal/log"
 	"github.com/cherts/pgscv/internal/model"
 	"github.com/prometheus/client_golang/prometheus"
-	"net"
-	"strings"
 )
 
 type networkCollector struct {
 	privateAddresses typedDesc
 	publicAddresses  typedDesc
 }
 
+// NewNetworkCollector returns a new Collector exposing network interfaces addresses.
 func NewNetworkCollector(constLabels labels, settings model.CollectorSettings) (Collector, error) {
 	return &networkCollector{
 		publicAddresses: newBuiltinTypedDesc(

internal/collector/linux_sysconfig.go

@@ -1,19 +1,21 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"bufio"
 	"bytes"
 	"fmt"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"io"
 	"os"
 	"path"
 	"path/filepath"
 	"regexp"
 	"strconv"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 type systemCollector struct {
@@ -27,7 +29,7 @@ type systemCollector struct {
 	btime      typedDesc
 }
 
-// NewSystemCollector returns a new Collector exposing system-wide stats.
+// NewSysconfigCollector returns a new Collector exposing system-wide stats.
 func NewSysconfigCollector(constLabels labels, settings model.CollectorSettings) (Collector, error) {
 	return &systemCollector{
 		sysctlList: []string{

internal/collector/linux_sysinfo.go

@@ -1,15 +1,17 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
 	"bufio"
 	"fmt"
-	"github.com/cherts/pgscv/internal/log"
-	"github.com/cherts/pgscv/internal/model"
-	"github.com/prometheus/client_golang/prometheus"
 	"io"
 	"os"
 	"path/filepath"
 	"strings"
+
+	"github.com/cherts/pgscv/internal/log"
+	"github.com/cherts/pgscv/internal/model"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 type sysinfoCollector struct {

internal/collector/patroni_common.go

@@ -1,3 +1,4 @@
+// Package collector is a pgSCV collectors
 package collector
 
 import (
@@ -222,13 +223,14 @@ func NewPatroniCommonCollector(constLabels labels, settings model.CollectorSetti
 	}, nil
 }
 
+// Update method collects statistics, parse it and produces metrics that are sent to Prometheus.
 func (c *patroniCommonCollector) Update(config Config, ch chan<- prometheus.Metric) error {
 	if strings.HasPrefix(config.BaseURL, "https://") {
 		c.client.EnableTLSInsecure()
 	}
 
 	// Check liveness.
-	err := requestApiLiveness(c.client, config.BaseURL)
+	err := requestAPILiveness(c.client, config.BaseURL)
 	if err != nil {
 		ch <- c.up.newConstMetric(0)
 		return err
@@ -237,7 +239,7 @@ func (c *patroniCommonCollector) Update(config Config, ch chan<- prometheus.Metr
 	ch <- c.up.newConstMetric(1)
 
 	// Request general info.
-	respInfo, err := requestApiPatroni(c.client, config.BaseURL)
+	respInfo, err := requestAPIPatroni(c.client, config.BaseURL)
 	if err != nil {
 		return err
 	}
@@ -273,7 +275,7 @@ func (c *patroniCommonCollector) Update(config Config, ch chan<- prometheus.Metr
 	ch <- c.syncStandby.newConstMetric(info.syncStandby, info.scope)
 
 	// Request and parse config.
-	respConfig, err := requestApiPatroniConfig(c.client, config.BaseURL)
+	respConfig, err := requestAPIPatroniConfig(c.client, config.BaseURL)
 	if err != nil {
 		return err
 	}
@@ -288,7 +290,7 @@ func (c *patroniCommonCollector) Update(config Config, ch chan<- prometheus.Metr
 	}
 
 	// Request and parse history.
-	respHist, err := requestApiHistory(c.client, config.BaseURL)
+	respHist, err := requestAPIHistory(c.client, config.BaseURL)
 	if err != nil {
 		return err
 	}
@@ -301,8 +303,8 @@ func (c *patroniCommonCollector) Update(config Config, ch chan<- prometheus.Metr
 	return nil
 }
 
-// requestApiLiveness requests to /liveness endpoint of API and returns error if failed.
-func requestApiLiveness(c *http.Client, baseurl string) error {
+// requestAPILiveness requests to /liveness endpoint of API and returns error if failed.
+func requestAPILiveness(c *http.Client, baseurl string) error {
 	_, err := c.Get(baseurl + "/liveness")
 	if err != nil {
 		return err
@@ -371,13 +373,13 @@ type patroniInfo struct {
 	syncStandby       float64
 }
 
-// apiPatroniResponse implements API response returned by '/config' endpoint.
+// apiPatroniConfigResponse implements API response returned by '/config' endpoint.
 type apiPatroniConfigResponse struct {
 	FailSafeMode     bool `json:"failsafe_mode"`
 	LoopWait         int  `json:"loop_wait"`
 	MaxLagOnFailover int  `json:"maximum_lag_on_failover"`
 	RetryTimeout     int  `json:"retry_timeout"`
-	Ttl              int  `json:"ttl"`
+	TTL              int  `json:"ttl"`
 }
 
 // patroniConfigInfo implements metrics values extracted from the response of '/config' endpoint.
@@ -389,8 +391,8 @@ type patroniConfigInfo struct {
 	ttl                  float64
 }
 
-// requestPatroniConfigInfo requests to /config endpoint of API and returns parsed response.
-func requestApiPatroniConfig(c *http.Client, baseurl string) (*apiPatroniConfigResponse, error) {
+// requestAPIPatroniConfig requests to /config endpoint of API and returns parsed response.
+func requestAPIPatroniConfig(c *http.Client, baseurl string) (*apiPatroniConfigResponse, error) {
 	resp, err := c.Get(baseurl + "/config")
 	if err != nil {
 		return nil, err
@@ -429,12 +431,12 @@ func parsePatroniConfigResponse(resp *apiPatroniConfigResponse) (*patroniConfigI
 		loopWait:             float64(resp.LoopWait),
 		maximumLagOnFailover: float64(resp.MaxLagOnFailover),
 		retryTimeout:         float64(resp.RetryTimeout),
-		ttl:                  float64(resp.Ttl),
+		ttl:                  float64(resp.TTL),
 	}, nil
 }
 
-// requestPatroniInfo requests to /patroni endpoint of API and returns parsed response.
-func requestApiPatroni(c *http.Client, baseurl string) (*apiPatroniResponse, error) {
+// requestAPIPatroni requests to /patroni endpoint of API and returns parsed response.
+func requestAPIPatroni(c *http.Client, baseurl string) (*apiPatroniResponse, error) {
 	resp, err := c.Get(baseurl + "/patroni")
 	if err != nil {
 		return nil, err
@@ -580,8 +582,8 @@ type patroniHistory struct {
 	lastTimelineChangeUnix   float64
 }
 
-// requestApiHistory requests /history endpoint of API and returns parsed response.
-func requestApiHistory(c *http.Client, baseurl string) (apiHistoryResponse, error) {
+// requestAPIHistory requests /history endpoint of API and returns parsed response.
+func requestAPIHistory(c *http.Client, baseurl string) (apiHistoryResponse, error) {
 	resp, err := c.Get(baseurl + "/history")
 	if err != nil {
 		return nil, err