logging: support UploadPeriodMinutes and CompressionFormat parameters

Updates tailscale/corp#26860

Signed-off-by: Percy Wegmann <[email protected]>

Author: oxtoacart

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
           echo "module=$(go env GOMODCACHE)" | tee -a $GITHUB_OUTPUT
 
       - name: Set up cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ${{ steps.cache.outputs.build }}

logging.go

@@ -28,6 +28,12 @@ const (
 	LogTypeNetwork LogType = "network"
 )
 
+const (
+	CompressionFormatNone CompressionFormat = "none"
+	CompressionFormatZstd CompressionFormat = "zstd"
+	CompressionFormatGzip CompressionFormat = "gzip"
+)
+
 const (
 	S3AccessKeyAuthentication S3AuthenticationType = "accesskey"
 	S3RoleARNAuthentication   S3AuthenticationType = "rolearn"
@@ -39,6 +45,8 @@ type LogstreamConfiguration struct {
 	DestinationType      LogstreamEndpointType `json:"destinationType,omitempty"`
 	URL                  string                `json:"url,omitempty"`
 	User                 string                `json:"user,omitempty"`
+	UploadPeriodMinutes  int                   `json:"uploadPeriodMinutes,omitempty"`
+	CompressionFormat    CompressionFormat     `json:"compressionFormat,omitempty"`
 	S3Bucket             string                `json:"s3Bucket,omitempty"`
 	S3Region             string                `json:"s3Region,omitempty"`
 	S3KeyPrefix          string                `json:"s3KeyPrefix,omitempty"`
@@ -54,6 +62,8 @@ type SetLogstreamConfigurationRequest struct {
 	URL                  string                `json:"url,omitempty"`
 	User                 string                `json:"user,omitempty"`
 	Token                string                `json:"token,omitempty"`
+	UploadPeriodMinutes  int                   `json:"uploadPeriodMinutes,omitempty"`
+	CompressionFormat    CompressionFormat     `json:"compressionFormat,omitempty"`
 	S3Bucket             string                `json:"s3Bucket,omitempty"`
 	S3Region             string                `json:"s3Region,omitempty"`
 	S3KeyPrefix          string                `json:"s3KeyPrefix,omitempty"`
@@ -70,6 +80,9 @@ type LogstreamEndpointType string
 // LogType describes the type of logging.
 type LogType string
 
+// CompressionFormat specifies what kind of compression to use on logs.
+type CompressionFormat string
+
 // S3AuthenticationType describes the type of authentication used to stream logs to a LogstreamS3Endpoint.
 type S3AuthenticationType string
 

logging_test.go

@@ -18,14 +18,27 @@ func TestClient_LogstreamConfiguration(t *testing.T) {
 	client, server := NewTestHarness(t)
 	server.ResponseCode = http.StatusOK
 
-	expectedLogstream := &LogstreamConfiguration{}
+	expectedLogstream := &LogstreamConfiguration{
+		DestinationType:      LogstreamCriblEndpoint,
+		URL:                  "http://example.com",
+		User:                 "my-user",
+		UploadPeriodMinutes:  5,
+		CompressionFormat:    CompressionFormatZstd,
+		S3Bucket:             "my-bucket",
+		S3Region:             "us-west-2",
+		S3KeyPrefix:          "logs/",
+		S3AuthenticationType: S3AccessKeyAuthentication,
+		S3AccessKeyID:        "my-access-key-id",
+		S3RoleARN:            "my-role-arn",
+		S3ExternalID:         "my-external-id",
+	}
 	server.ResponseBody = expectedLogstream
 
-	actualWebhook, err := client.Logging().LogstreamConfiguration(context.Background(), LogTypeConfig)
+	actualLogstream, err := client.Logging().LogstreamConfiguration(context.Background(), LogTypeConfig)
 	assert.NoError(t, err)
 	assert.Equal(t, http.MethodGet, server.Method)
 	assert.Equal(t, "/api/v2/tailnet/example.com/logging/configuration/stream", server.Path)
-	assert.Equal(t, expectedLogstream, actualWebhook)
+	assert.Equal(t, expectedLogstream, actualLogstream)
 }
 
 func TestClient_SetLogstreamConfiguration(t *testing.T) {
@@ -39,6 +52,8 @@ func TestClient_SetLogstreamConfiguration(t *testing.T) {
 		URL:                  "http://example.com",
 		User:                 "my-user",
 		Token:                "my-token",
+		UploadPeriodMinutes:  5,
+		CompressionFormat:    CompressionFormatZstd,
 		S3Bucket:             "my-bucket",
 		S3Region:             "us-west-2",
 		S3KeyPrefix:          "logs/",