Merge branch 'v3' into stop-file-watcher-monitoring-log-files

Author: aphralG

.testcoverage.yaml

@@ -40,9 +40,10 @@ exclude:
     - ^test/.*$
     - app.go          # app.go and main.go should be tested by integration tests.
     - main.go
-# Intentionally ignoring as GetProcesses & KillProcess arent being tested as they are wrappers
+    # ignore wrappers around gopsutil
     - internal/datasource/host
     - internal/watcher/process
+    - pkg/nginxprocess
 
 # NOTES:
 # - symbol `/` in all path regexps will be replaced by

CONTRIBUTING.md

@@ -48,6 +48,8 @@ can be merged. Your agreement signature will be safely stored by F5 and no longe
 
 <!-- ### Go Guidelines Here Linter-->
 
+* when writing [table-driven tests](https://go.dev/wiki/TableDrivenTests), add a numbered prefix to each test case name (`Test 1:`, `Test 2:`, and so on) to make it easier to see which cases failed.
+
 ### Git Guidelines
 
 * Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.

api/grpc/mpi/v1/command.pb.go

@@ -90,6 +90,8 @@ message ContainerInfo {
     string container_id = 1 [(buf.validate.field).string.uuid = true];
     // The name of the host
     string hostname = 2 [(buf.validate.field).string.address = true];
+    // Release information of the container
+    ReleaseInfo release_info = 3;
 }
 
 // A response to a CreateConnectionRequest

api/grpc/mpi/v1/command.pb.validate.go

@@ -721,6 +721,7 @@ Container information
 | ----- | ---- | ----- | ----------- |
 | container_id | [string](#string) |  | The identifier of the container |
 | hostname | [string](#string) |  | The name of the host |
+| release_info | [ReleaseInfo](#mpi-v1-ReleaseInfo) |  | Release information of the container |
 
 
 

api/grpc/mpi/v1/command.proto

@@ -120,6 +120,10 @@ func (oc *Collector) Init(ctx context.Context, mp bus.MessagePipeInterface) erro
 		oc.processReceivers(ctx, oc.config.Collector.Receivers.OtlpReceivers)
 	}
 
+	if !oc.stopped {
+		return errors.New("OTel collector already running")
+	}
+
 	bootErr := oc.bootup(runCtx)
 	if bootErr != nil {
 		slog.ErrorContext(runCtx, "Unable to start OTel Collector", "error", bootErr)
@@ -219,6 +223,7 @@ func (oc *Collector) Close(ctx context.Context) error {
 			slog.ErrorContext(ctx, "Failed to shutdown OTel Collector", "error", err, "state", oc.service.GetState())
 		} else {
 			slog.InfoContext(ctx, "OTel Collector shutdown", "state", oc.service.GetState())
+			oc.stopped = true
 		}
 	}
 
@@ -374,6 +379,11 @@ func (oc *Collector) restartCollector(ctx context.Context) {
 	var runCtx context.Context
 	runCtx, oc.cancel = context.WithCancel(ctx)
 
+	if !oc.stopped {
+		slog.ErrorContext(ctx, "Unable to restart OTel collector, failed to stop collector")
+		return
+	}
+
 	bootErr := oc.bootup(runCtx)
 	if bootErr != nil {
 		slog.ErrorContext(runCtx, "Unable to start OTel Collector", "error", bootErr)

docs/proto/protos.md

@@ -144,6 +144,7 @@ func (i *Info) ContainerInfo(ctx context.Context) *v1.Resource_ContainerInfo {
 		ContainerInfo: &v1.ContainerInfo{
 			ContainerId: i.getContainerID(),
 			Hostname:    hostname,
+			ReleaseInfo: i.getReleaseInfo(ctx, i.osReleaseLocation),
 		},
 	}
 }

internal/collector/otel_collector_plugin.go

@@ -426,6 +426,20 @@ func TestInfo_IsContainer(t *testing.T) {
 
 func TestInfo_ContainerInfo(t *testing.T) {
 	ctx := context.Background()
+
+	osReleaseFile := helpers.CreateFileWithErrorCheck(t, os.TempDir(), "os-release")
+	defer helpers.RemoveFileWithErrorCheck(t, osReleaseFile.Name())
+	err := os.WriteFile(osReleaseFile.Name(), []byte(ubuntuReleaseInfo), os.ModeAppend)
+	require.NoError(t, err)
+
+	releaseInfo := &v1.ReleaseInfo{
+		Codename:  "jammy",
+		Id:        "ubuntu",
+		Name:      "Ubuntu",
+		VersionId: "22.04",
+		Version:   "22.04.5 LTS (Jammy Jellyfish)",
+	}
+
 	tests := []struct {
 		name              string
 		mountInfo         string
@@ -501,8 +515,9 @@ func TestInfo_ContainerInfo(t *testing.T) {
 
 			execMock := &execfakes.FakeExecInterface{}
 			execMock.HostnameReturns(test.expectHostname, nil)
+			execMock.ReleaseInfoReturns(releaseInfo)
 
-			_, err := mountInfoFile.WriteString(test.mountInfo)
+			_, err = mountInfoFile.WriteString(test.mountInfo)
 			require.NoError(tt, err)
 
 			err = mountInfoFile.Close()
@@ -515,6 +530,7 @@ func TestInfo_ContainerInfo(t *testing.T) {
 
 			assert.Equal(tt, test.expectContainerID, containerInfo.ContainerInfo.GetContainerId())
 			assert.Equal(tt, test.expectHostname, containerInfo.ContainerInfo.GetHostname())
+			assert.Equal(t, releaseInfo, containerInfo.ContainerInfo.GetReleaseInfo())
 		})
 	}
 }

internal/datasource/host/info.go

@@ -121,8 +121,6 @@ func (fms *FileManagerService) UpdateOverview(
 	defer backoffCancel()
 
 	sendUpdateOverview := func() (*mpi.UpdateOverviewResponse, error) {
-		slog.DebugContext(newCtx, "Sending update overview request", "request", request,
-			"parent_correlation_id", correlationID)
 		if fms.fileServiceClient == nil {
 			return nil, errors.New("file service client is not initialized")
 		}
@@ -131,6 +129,14 @@ func (fms *FileManagerService) UpdateOverview(
 			return nil, errors.New("CreateConnection rpc has not being called yet")
 		}
 
+		slog.InfoContext(newCtx, "Updating file overview",
+			"instance_id", request.GetOverview().GetConfigVersion().GetInstanceId(),
+			"parent_correlation_id", correlationID,
+		)
+		slog.DebugContext(newCtx, "Sending update overview request",
+			"request", request, "parent_correlation_id", correlationID,
+		)
+
 		response, updateError := fms.fileServiceClient.UpdateOverview(newCtx, request)
 
 		validatedError := grpc.ValidateGrpcError(updateError)
@@ -178,8 +184,6 @@ func (fms *FileManagerService) setupIdentifiers(ctx context.Context, iteration i
 	}
 
 	newCtx := context.WithValue(ctx, logger.CorrelationIDContextKey, requestCorrelationID)
-	slog.InfoContext(newCtx, "Updating file overview", "instance_id", logger.GetCorrelationIDAttr(ctx),
-		"parent_correlation_id", correlationID)
 
 	return newCtx, correlationID
 }