Merge branch 'main' into collector-tokenpath

Author: john-david3

.github/workflows/ci.yml

@@ -15,6 +15,9 @@ on:
     - reopened
     - synchronize
 
+permissions:
+  contents: read
+
 env:
   NFPM_VERSION: 'v2.35.3'
 

.github/workflows/codeql.yml

@@ -55,57 +55,9 @@ jobs:
     permissions:
       actions: read # for github/codeql-action/init to get workflow details
       contents: read # for actions/checkout to fetch code
+      packages: read
       security-events: write # for github/codeql-action/autobuild to send a status report
     name: Analyze
-    runs-on: ubuntu-24.04
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: ["go"]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
-        # Use only 'java' to analyze code written in Java, Kotlin or both
-        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
-
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@d39d31e687223d841ef683f52467bd88e9b21c14 # v3.25.3
-        with:
-          languages: ${{ matrix.language }}
-          # If you wish to specify custom queries, you can do so here or in a config file.
-          # By default, queries listed here will override any specified in a config file.
-          # Prefix the list here with "+" to use these queries and those in the config file.
-
-          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          # queries: security-extended,security-and-quality
-
-      - name: Setup Golang Environment
-        uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
-        with:
-          go-version-file: go.mod
-        if: matrix.language == 'go'
-
-      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
-      # If this step fails, then you should remove it and run the build manually (see below)
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@d39d31e687223d841ef683f52467bd88e9b21c14 # v3.25.3
-
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-      #   If the Autobuild fails above, remove it and uncomment the following three lines.
-      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-      # - run: |
-      #     echo "Run, Build Application using script"
-      #     ./location_of_script_within_repo/buildscript.sh
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@d39d31e687223d841ef683f52467bd88e9b21c14 # v3.25.3
-        with:
-          category: "/language:${{matrix.language}}"
+    uses: nginxinc/compliance-rules/.github/workflows/codeql.yml@c903bfe6c668eaba362cde6a7882278bc1564401 # v0.1
+    with:
+      requested_languages: go

.github/workflows/label-pr.yml

@@ -4,6 +4,9 @@ on:
   pull_request_target:
     types: [opened, reopened, synchronize]
 
+permissions:
+  contents: read
+
 jobs:
   label-pr:
     permissions:

.github/workflows/release-branch.yml

@@ -86,7 +86,7 @@ jobs:
     runs-on: ubuntu-22.04
     needs: [vars]
     permissions:
-      contents: write
+      contents: write # Needed to create draft release
     outputs:
       release_id: ${{ steps.vars.outputs.RELEASE_ID }}
     steps:
@@ -210,7 +210,7 @@ jobs:
     needs: [vars,release-draft,tag-release]
     permissions:
       id-token: write
-      contents: write
+      contents: write # Needed to update a github release
     steps:
       - name: Checkout Repository
         uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2

.golangci.yml

@@ -77,8 +77,6 @@ linters-settings:
     field-writes-are-uses: true
     # Treat IncDec statement (e.g. `i++` or `i--`) as both read and write operation instead of just wr◊ite. Default: false
     post-statements-are-reads: true
-    # Mark all exported identifiers as used. Default: true
-    exported-is-used: true
     # Mark all exported fields as used. Default: true
     exported-fields-are-used: false
     # Mark all function parameters as used. Default: true
@@ -770,7 +768,7 @@ linters-settings:
     # Enforce using attributes only (overrides no-mixed-args, incompatible with kv-only). Default: false
     attr-only: false
     # Enforce using methods that accept a context. Default: false
-    context-only: false
+    context: ""
     # Enforce using static values for log messages. Default: false
     static-msg: false
     # Enforce using constants instead of raw keys. Default: false

Makefile.tools

@@ -1,6 +1,6 @@
 OAPICODEGEN	    = github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@v2.1.0
 LEFTHOOK	    = github.com/evilmartians/lefthook@v1.6.9
-GOLANGCILINT    = github.com/golangci/golangci-lint/cmd/golangci-lint@v1.61.0
+GOLANGCILINT    = github.com/golangci/golangci-lint/cmd/golangci-lint@v1.64.8
 PROTOCGENGO	    = google.golang.org/protobuf/cmd/protoc-gen-go@v1.32.0
 GOFUMPT	        = mvdan.cc/gofumpt@v0.6.0
 COUNTERFEITER   = github.com/maxbrunsfeld/counterfeiter/v6@v6.8.1

README.md

@@ -13,15 +13,19 @@ NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus insta
 - Notifications of NGINX events
 
 ## Development Environment Setup
+
 ### Installing Prerequisite Packages
+
 The following packages need to be installed:
- - make
- - golang (https://go.dev/doc/install)
- - protoc (https://grpc.io/docs/protoc-installation/)
- - mdatagen (There is currently an issue installing mdatagen https://github.com/open-telemetry/opentelemetry-collector/issues/9281. See instructions below for workaround.)
+
+- make
+- golang (<https://go.dev/doc/install>)
+- protoc (<https://grpc.io/docs/protoc-installation/>)
+- mdatagen (There is currently an [issue installing mdatagen](https://github.com/open-telemetry/opentelemetry-collector/issues/9281). See instructions below for workaround.)
 
 #### Workaround to install mdatagen
-```
+
+```console
 git clone https://github.com/open-telemetry/opentelemetry-collector.git
 cd opentelemetry-collector
 git checkout v0.124.0
@@ -30,47 +34,60 @@ go install
 ```
 
 Before starting development on the NGINX Agent, it is important to download and install the necessary tool and dependencies required by the NGINX Agent. You can do this by running the following `make` command:
-```
+
+```console
 make install-tools
 ```
 
 ### Building NGINX Agent from Source Code
+
 Build NGINX Agent deb package:
-```
+
+```console
 OSARCH=<operating system archiecture> make local-deb-package
 ```
+
 Build NGINX Agent rpm package:
-```
+
+```console
 OSARCH=<operating system archiecture> make local-rpm-package
 ```
+
 Build NGINX Agent apk package:
-```
+
+```console
 OSARCH=<operating system archiecture> make local-apk-package
 ```
 
 ### Testing NGINX Agent
 
 #### Unit tests
+
 To run unit tests and check that there is enough test coverage run the following
-```
+
+```console
 make unit-test coverge
 ```
+
 To check for race conditions, the unit tests can also be run with a race condition detector
-```
+
+```console
 make race-condition-test
 ```
 
 #### Integration tests
+
 To run integration tests, run the following
-```
+
+```console
 make integration-test
 ```
 
 #### Testing with a mock management plane
+
 For testing command operations, there is a mock management gRPC server that can be used. See here: [mock management gRPC server](test/mock/grpc/README.md) \
 For testing metrics, there is a mock management OTel collector that can be used. See here: [mock management OTel collector](test/mock/collector/README.md)
 
-
 ## NGINX Agent Technical Specifications
 
 ### Supported Distributions
@@ -97,7 +114,7 @@ TBD
 
 ## Community
 
-- Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts.
+- Our [NGINX Community Forum ](https://community.nginx.org/tag/agent) is the go-to place to ask questions and share your thoughts.
 
 - Our [GitHub issues page](https://github.com/nginx/agent/issues) offers space for a more technical discussion at your own pace.
 

internal/collector/nginxplusreceiver/config.go

@@ -32,6 +32,7 @@ type APIDetails struct {
 }
 
 // Validate checks if the receiver configuration is valid
+// nolint: ireturn
 func (cfg *Config) Validate() error {
 	if cfg.APIDetails.URL == "" {
 		return errors.New("endpoint cannot be empty for nginxplusreceiver")

internal/collector/otel_collector_plugin.go

@@ -161,10 +161,16 @@ func (oc *Collector) processReceivers(ctx context.Context, receivers []config.Ot
 	}
 }
 
+// nolint: revive, cyclop
 func (oc *Collector) bootup(ctx context.Context) error {
 	errChan := make(chan error)
 
 	go func() {
+		if oc.service == nil {
+			errChan <- fmt.Errorf("unable to start OTel collector: service is nil")
+			return
+		}
+
 		appErr := oc.service.Run(ctx)
 		if appErr != nil {
 			errChan <- appErr
@@ -177,8 +183,11 @@ func (oc *Collector) bootup(ctx context.Context) error {
 		case err := <-errChan:
 			return err
 		default:
-			state := oc.service.GetState()
+			if oc.service == nil {
+				return fmt.Errorf("unable to start otel collector: service is nil")
+			}
 
+			state := oc.service.GetState()
 			switch state {
 			case otelcol.StateStarting:
 				// NoOp
@@ -212,9 +221,9 @@ func (oc *Collector) Close(ctx context.Context) error {
 		oc.service.Shutdown()
 		oc.cancel()
 
-		settings := oc.config.Client.Backoff
+		settings := *oc.config.Client.Backoff
 		settings.MaxElapsedTime = maxTimeToWaitForShutdown
-		err := backoff.WaitUntil(ctx, settings, func() error {
+		err := backoff.WaitUntil(ctx, &settings, func() error {
 			if oc.service.GetState() == otelcol.StateClosed {
 				return nil
 			}
@@ -263,7 +272,7 @@ func (oc *Collector) handleNginxConfigUpdate(ctx context.Context, msg *bus.Messa
 		return
 	}
 
-	reloadCollector := oc.checkForNewReceivers(nginxConfigContext)
+	reloadCollector := oc.checkForNewReceivers(ctx, nginxConfigContext)
 
 	if reloadCollector {
 		slog.InfoContext(ctx, "Reloading OTel collector config, nginx config updated")
@@ -394,7 +403,7 @@ func (oc *Collector) restartCollector(ctx context.Context) {
 	}
 }
 
-func (oc *Collector) checkForNewReceivers(nginxConfigContext *model.NginxConfigContext) bool {
+func (oc *Collector) checkForNewReceivers(ctx context.Context, nginxConfigContext *model.NginxConfigContext) bool {
 	nginxReceiverFound, reloadCollector := oc.updateExistingNginxPlusReceiver(nginxConfigContext)
 
 	if !nginxReceiverFound && nginxConfigContext.PlusAPI.URL != "" {
@@ -410,10 +419,12 @@ func (oc *Collector) checkForNewReceivers(nginxConfigContext *model.NginxConfigC
 				CollectionInterval: defaultCollectionInterval,
 			},
 		)
+		slog.DebugContext(ctx, "NGINX Plus API found, NGINX Plus receiver enabled to scrape metrics")
 
 		reloadCollector = true
 	} else if nginxConfigContext.PlusAPI.URL == "" {
-		reloadCollector = oc.addNginxOssReceiver(nginxConfigContext)
+		slog.WarnContext(ctx, "NGINX Plus API is not configured, searching for stub status endpoint")
+		reloadCollector = oc.addNginxOssReceiver(ctx, nginxConfigContext)
 	}
 
 	if oc.config.IsFeatureEnabled(pkgConfig.FeatureLogsNap) {
@@ -428,7 +439,7 @@ func (oc *Collector) checkForNewReceivers(nginxConfigContext *model.NginxConfigC
 	return reloadCollector
 }
 
-func (oc *Collector) addNginxOssReceiver(nginxConfigContext *model.NginxConfigContext) bool {
+func (oc *Collector) addNginxOssReceiver(ctx context.Context, nginxConfigContext *model.NginxConfigContext) bool {
 	nginxReceiverFound, reloadCollector := oc.updateExistingNginxOSSReceiver(nginxConfigContext)
 
 	if !nginxReceiverFound && nginxConfigContext.StubStatus.URL != "" {
@@ -445,8 +456,11 @@ func (oc *Collector) addNginxOssReceiver(nginxConfigContext *model.NginxConfigCo
 				CollectionInterval: defaultCollectionInterval,
 			},
 		)
+		slog.DebugContext(ctx, "Stub status endpoint found, OSS receiver enabled to scrape metrics")
 
 		reloadCollector = true
+	} else if nginxConfigContext.StubStatus.URL == "" {
+		slog.WarnContext(ctx, "Stub status endpoint not found, NGINX metrics not available")
 	}
 
 	return reloadCollector

internal/datasource/host/info_test.go

@@ -526,11 +526,12 @@ func TestInfo_ContainerInfo(t *testing.T) {
 			info := NewInfo()
 			info.mountInfoLocation = mountInfoFile.Name()
 			info.exec = execMock
+			info.osReleaseLocation = "/non/existent"
 			containerInfo := info.ContainerInfo(ctx)
 
 			assert.Equal(tt, test.expectContainerID, containerInfo.ContainerInfo.GetContainerId())
 			assert.Equal(tt, test.expectHostname, containerInfo.ContainerInfo.GetHostname())
-			assert.Equal(t, releaseInfo, containerInfo.ContainerInfo.GetReleaseInfo())
+			assert.Equal(tt, releaseInfo, containerInfo.ContainerInfo.GetReleaseInfo())
 		})
 	}
 }