File System

Overview

Export evaluation data to a directory in your file system.

Everytime the FlushInterval or MaxEventInMemory is reached a new file will be added to File System.

info

If for some reason the File System upload fails, we will keep the data in memory and retry to add the next time we reach FlushInterval or MaxEventInMemory.

Configure the relay proxy

To configure your relay proxy to use the File System exporter, you need to add the following configuration to your relay proxy configuration file:

goff-proxy.yaml

# ...
exporter:
  kind: file
  outputDir: /output-data/
# ...

Field name	Mandatory	Type	Default	Description
kind		string	none	Value should be file. This field is mandatory and describes which retriever you are using.
outputDir		string	none	OutputDir is the location of the directory where to store the exported files.
path		string	bucket root level	The location of the directory in Google Cloud Storage.
flushInterval		int	60000	The interval in millisecond between 2 calls to the webhook (if the maxEventInMemory is reached before the flushInterval we will call the exporter before).
maxEventInMemory		int	100000	If we hit that limit we will call the exporter.
format		string	JSON	Format is the output format you want in your exported file. Available format: JSON, CSV, Parquet.
filename		string	flag-variation-{{ .Hostname}}-{{ .Timestamp}}.{{ .Format}}	You can use a config template to define the name of your exported files. Available replacements are {{ .Hostname}}, {{ .Timestamp}} and {{ .Format}
csvTemplate		string	{{ .Kind}};{{ .ContextKind}};{{ .UserKey}};{{ .CreationDate}};{{ .Key}};{{ .Variation}};{{ .Value}};{{ .Default}};{{ .Source}}\n	CsvTemplate is used if your output format is CSV. This field will be ignored if you are using format other than CSV. You can decide which fields you want in your CSV line with a go-template syntax, please check exporter/feature_event.go to see what are the fields available.
parquetCompressionCodec		string	SNAPPY	ParquetCompressionCodec is the parquet compression codec for better space efficiency. Available options

Configure the GO Module

To configure your GO module to use the File System exporter, you need to add the following configuration to your ffclient.Config{} object:

example.go

config := ffclient.Config{
    // ...
   DataExporter: ffclient.DataExporter{
        // ...
        Exporter: &fileexporter.Exporter{
            OutputDir: "/output-data/",
            Format: "csv",
            FileName: "flag-variation-{{ .Hostname}}-{{ .Timestamp}}.{{ .Format}}",
            CsvTemplate: "{{ .Kind}};{{ .ContextKind}};{{ .UserKey}};{{ .CreationDate}};{{ .Key}};{{ .Variation}};{{ .Value}};{{ .Default}};{{ .Source}}\n"
        },
    },
    // ...
}
err := ffclient.Init(config)
defer ffclient.Close()

Field name	Mandatory	Default	Description
OutputDir		none	OutputDir is the location of the directory to store the exported files.
FlushInterval		60000	The interval in millisecond between 2 calls to the webhook (if the maxEventInMemory is reached before the flushInterval we will call the exporter before).
MaxEventInMemory		100000	If we hit that limit we will call the exporter.
Format		JSON	Format is the output format you want in your exported file. Available format: JSON, CSV, Parquet.
Filename		flag-variation-{{ .Hostname}}-{{ .Timestamp}}.{{ .Format}}	You can use a config template to define the name of your exported files. Available replacements are {{ .Hostname}}, {{ .Timestamp}} and {{ .Format}
CsvTemplate		{{ .Kind}};{{ .ContextKind}};{{ .UserKey}};{{ .CreationDate}};{{ .Key}};{{ .Variation}};{{ .Value}};{{ .Default}};{{ .Source}}\n	CsvTemplate is used if your output format is CSV. This field will be ignored if you are using format other than CSV. You can decide which fields you want in your CSV line with a go-template syntax, please check exporter/feature_event.go to see what are the fields available.
Path		bucket root level	The location of the directory in S3.
ParquetCompressionCodec		SNAPPY	ParquetCompressionCodec is the parquet compression codec for better space efficiency. Available options