Merge pull request #1215 from nginx/add-nolinitlint-increase-complexity

Uncommented nolintlint, now comment is a must while adding a nolint directive.

Author: Akshay2191

.golangci.yml

@@ -39,7 +39,7 @@ linters:
     - nilnil
     - nlreturn
     - noctx
-#    - nolintlint
+    - nolintlint
     - nosprintfhostport
     - perfsprint
     - prealloc
@@ -66,7 +66,7 @@ linters:
     - zerologlint
   settings:
     cyclop:
-      max-complexity: 10
+      max-complexity: 12
       package-average: 0
     errorlint:
       errorf: true
@@ -216,19 +216,19 @@ linters:
         - chan
     nlreturn:
       block-size: 2
-#    nolintlint:
-#      # Disable to ensure that all nolint directives actually have an effect.
-#      # Default: false
-#      allow-unused: true
-#      # Exclude following linters from requiring an explanation.
-#      # Default: []
-#      allow-no-explanation: [ ]
-#      # Enable to require an explanation of nonzero length after each nolint directive.
-#      # Default: false
-#      require-explanation: true
-#      # Enable to require nolint directives to mention the specific linter being suppressed.
-#      # Default: false
-#      require-specific: true
+    nolintlint:
+      # Disable to ensure that all nolint directives actually have an effect.
+      # Default: false
+      allow-unused: true
+      # Exclude following linters from requiring an explanation.
+      # Default: []
+      allow-no-explanation: [ ]
+      # Enable to require an explanation of nonzero length after each nolint directive.
+      # Default: false
+      require-explanation: true
+      # Enable to require nolint directives to mention the specific linter being suppressed.
+      # Default: false
+      require-specific: true
     prealloc:
       simple: true
       range-loops: true
@@ -285,7 +285,7 @@ linters:
           disabled: false
         - name: cognitive-complexity
           arguments:
-            - 10
+            - 12
           severity: warning
           disabled: false
         - name: comment-spacings
@@ -310,7 +310,7 @@ linters:
           disabled: false
         - name: cyclomatic
           arguments:
-            - 10
+            - 12
           severity: warning
           disabled: false
         - name: datarace

internal/backoff/backoff.go

@@ -65,7 +65,8 @@ func WaitUntil(
 
 // WaitUntilWithData Implementation of backoff operations that increases the back off period for each retry
 // attempt using a randomization function that grows exponentially. This does not allow for parameters.
-// nolint: ireturn
+//
+//nolint:ireturn // must return an interface
 func WaitUntilWithData[T any](
 	ctx context.Context,
 	backoffSettings *config.BackOff,
@@ -76,7 +77,7 @@ func WaitUntilWithData[T any](
 	return backoff.RetryWithData(operation, backoffWithContext)
 }
 
-// nolint: ireturn
+//nolint:ireturn // must return an interface
 func Context(ctx context.Context, backoffSettings *config.BackOff) backoff.BackOffContext {
 	eb := backoff.NewExponentialBackOff()
 	eb.InitialInterval = backoffSettings.InitialInterval

internal/collector/containermetricsreceiver/factory.go

@@ -21,7 +21,7 @@ import (
 	"github.com/nginx/agent/v3/internal/collector/containermetricsreceiver/internal/metadata"
 )
 
-// nolint: ireturn
+//nolint:ireturn // must return metrics interface
 func NewFactory() receiver.Factory {
 	return receiver.NewFactory(
 		metadata.Type,
@@ -33,7 +33,7 @@ func NewFactory() receiver.Factory {
 	)
 }
 
-// nolint: ireturn
+//nolint:ireturn // must return metrics interface
 func createMetricsReceiver(
 	_ context.Context,
 	params receiver.Settings,

internal/collector/containermetricsreceiver/internal/config/config.go

@@ -14,7 +14,7 @@ type Config struct {
 	scraperhelper.ControllerConfig `mapstructure:",squash"`
 }
 
-// nolint: ireturn
+//nolint:ireturn // must return a default metrics controller interface
 func CreateDefaultConfig() component.Config {
 	cfg := scraperhelper.NewDefaultControllerConfig()
 	return &Config{

internal/collector/containermetricsreceiver/internal/scraper/cpuscraper/factory.go

@@ -15,8 +15,7 @@ import (
 	"go.opentelemetry.io/collector/scraper"
 )
 
-// NewFactory for CPU scraper.
-// nolint: ireturn
+//nolint:ireturn // must return a CPU scraper interface.
 func NewFactory() scraper.Factory {
 	return scraper.NewFactory(
 		metadata.Type,
@@ -25,16 +24,14 @@ func NewFactory() scraper.Factory {
 	)
 }
 
-// createDefaultConfig creates the default configuration for the Scraper.
-// nolint: ireturn
+//nolint:ireturn // must create the default configuration for the Scraper.
 func createDefaultConfig() component.Config {
 	return &Config{
 		MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
 	}
 }
 
-// createMetricsScraper creates a scraper based on provided config.
-// nolint: ireturn
+//nolint:ireturn // must create and return a scraper based on provided config.
 func createMetricsScraper(
 	ctx context.Context,
 	settings scraper.Settings,

internal/collector/containermetricsreceiver/internal/scraper/cpuscraper/internal/cgroup/cpu.go

@@ -73,9 +73,9 @@ func (cs *CPUSource) Collect(ctx context.Context) (ContainerCPUStats, error) {
 	return cpuStats, nil
 }
 
-// nolint: mnd
 func (cs *CPUSource) collectCPUStats(ctx context.Context) (ContainerCPUStats, error) {
 	clockTicks, err := clockTicks(ctx)
+	const nanosecondsPerMillisecond = 1000
 	if err != nil {
 		return ContainerCPUStats{}, err
 	}
@@ -85,7 +85,7 @@ func (cs *CPUSource) collectCPUStats(ctx context.Context) (ContainerCPUStats, er
 	userKey := V2UserKey
 	sysKey := V2SystemKey
 	convertUsage := func(usage float64) float64 {
-		return usage * 1000
+		return usage * nanosecondsPerMillisecond
 	}
 
 	if !cs.isCgroupV2 { // cgroup v1
@@ -162,7 +162,7 @@ func (cs *CPUSource) cpuUsageTimes(filePath, userKey, systemKey string) (*Contai
 	return cpuTimes, nil
 }
 
-// nolint: revive, gocritic
+//nolint:revive // cognitive complexity is 14
 func systemCPUUsage(clockTicks int) (float64, error) {
 	lines, err := internal.ReadLines(CPUStatsPath)
 	if err != nil {
@@ -171,8 +171,7 @@ func systemCPUUsage(clockTicks int) (float64, error) {
 
 	for _, line := range lines {
 		parts := strings.Fields(line)
-		switch parts[0] {
-		case "cpu":
+		if parts[0] == "cpu" {
 			if len(parts) < CPUStatsFileLineLength {
 				return 0, errors.New("unable to process " + CPUStatsPath + ". Invalid number of fields for cpu line")
 			}

internal/collector/containermetricsreceiver/internal/scraper/memoryscraper/factory.go

@@ -16,7 +16,8 @@ import (
 )
 
 // NewFactory for CPU scraper.
-// nolint: ireturn
+//
+//nolint:ireturn // must return a CPU scraper
 func NewFactory() scraper.Factory {
 	return scraper.NewFactory(
 		metadata.Type,
@@ -26,15 +27,17 @@ func NewFactory() scraper.Factory {
 }
 
 // createDefaultConfig creates the default configuration for the Scraper.
-// nolint: ireturn
+//
+//nolint:ireturn // must return a default configuration for scraper
 func createDefaultConfig() component.Config {
 	return &Config{
 		MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
 	}
 }
 
 // createMetricsScraper creates a scraper based on provided config.
-// nolint: ireturn
+//
+//nolint:ireturn // must return a metric scraper interface
 func createMetricsScraper(
 	ctx context.Context,
 	settings scraper.Settings,

internal/collector/containermetricsreceiver/internal/scraper/memoryscraper/internal/cgroup/memory.go

@@ -64,7 +64,6 @@ func (ms *MemorySource) Collect() {
 	}
 }
 
-// nolint: unparam
 func (ms *MemorySource) VirtualMemoryStatWithContext(ctx context.Context) (*mem.VirtualMemoryStat, error) {
 	var cgroupStat mem.VirtualMemoryStat
 	var memoryStat MemoryStat
@@ -146,16 +145,16 @@ func MemoryLimitInBytes(ctx context.Context, filePath string) (uint64, error) {
 	return strconv.ParseUint(memTotalString, 10, 64)
 }
 
-// nolint: revive, mnd
 func CalculateMemoryStat(statFile, cachedKey, sharedKey string) (MemoryStat, error) {
+	const requiredFields = 2
 	memoryStat := MemoryStat{}
 	lines, err := internal.ReadLines(statFile)
 	if err != nil {
 		return memoryStat, err
 	}
 	for _, line := range lines {
 		fields := strings.Fields(line)
-		if len(fields) != 2 {
+		if len(fields) != requiredFields {
 			return memoryStat, fmt.Errorf("%+v required 2 fields", fields)
 		}
 

internal/collector/containermetricsreceiver/internal/utils.go

@@ -21,7 +21,7 @@ func ReadLines(filename string) ([]string, error) {
 	return ReadLinesOffsetN(filename, 0, -1)
 }
 
-// nolint: revive
+//nolint:revive // cognitive complexity is 16
 func ReadLinesOffsetN(filename string, offset uint, n int) (lines []string, err error) {
 	f, err := os.Open(filename)
 	defer func() {

internal/collector/logsgzipprocessor/processor.go

@@ -21,7 +21,7 @@ import (
 	"go.uber.org/zap"
 )
 
-// nolint: ireturn
+//nolint:ireturn // must return factory processor interface for collector
 func NewFactory() processor.Factory {
 	return processor.NewFactory(
 		component.MustNewType("logsgzip"),
@@ -32,7 +32,7 @@ func NewFactory() processor.Factory {
 	)
 }
 
-// nolint: ireturn
+//nolint:ireturn // returns a zip processor interface
 func createLogsGzipProcessor(_ context.Context,
 	settings processor.Settings,
 	cfg component.Config,