Update file watcher to only monitor directories referenced in the nginx configuration

Author: dhurley

go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/google/uuid v1.6.0
 	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0
 	github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.1
+	github.com/hashicorp/go-multierror v1.1.1
 	github.com/mitchellh/mapstructure v1.5.1-0.20231216201459-8508981c8b6c
 	github.com/nginxinc/nginx-plus-go-client/v2 v2.0.1
 	github.com/nginxinc/nginx-prometheus-exporter v1.3.0
@@ -132,6 +133,7 @@ require (
 	github.com/gorilla/mux v1.8.1 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 // indirect
 	github.com/hashicorp/consul/api v1.30.0 // indirect
+	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-version v1.7.0 // indirect
 	github.com/hashicorp/golang-lru v1.0.2 // indirect
 	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect

go.sum

@@ -278,6 +278,7 @@ github.com/hashicorp/consul/api v1.30.0 h1:ArHVMMILb1nQv8vZSGIwwQd2gtc+oSQZ6Caly
 github.com/hashicorp/consul/api v1.30.0/go.mod h1:B2uGchvaXVW2JhFoS8nqTxMD5PBykr4ebY4JWHTTeLM=
 github.com/hashicorp/cronexpr v1.1.2 h1:wG/ZYIKT+RT3QkOdgYc+xsKWVRgnxJ1OJtjjy84fJ9A=
 github.com/hashicorp/cronexpr v1.1.2/go.mod h1:P4wA0KBl9C5q2hABiMO7cp6jcIg96CDh1Efb3g1PWA4=
+github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
 github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=
 github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
 github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ=

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

@@ -6,12 +6,15 @@
 package cgroup
 
 import (
+	"errors"
 	"os"
 	"path"
 	"runtime"
 	"strconv"
 	"testing"
 
+	"github.com/hashicorp/go-multierror"
+
 	"github.com/stretchr/testify/assert"
 )
 
@@ -76,7 +79,16 @@ func TestCollectCPUStats(t *testing.T) {
 			cpuStat, err := cgroupCPUSource.collectCPUStats()
 
 			// Assert error
-			assert.IsType(tt, test.errorType, err)
+			if err != nil {
+				var multiError *multierror.Error
+				if errors.As(err, &multiError) {
+					assert.IsType(tt, test.errorType, multiError.Errors[0])
+				} else {
+					assert.IsType(tt, test.errorType, err)
+				}
+			} else {
+				assert.IsType(tt, test.errorType, err)
+			}
 
 			// Assert result
 			assert.Equal(tt, test.cpuStat, cpuStat)

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

@@ -7,12 +7,15 @@ package cgroup
 
 import (
 	"context"
+	"errors"
 	"os"
 	"path"
 	"runtime"
 	"strconv"
 	"testing"
 
+	"github.com/hashicorp/go-multierror"
+
 	"github.com/shirou/gopsutil/v4/mem"
 	"github.com/stretchr/testify/assert"
 )
@@ -115,7 +118,16 @@ func TestVirtualMemoryStat(t *testing.T) {
 			virtualMemoryStat, err := cgroupCPUSource.VirtualMemoryStat()
 
 			// Assert error
-			assert.IsType(tt, test.errorType, err)
+			if err != nil {
+				var multiError *multierror.Error
+				if errors.As(err, &multiError) {
+					assert.IsType(tt, test.errorType, multiError.Errors[0])
+				} else {
+					assert.IsType(tt, test.errorType, err)
+				}
+			} else {
+				assert.IsType(tt, test.errorType, err)
+			}
 
 			// Assert result
 			assert.Equal(tt, test.virtualMemoryStat, *virtualMemoryStat)

internal/collector/containermetricsreceiver/internal/utils.go

@@ -11,6 +11,8 @@ import (
 	"os"
 	"strconv"
 	"strings"
+
+	"github.com/hashicorp/go-multierror"
 )
 
 type Source interface {
@@ -22,12 +24,18 @@ func ReadLines(filename string) ([]string, error) {
 }
 
 // nolint: revive
-func ReadLinesOffsetN(filename string, offset uint, n int) ([]string, error) {
+func ReadLinesOffsetN(filename string, offset uint, n int) (lines []string, err error) {
 	f, err := os.Open(filename)
+	defer func() {
+		closeErr := f.Close()
+		if closeErr != nil {
+			err = multierror.Append(err, closeErr)
+		}
+	}()
+
 	if err != nil {
 		return []string{}, err
 	}
-	defer f.Close()
 
 	var ret []string
 

internal/config/types.go

@@ -412,6 +412,10 @@ func (c *Config) AreReceiversConfigured() bool {
 }
 
 func isAllowedDir(dir string, allowedDirs []string) bool {
+	if !strings.HasSuffix(dir, "/") && filepath.Ext(dir) == "" {
+		dir += "/"
+	}
+
 	for _, allowedDirectory := range allowedDirs {
 		if strings.HasPrefix(dir, allowedDirectory) {
 			return true

internal/config/types_test.go

@@ -25,10 +25,10 @@ func TestTypes_IsDirectoryAllowed(t *testing.T) {
 			allowed: true,
 			allowedDirs: []string{
 				AgentDirName,
-				"/etc/nginx",
+				"/etc/nginx/",
 				"/var/log/nginx/",
 			},
-			fileDir: "/etc/nginx/nginx.conf",
+			fileDir: "/etc/nginx",
 		},
 		{
 			name:    "Test 2: directory not allowed",

internal/datasource/config/nginx_config_parser.go

@@ -100,7 +100,7 @@ func (ncp *NginxConfigParser) Parse(ctx context.Context, instance *mpi.Instance)
 	return ncp.createNginxConfigContext(ctx, instance, payload)
 }
 
-// nolint: cyclop,revive,gocognit
+// nolint: cyclop,revive,gocognit,gocyclo
 func (ncp *NginxConfigParser) createNginxConfigContext(
 	ctx context.Context,
 	instance *mpi.Instance,
@@ -138,6 +138,10 @@ func (ncp *NginxConfigParser) createNginxConfigContext(
 		err := ncp.crossplaneConfigTraverse(ctx, &conf,
 			func(ctx context.Context, parent, directive *crossplane.Directive) error {
 				switch directive.Directive {
+				case "include":
+					include := ncp.parseIncludeDirective(directive)
+
+					nginxConfigContext.Includes = append(nginxConfigContext.Includes, include)
 				case "log_format":
 					formatMap = ncp.formatMap(directive)
 				case "access_log":
@@ -214,6 +218,17 @@ func (ncp *NginxConfigParser) createNginxConfigContext(
 	return nginxConfigContext, nil
 }
 
+func (ncp *NginxConfigParser) parseIncludeDirective(directive *crossplane.Directive) string {
+	var include string
+	if filepath.IsAbs(directive.Args[0]) {
+		include = directive.Args[0]
+	} else {
+		include = filepath.Join(filepath.Dir(directive.File), directive.Args[0])
+	}
+
+	return include
+}
+
 func (ncp *NginxConfigParser) addAccessLog(accessLog *model.AccessLog,
 	accessLogs []*model.AccessLog,
 ) []*model.AccessLog {

internal/datasource/host/info.go

@@ -205,16 +205,17 @@ func (i *Info) containerID() string {
 // mountInfo is the path: "/proc/self/mountinfo"
 func containerIDFromMountInfo(mountInfo string) (string, error) {
 	mInfoFile, err := os.Open(mountInfo)
-	if err != nil {
-		return "", fmt.Errorf("could not read %s: %w", mountInfo, err)
-	}
 	defer func(f *os.File, fileName string) {
 		closeErr := f.Close()
 		if closeErr != nil {
 			slog.Error("Unable to close file", "file", fileName, "error", closeErr)
 		}
 	}(mInfoFile, mountInfo)
 
+	if err != nil {
+		return "", fmt.Errorf("could not read %s: %w", mountInfo, err)
+	}
+
 	fileScanner := bufio.NewScanner(mInfoFile)
 	fileScanner.Split(bufio.ScanLines)
 
@@ -308,15 +309,15 @@ func (i *Info) releaseInfo(ctx context.Context, osReleaseLocation string) (relea
 
 func readOsRelease(path string) (map[string]string, error) {
 	f, err := os.Open(path)
-	if err != nil {
-		return nil, fmt.Errorf("release file %s is unreadable: %w", path, err)
-	}
 	defer func(f *os.File, fileName string) {
 		closeErr := f.Close()
 		if closeErr != nil {
 			slog.Error("Unable to close file", "file", fileName, "error", closeErr)
 		}
 	}(f, path)
+	if err != nil {
+		return nil, fmt.Errorf("release file %s is unreadable: %w", path, err)
+	}
 
 	info, err := parseOsReleaseFile(f)
 	if err != nil {

internal/file/file_manager_service.go

@@ -854,15 +854,16 @@ func (fms *FileManagerService) writeManifestFile(updatedFiles map[string]*model.
 
 	// 0600 ensures only root can read/write
 	newFile, err := os.OpenFile(fms.manifestFilePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, filePerm)
-	if err != nil {
-		return fmt.Errorf("failed to read manifest file: %w", err)
-	}
 	defer func() {
 		if closeErr := newFile.Close(); closeErr != nil {
 			writeError = closeErr
 		}
 	}()
 
+	if err != nil {
+		return fmt.Errorf("failed to read manifest file: %w", err)
+	}
+
 	_, err = newFile.Write(manifestJSON)
 	if err != nil {
 		return fmt.Errorf("failed to write manifest file: %w", err)