#110 Refactor influxdb monitoring

to use it as singleton.
This enables the possibility to monitor processes that are independent of an incoming request.

internal/runner/abstract_manager.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"github.com/openHPI/poseidon/pkg/dto"
+	"github.com/openHPI/poseidon/pkg/monitoring"
 	"github.com/openHPI/poseidon/pkg/storage"
 )
 
@@ -21,8 +22,9 @@ type AbstractManager struct {
 // NewAbstractManager creates a new abstract runner manager that keeps track of all runners of one kind.
 func NewAbstractManager() *AbstractManager {
 	return &AbstractManager{
-		environments: storage.NewLocalStorage[ExecutionEnvironment](),
-		usedRunners:  storage.NewLocalStorage[Runner](),
+		environments: storage.NewMonitoredLocalStorage[ExecutionEnvironment](
+			monitoring.MeasurementEnvironments, monitorEnvironmentData),
+		usedRunners: storage.NewMonitoredLocalStorage[Runner](monitoring.MeasurementUsedRunner, nil),
 	}
 }
 

internal/runner/aws_manager_test.go

@@ -14,8 +14,7 @@ func TestAWSRunnerManager_EnvironmentAccessor(t *testing.T) {
 	environments := m.ListEnvironments()
 	assert.Empty(t, environments)
 
-	environment := &ExecutionEnvironmentMock{}
-	environment.On("ID").Return(dto.EnvironmentID(tests.DefaultEnvironmentIDAsInteger))
+	environment := createBasicEnvironmentMock(defaultEnvironmentID)
 	m.StoreEnvironment(environment)
 
 	environments = m.ListEnvironments()
@@ -32,8 +31,7 @@ func TestAWSRunnerManager_EnvironmentAccessor(t *testing.T) {
 
 func TestAWSRunnerManager_Claim(t *testing.T) {
 	m := NewAWSRunnerManager()
-	environment := &ExecutionEnvironmentMock{}
-	environment.On("ID").Return(dto.EnvironmentID(tests.DefaultEnvironmentIDAsInteger))
+	environment := createBasicEnvironmentMock(defaultEnvironmentID)
 	r, err := NewAWSFunctionWorkload(environment, nil)
 	assert.NoError(t, err)
 	environment.On("Sample").Return(r, true)
@@ -59,8 +57,7 @@ func TestAWSRunnerManager_Claim(t *testing.T) {
 
 func TestAWSRunnerManager_Return(t *testing.T) {
 	m := NewAWSRunnerManager()
-	environment := &ExecutionEnvironmentMock{}
-	environment.On("ID").Return(dto.EnvironmentID(tests.DefaultEnvironmentIDAsInteger))
+	environment := createBasicEnvironmentMock(defaultEnvironmentID)
 	m.StoreEnvironment(environment)
 	r, err := NewAWSFunctionWorkload(environment, nil)
 	assert.NoError(t, err)
@@ -85,3 +82,13 @@ func TestAWSRunnerManager_Return(t *testing.T) {
 		nextHandler.AssertCalled(t, "Return", nonAWSRunner)
 	})
 }
+
+func createBasicEnvironmentMock(id dto.EnvironmentID) *ExecutionEnvironmentMock {
+	environment := &ExecutionEnvironmentMock{}
+	environment.On("ID").Return(id)
+	environment.On("Image").Return("")
+	environment.On("CPULimit").Return(uint(0))
+	environment.On("MemoryLimit").Return(uint(0))
+	environment.On("NetworkAccess").Return(false, nil)
+	return environment
+}

internal/runner/aws_runner.go

@@ -10,6 +10,7 @@ import (
 	"github.com/openHPI/poseidon/internal/config"
 	"github.com/openHPI/poseidon/pkg/dto"
 	"github.com/openHPI/poseidon/pkg/execution"
+	"github.com/openHPI/poseidon/pkg/monitoring"
 	"github.com/openHPI/poseidon/pkg/storage"
 	"io"
 )
@@ -47,7 +48,7 @@ func NewAWSFunctionWorkload(
 	workload := &AWSFunctionWorkload{
 		id:                newUUID.String(),
 		fs:                make(map[dto.FilePath][]byte),
-		executions:        storage.NewLocalStorage[*dto.ExecutionRequest](),
+		executions:        storage.NewMonitoredLocalStorage[*dto.ExecutionRequest](monitoring.MeasurementExecutionsAWS, nil),
 		runningExecutions: make(map[execution.ID]context.CancelFunc),
 		onDestroy:         onDestroy,
 		environment:       environment,

internal/runner/execution_environment.go

@@ -2,7 +2,9 @@ package runner
 
 import (
 	"encoding/json"
+	"github.com/influxdata/influxdb-client-go/v2/api/write"
 	"github.com/openHPI/poseidon/pkg/dto"
+	"strconv"
 )
 
 // ExecutionEnvironment are groups of runner that share the configuration stored in the environment.
@@ -47,3 +49,14 @@ type ExecutionEnvironment interface {
 	// IdleRunnerCount returns the number of idle runners of the environment.
 	IdleRunnerCount() uint
 }
+
+// monitorEnvironmentData passes the configuration of the environment e into the monitoring Point p.
+func monitorEnvironmentData(p *write.Point, e ExecutionEnvironment, isDeletion bool) {
+	if !isDeletion && e != nil {
+		p.AddTag("image", e.Image())
+		p.AddTag("cpu_limit", strconv.Itoa(int(e.CPULimit())))
+		p.AddTag("memory_limit", strconv.Itoa(int(e.MemoryLimit())))
+		hasNetworkAccess, _ := e.NetworkAccess()
+		p.AddTag("network_access", strconv.FormatBool(hasNetworkAccess))
+	}
+}

internal/runner/nomad_manager_test.go

@@ -36,8 +36,8 @@ func (s *ManagerTestSuite) SetupTest() {
 	s.nomadRunnerManager = NewNomadRunnerManager(s.apiMock, ctx)
 
 	s.exerciseRunner = NewRunner(tests.DefaultRunnerID, s.nomadRunnerManager)
-	s.exerciseEnvironment = &ExecutionEnvironmentMock{}
-	s.setDefaultEnvironment()
+	s.exerciseEnvironment = createBasicEnvironmentMock(defaultEnvironmentID)
+	s.nomadRunnerManager.StoreEnvironment(s.exerciseEnvironment)
 }
 
 func mockRunnerQueries(apiMock *nomad.ExecutorAPIMock, returnedRunnerIds []string) {
@@ -81,18 +81,12 @@ func mockIdleRunners(environmentMock *ExecutionEnvironmentMock) {
 	})
 }
 
-func (s *ManagerTestSuite) setDefaultEnvironment() {
-	s.exerciseEnvironment.On("ID").Return(defaultEnvironmentID)
-	s.nomadRunnerManager.StoreEnvironment(s.exerciseEnvironment)
-}
-
 func (s *ManagerTestSuite) waitForRunnerRefresh() {
 	<-time.After(100 * time.Millisecond)
 }
 
 func (s *ManagerTestSuite) TestSetEnvironmentAddsNewEnvironment() {
-	anotherEnvironment := &ExecutionEnvironmentMock{}
-	anotherEnvironment.On("ID").Return(anotherEnvironmentID)
+	anotherEnvironment := createBasicEnvironmentMock(anotherEnvironmentID)
 	s.nomadRunnerManager.StoreEnvironment(anotherEnvironment)
 
 	job, ok := s.nomadRunnerManager.environments.Get(anotherEnvironmentID.ToString())

internal/runner/nomad_runner.go

@@ -11,18 +11,16 @@ import (
 	nomadApi "github.com/hashicorp/nomad/api"
 	"github.com/openHPI/poseidon/internal/nomad"
 	"github.com/openHPI/poseidon/pkg/dto"
+	"github.com/openHPI/poseidon/pkg/monitoring"
 	"github.com/openHPI/poseidon/pkg/storage"
 	"io"
 	"strings"
 	"time"
 )
 
-// ContextKey is the type for keys in a request context.
-type ContextKey string
-
 const (
 	// runnerContextKey is the key used to store runners in context.Context.
-	runnerContextKey ContextKey = "runner"
+	runnerContextKey dto.ContextKey = "runner"
 	// SIGQUIT is the character that causes a tty to send the SIGQUIT signal to the controlled process.
 	SIGQUIT = 0x1c
 	// executionTimeoutGracePeriod is the time to wait after sending a SIGQUIT signal to a timed out execution.
@@ -55,7 +53,7 @@ func NewNomadJob(id string, portMappings []nomadApi.PortMapping,
 		id:           id,
 		portMappings: portMappings,
 		api:          apiClient,
-		executions:   storage.NewLocalStorage[*dto.ExecutionRequest](),
+		executions:   storage.NewMonitoredLocalStorage[*dto.ExecutionRequest](monitoring.MeasurementExecutionsNomad, nil),
 		onDestroy:    onDestroy,
 	}
 	job.InactivityTimer = NewInactivityTimer(job, onDestroy)