Feature/add event source field

README.md

@@ -560,7 +560,8 @@ It represents individual flag evaluations and is considered "full fidelity" even
   "key": "test-flag",
   "variation": "Default",
   "value": false,
-  "default": false
+  "default": false,
+  "source": "SERVER"
 }
 ```
 The format of the data is [described in the documentation](https://gofeatureflag.org/docs/).

cmd/relayproxy/config/config.go

@@ -45,7 +45,7 @@ var DefaultExporter = struct {
 	LogFormat: "[{{ .FormattedDate}}] user=\"{{ .UserKey}}\", flag=\"{{ .Key}}\", value=\"{{ .Value}}\"",
 	FileName:  "flag-variation-{{ .Hostname}}-{{ .Timestamp}}.{{ .Format}}",
 	CsvFormat: "{{ .Kind}};{{ .ContextKind}};{{ .UserKey}};{{ .CreationDate}};{{ .Key}};{{ .Variation}};" +
-		"{{ .Value}};{{ .Default}}\n",
+		"{{ .Value}};{{ .Default}};{{ .Source}}\n",
 	FlushInterval:           60000 * time.Millisecond,
 	MaxEventInMemory:        100000,
 	ParquetCompressionCodec: parquet.CompressionCodec_SNAPPY.String(),

cmd/relayproxy/controller/collect_eval_data.go

@@ -47,6 +47,7 @@ func (h *collectEvalData) Handler(c echo.Context) error {
 	}
 
 	for _, event := range reqBody.Events {
+		event.Source = "PROVIDER_CACHE"
 		h.goFF.CollectEventData(event)
 	}
 

cmd/relayproxy/docs/docs.go

@@ -298,6 +298,11 @@ const docTemplate = `{
                     "type": "string",
                     "example": "feature"
                 },
+                "source": {
+                    "description": "Source indicates where the event was generated.\nThis is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.",
+                    "type": "string",
+                    "example": "SERVER"
+                },
                 "userKey": {
                     "description": "UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature\nflag evaluation as reported by the \"feature\" event are transmitted periodically with a separate index event.",
                     "type": "string",

cmd/relayproxy/docs/swagger.json

@@ -290,6 +290,11 @@
                     "type": "string",
                     "example": "feature"
                 },
+                "source": {
+                    "description": "Source indicates where the event was generated.\nThis is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.",
+                    "type": "string",
+                    "example": "SERVER"
+                },
                 "userKey": {
                     "description": "UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature\nflag evaluation as reported by the \"feature\" event are transmitted periodically with a separate index event.",
                     "type": "string",

cmd/relayproxy/docs/swagger.yaml

@@ -29,6 +29,12 @@ definitions:
           A feature event will only be generated if the trackEvents attribute of the flag is set to true.
         example: feature
         type: string
+      source:
+        description: |-
+          Source indicates where the event was generated.
+          This is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.
+        example: SERVER
+        type: string
       userKey:
         description: |-
           UserKey The key of the user object used in a feature flag evaluation. Details for the user object used in a feature

cmd/relayproxy/testdata/controller/collect_eval_data/valid_collected_data.json

@@ -1 +1 @@
-{"kind":"feature","contextKind":"user","userKey":"94a25909-20d8-40cc-8500-fee99b569345","creationDate":1680246000011,"key":"my-feature-flag","variation":"admin-variation","value":"string","default":false,"version":"v1.0.0"}
+{"kind":"feature","contextKind":"user","userKey":"94a25909-20d8-40cc-8500-fee99b569345","creationDate":1680246000011,"key":"my-feature-flag","variation":"admin-variation","value":"string","default":false,"version":"v1.0.0","source":"PROVIDER_CACHE"}

examples/data_export_file/main.go

@@ -2,11 +2,12 @@ package main
 
 import (
 	"context"
-	"github.com/thomaspoignant/go-feature-flag/ffcontext"
 	"log"
 	"os"
 	"time"
 
+	"github.com/thomaspoignant/go-feature-flag/ffcontext"
+
 	"github.com/thomaspoignant/go-feature-flag/exporter/fileexporter"
 	"github.com/thomaspoignant/go-feature-flag/retriever/fileretriever"
 
@@ -60,13 +61,13 @@ func main() {
 		The output will be something like that:
 
 		flag-variation-EXAMPLE-<timestamp>.json:
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"new-admin-access","variation":"True","value":true,"default":false}
-			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234129,"key":"new-admin-access","variation":"False","value":false,"default":false}
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag","variation":"SdkDefault","value":"defaultValue","default":true}
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag-2","variation":"SdkDefault","value":{"test":"toto"},"default":true}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"new-admin-access","variation":"True","value":true,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234129,"key":"new-admin-access","variation":"False","value":false,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag","variation":"SdkDefault","value":"defaultValue","default":true,"source":"SERVER"}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag-2","variation":"SdkDefault","value":{"test":"toto"},"default":true,"source":"SERVER"}
 		----
 		flag-variation-EXAMPLE-<timestamp>.json:
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234131,"key":"new-admin-access","variation":"True","value":true,"default":false}
-			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234131,"key":"new-admin-access","variation":"False","value":false,"default":false}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234131,"key":"new-admin-access","variation":"True","value":true,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234131,"key":"new-admin-access","variation":"False","value":false,"default":false,"source":"SERVER"}
 	*/
 }

examples/data_export_googlecloudstorage/main.go

@@ -2,11 +2,12 @@ package main
 
 import (
 	"context"
-	"github.com/thomaspoignant/go-feature-flag/ffcontext"
 	"log"
 	"os"
 	"time"
 
+	"github.com/thomaspoignant/go-feature-flag/ffcontext"
+
 	"github.com/thomaspoignant/go-feature-flag/exporter/gcstorageexporter"
 	"github.com/thomaspoignant/go-feature-flag/retriever/fileretriever"
 	"google.golang.org/api/option"
@@ -69,13 +70,13 @@ func main() {
 	/*
 		The content of those files should looks like:
 		/go-feature-flag/variations/flag-variation-EXAMPLE-<timestamp>.json:
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"new-admin-access","variation":"True","value":true,"default":false}
-			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234129,"key":"new-admin-access","variation":"False","value":false,"default":false}
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag","variation":"SdkDefault","value":"defaultValue","default":true}
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag-2","variation":"SdkDefault","value":{"test":"toto"},"default":true}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"new-admin-access","variation":"True","value":true,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234129,"key":"new-admin-access","variation":"False","value":false,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag","variation":"SdkDefault","value":"defaultValue","default":true,"source":"SERVER"}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag-2","variation":"SdkDefault","value":{"test":"toto"},"default":true,"source":"SERVER"}
 		----
 		/go-feature-flag/variations/flag-variation-EXAMPLE-<timestamp>.json:
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234131,"key":"new-admin-access","variation":"True","value":true,"default":false}
-			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234131,"key":"new-admin-access","variation":"False","value":false,"default":false}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234131,"key":"new-admin-access","variation":"True","value":true,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234131,"key":"new-admin-access","variation":"False","value":false,"default":false,"source":"SERVER"}
 	*/
 }

examples/data_export_s3/main.go

@@ -2,14 +2,15 @@ package main
 
 import (
 	"context"
+	"log"
+	"os"
+	"time"
+
 	"github.com/aws/aws-sdk-go-v2/config"
 	ffclient "github.com/thomaspoignant/go-feature-flag"
 	"github.com/thomaspoignant/go-feature-flag/exporter/s3exporterv2"
 	"github.com/thomaspoignant/go-feature-flag/ffcontext"
 	"github.com/thomaspoignant/go-feature-flag/retriever/fileretriever"
-	"log"
-	"os"
-	"time"
 )
 
 func main() {
@@ -68,13 +69,13 @@ func main() {
 	/*
 		The content of those files should looks like:
 		/go-feature-flag/variations/flag-variation-EXAMPLE-<timestamp>.json:
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"new-admin-access","variation":"True","value":true,"default":false}
-			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234129,"key":"new-admin-access","variation":"False","value":false,"default":false}
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag","variation":"SdkDefault","value":"defaultValue","default":true}
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag-2","variation":"SdkDefault","value":{"test":"toto"},"default":true}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"new-admin-access","variation":"True","value":true,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234129,"key":"new-admin-access","variation":"False","value":false,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag","variation":"SdkDefault","value":"defaultValue","default":true,"source":"SERVER"}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234129,"key":"unknown-flag-2","variation":"SdkDefault","value":{"test":"toto"},"default":true,"source":"SERVER"}
 		----
 		/go-feature-flag/variations/flag-variation-EXAMPLE-<timestamp>.json:
-			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234131,"key":"new-admin-access","variation":"True","value":true,"default":false}
-			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234131,"key":"new-admin-access","variation":"False","value":false,"default":false}
+			{"kind":"feature","contextKind":"anonymousUser","userKey":"aea2fdc1-b9a0-417a-b707-0c9083de68e3","creationDate":1618234131,"key":"new-admin-access","variation":"True","value":true,"default":false,"source":"SERVER"}
+			{"kind":"feature","contextKind":"user","userKey":"332460b9-a8aa-4f7a-bc5d-9cc33632df9a","creationDate":1618234131,"key":"new-admin-access","variation":"False","value":false,"default":false,"source":"SERVER"}
 	*/
 }

exporter/common.go

@@ -11,7 +11,7 @@ import (
 )
 
 const DefaultCsvTemplate = "{{ .Kind}};{{ .ContextKind}};{{ .UserKey}};{{ .CreationDate}};{{ .Key}};{{ .Variation}};" +
-	"{{ .Value}};{{ .Default}}\n"
+	"{{ .Value}};{{ .Default}};{{ .Source}}\n"
 const DefaultFilenameTemplate = "flag-variation-{{ .Hostname}}-{{ .Timestamp}}.{{ .Format}}"
 
 // ParseTemplate is parsing the template given by the config or use the default template

exporter/common_test.go

@@ -133,10 +133,10 @@ func TestFormatEventInCSV(t *testing.T) {
 				csvTemplate: exporter.ParseTemplate("exporterExample", exporter.DefaultCsvTemplate, exporter.DefaultCsvTemplate),
 				event: exporter.FeatureEvent{
 					Kind: "feature", ContextKind: "anonymousUser", UserKey: "ABCD", CreationDate: 1617970547, Key: "random-key",
-					Variation: "Default", Value: "YO", Default: false,
+					Variation: "Default", Value: "YO", Default: false, Source: "SERVER",
 				},
 			},
-			want:    "feature;anonymousUser;ABCD;1617970547;random-key;Default;YO;false\n",
+			want:    "feature;anonymousUser;ABCD;1617970547;random-key;Default;YO;false;SERVER\n",
 			wantErr: assert.NoError,
 		},
 	}
@@ -165,9 +165,9 @@ func TestFormatEventInJSON(t *testing.T) {
 			name: "valid",
 			args: args{event: exporter.FeatureEvent{
 				Kind: "feature", ContextKind: "anonymousUser", UserKey: "ABCD", CreationDate: 1617970547, Key: "random-key",
-				Variation: "Default", Value: "YO", Default: false,
+				Variation: "Default", Value: "YO", Default: false, Source: "SERVER",
 			}},
-			want:    "{\"kind\":\"feature\",\"contextKind\":\"anonymousUser\",\"userKey\":\"ABCD\",\"creationDate\":1617970547,\"key\":\"random-key\",\"variation\":\"Default\",\"value\":\"YO\",\"default\":false,\"version\":\"\"}\n",
+			want:    "{\"kind\":\"feature\",\"contextKind\":\"anonymousUser\",\"userKey\":\"ABCD\",\"creationDate\":1617970547,\"key\":\"random-key\",\"variation\":\"Default\",\"value\":\"YO\",\"default\":false,\"version\":\"\",\"source\":\"SERVER\"}\n",
 			wantErr: assert.NoError,
 		},
 	}

exporter/data_exporter_test.go

@@ -3,13 +3,14 @@ package exporter_test
 import (
 	"context"
 	"errors"
-	"github.com/thomaspoignant/go-feature-flag/exporter"
-	"github.com/thomaspoignant/go-feature-flag/ffcontext"
 	"log"
 	"os"
 	"testing"
 	"time"
 
+	"github.com/thomaspoignant/go-feature-flag/exporter"
+	"github.com/thomaspoignant/go-feature-flag/ffcontext"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/thomaspoignant/go-feature-flag/testutils/mock"
 
@@ -26,7 +27,7 @@ func TestDataExporterScheduler_flushWithTime(t *testing.T) {
 	inputEvents := []exporter.FeatureEvent{
 		exporter.NewFeatureEvent(
 			ffcontext.NewEvaluationContextBuilder("ABCD").AddCustom("anonymous", true).Build(), "random-key",
-			"YO", "defaultVar", false, ""),
+			"YO", "defaultVar", false, "", "SERVER"),
 	}
 
 	for _, event := range inputEvents {
@@ -48,7 +49,7 @@ func TestDataExporterScheduler_flushWithNumberOfEvents(t *testing.T) {
 	for i := 0; i <= 100; i++ {
 		inputEvents = append(inputEvents, exporter.NewFeatureEvent(
 			ffcontext.NewEvaluationContextBuilder("ABCD").AddCustom("anonymous", true).Build(),
-			"random-key", "YO", "defaultVar", false, ""))
+			"random-key", "YO", "defaultVar", false, "", "SERVER"))
 	}
 	for _, event := range inputEvents {
 		dc.AddEvent(event)
@@ -67,7 +68,7 @@ func TestDataExporterScheduler_defaultFlush(t *testing.T) {
 	for i := 0; i <= 100000; i++ {
 		inputEvents = append(inputEvents, exporter.NewFeatureEvent(
 			ffcontext.NewEvaluationContextBuilder("ABCD").AddCustom("anonymous", true).Build(),
-			"random-key", "YO", "defaultVar", false, ""))
+			"random-key", "YO", "defaultVar", false, "", "SERVER"))
 	}
 	for _, event := range inputEvents {
 		dc.AddEvent(event)
@@ -92,7 +93,7 @@ func TestDataExporterScheduler_exporterReturnError(t *testing.T) {
 	for i := 0; i <= 200; i++ {
 		inputEvents = append(inputEvents, exporter.NewFeatureEvent(
 			ffcontext.NewEvaluationContextBuilder("ABCD").AddCustom("anonymous", true).Build(),
-			"random-key", "YO", "defaultVar", false, ""))
+			"random-key", "YO", "defaultVar", false, "", "SERVER"))
 	}
 	for _, event := range inputEvents {
 		dc.AddEvent(event)
@@ -114,7 +115,7 @@ func TestDataExporterScheduler_nonBulkExporter(t *testing.T) {
 	for i := 0; i < 100; i++ {
 		inputEvents = append(inputEvents, exporter.NewFeatureEvent(
 			ffcontext.NewEvaluationContextBuilder("ABCD").AddCustom("anonymous", true).Build(),
-			"random-key", "YO", "defaultVar", false, ""))
+			"random-key", "YO", "defaultVar", false, "", "SERVER"))
 	}
 	for _, event := range inputEvents {
 		dc.AddEvent(event)

exporter/feature_event.go

@@ -2,8 +2,9 @@ package exporter
 
 import (
 	"encoding/json"
-	"github.com/thomaspoignant/go-feature-flag/ffcontext"
 	"time"
+
+	"github.com/thomaspoignant/go-feature-flag/ffcontext"
 )
 
 func NewFeatureEvent(
@@ -13,6 +14,7 @@ func NewFeatureEvent(
 	variation string,
 	failed bool,
 	version string,
+	source string,
 ) FeatureEvent {
 	contextKind := "user"
 	if ctx.IsAnonymous() {
@@ -29,6 +31,7 @@ func NewFeatureEvent(
 		Value:        value,
 		Default:      failed,
 		Version:      version,
+		Source:       source,
 	}
 }
 
@@ -68,6 +71,10 @@ type FeatureEvent struct {
 	// Version contains the version of the flag. If the field is omitted for the flag in the configuration file
 	// the default version will be 0.
 	Version string `json:"version" example:"v1.0.0" parquet:"name=version, type=BYTE_ARRAY, convertedtype=UTF8"`
+
+	// Source indicates where the event was generated.
+	// This is set to SERVER when the event was evaluated in the relay-proxy and PROVIDER_CACHE when it is evaluated from the cache.
+	Source string `json:"source" example:"SERVER" parquet:"name=source, type=BYTE_ARRAY, convertedtype=UTF8"`
 }
 
 // MarshalInterface marshals all interface type fields in FeatureEvent into JSON-encoded string.