timestamps and sequence numbers for monitor data and lifecycle events

Signed-off-by: Kyle Quest <kcq.public@gmail.com>

Author: kcq

pkg/app/sensor/execution/hook.go

@@ -4,8 +4,11 @@ import (
 	"context"
 	"fmt"
 	"os/exec"
+	"time"
 
 	log "github.com/sirupsen/logrus"
+
+	"github.com/slimtoolkit/slim/pkg/acounter"
 	"github.com/slimtoolkit/slim/pkg/util/errutil"
 )
 
@@ -20,10 +23,19 @@ const (
 	monitorFailed       kind = "monitor-failed"
 )
 
+// todo:
+// add 'kind' to the lifecycle event and
+// pass the whole event to the lifecycle hook command
+type LifecycleEvent struct {
+	Timestamp int64  `json:"ts"`
+	SeqNumber uint64 `json:"sn"`
+}
+
 type hookExecutor struct {
-	ctx      context.Context
-	cmd      string
-	lastHook kind
+	ctx       context.Context
+	cmd       string
+	lastHook  kind
+	seqNumber acounter.Type
 }
 
 func (h *hookExecutor) State() string {
@@ -59,11 +71,19 @@ func (h *hookExecutor) doHook(k kind) {
 		return
 	}
 
+	event := LifecycleEvent{
+		Timestamp: time.Now().UTC().UnixNano(),
+		SeqNumber: h.seqNumber.Inc(),
+	}
+
 	h.lastHook = k
+	//todo: pass event as a base64 encoded json string as an extra param to 'cmd'
 	cmd := exec.CommandContext(h.ctx, h.cmd, string(k))
 	out, err := cmd.CombinedOutput()
 
 	logger := log.
+		WithField("kind", string(k)).
+		WithField("event", fmt.Sprintf("%+v", event)).
 		WithField("command", h.cmd).
 		WithField("exit_code", cmd.ProcessState.ExitCode()).
 		WithField("output", string(out))

pkg/appbom/appbom.go

@@ -387,3 +387,5 @@ func Get() *Info {
 
 	return info
 }
+
+//TODO: have an option to add package metadata (from deps.dev and osv.dev)

pkg/mondel/mondel.go

@@ -9,9 +9,11 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"time"
 
 	log "github.com/sirupsen/logrus"
 
+	"github.com/slimtoolkit/slim/pkg/acounter"
 	"github.com/slimtoolkit/slim/pkg/report"
 )
 
@@ -31,6 +33,7 @@ type publisher struct {
 	outputFile string
 	output     *os.File
 	eventCh    chan *report.MonitorDataEvent
+	seqNumber  acounter.Type
 }
 
 func NewPublisher(ctx context.Context, enable bool, outputFile string) *publisher {
@@ -66,10 +69,13 @@ func NewPublisher(ctx context.Context, enable bool, outputFile string) *publishe
 }
 
 func (ref *publisher) Publish(event *report.MonitorDataEvent) error {
-	if !ref.enable {
+	if !ref.enable || event == nil {
 		return nil
 	}
 
+	event.Timestamp = time.Now().UTC().UnixNano()
+	event.SeqNumber = ref.seqNumber.Inc()
+
 	select {
 	case ref.eventCh <- event:
 		return nil

pkg/report/mondel_report.go

@@ -26,15 +26,18 @@ const (
 )
 
 type MonitorDataEvent struct {
+	Timestamp int64  `json:"ts"`
+	SeqNumber uint64 `json:"sn"`
 	Source    string `json:"s"`
 	Type      string `json:"t"`
 	Pid       int32  `json:"p,omitempty"`
 	ParentPid int32  `json:"pp,omitempty"`
-	Artifact  string `json:"a,omitempty"`  //used for exe path for process events
-	OpType    string `json:"o,omitempty"`  //operation type
-	Op        string `json:"op,omitempty"` //operation
+	Artifact  string `json:"a,omitempty"`  // used for exe path for process events
+	OpType    string `json:"o,omitempty"`  // operation type
+	Op        string `json:"op,omitempty"` // operation
 	OpNum     uint32 `json:"n,omitempty"`
 	WorkDir   string `json:"w,omitempty"`
 	Root      string `json:"r,omitempty"`
 	Cmd       string `json:"c,omitempty"`
+	State     string `json:"st,omitempty"`
 }