From bff943552aea61a15b83f3c3c77bbdb151c3e910 Mon Sep 17 00:00:00 2001
From: "Alex Ellis (OpenFaaS Ltd)" <alexellis2@gmail.com>
Date: Fri, 15 Dec 2023 17:17:06 +0000
Subject: [PATCH] Add system event types from event-worker

These types are for auditing and billing metrics

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
---
 types/system_events.go | 52 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 types/system_events.go

diff --git a/types/system_events.go b/types/system_events.go
new file mode 100644
index 0000000..b0510df
--- /dev/null
+++ b/types/system_events.go
@@ -0,0 +1,52 @@
+package types
+
+import "time"
+
+const (
+	TypeFunctionUsage = "function_usage"
+	TypeAPIAccess     = "api_access"
+)
+
+type Event interface {
+	EventType() string
+}
+
+type FunctionUsageEvent struct {
+	Namespace    string        `json:"namespace"`
+	FunctionName string        `json:"function_name"`
+	Started      time.Time     `json:"started"`
+	Duration     time.Duration `json:"duration"`
+	MemoryBytes  int64         `json:"memory_bytes"`
+}
+
+func (e FunctionUsageEvent) EventType() string {
+	return TypeFunctionUsage
+}
+
+type APIAccessEvent struct {
+	Actor         *Actor    `json:"actor,omitempty"`
+	Path          string    `json:"path"`
+	Method        string    `json:"method"`
+	Actions       []string  `json:"actions"`
+	ResponseCode  int       `json:"response_code"`
+	CustomMessage string    `json:"custom_message,omitempty"`
+	Namespace     string    `json:"namespace,omitempty"`
+	Time          time.Time `json:"time"`
+}
+
+func (e APIAccessEvent) EventType() string {
+	return TypeAPIAccess
+}
+
+// Actor is the user that triggered an event.
+// Get from OIDC claims, we can add any of the default OIDC profile or email claim fields if desired.
+type Actor struct {
+	// OIDC subject, a unique identifier of the user.
+	Sub string `json:"sub"`
+	// Full name of the subject, can be the name of a user of OpenFaaS component.
+	Name string `json:"name,omitempty"`
+	// OpenFaaS issuer
+	Issuer string `json:"issuer,omitempty"`
+	// Federated issuer
+	FedIssuer string `json:"fed_issuer,omitempty"`
+}