Merge pull request #23 from naver/add-filename_encoding

add an option to encode file name
naver · Dec 12, 2024 · 4fd1759 · 4fd1759
2 parents de0af31 + 7b981a1
commit 4fd1759
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 3 deletions.
diff --git a/deploy/templates/operator/manifests/crd.yaml b/deploy/templates/operator/manifests/crd.yaml
@@ -159,6 +159,10 @@ spec:
                             time-based layout
                           type: string
                       type: object
+                    shouldEncodeFileName:
+                      description: Provide an option to convert '+' to '%2B' to address
+                        issues in certain web environments where '+' is misinterpreted
+                      type: boolean
                   type: object
                 type: array
               logMetricRules:

diff --git a/pkg/docs/operator/docs.go b/pkg/docs/operator/docs.go
@@ -327,6 +327,10 @@ const docTemplate = `{
                             "$ref": "#/definitions/v1.S3Bucket"
                         }
                     ]
+                },
+                "shouldEncodeFileName": {
+                    "description": "Provide an option to convert '+' to '%2B' to address issues in certain web environments where '+' is misinterpreted",
+                    "type": "boolean"
                 }
             }
         },

diff --git a/pkg/docs/operator/swagger.json b/pkg/docs/operator/swagger.json
@@ -319,6 +319,10 @@
                             "$ref": "#/definitions/v1.S3Bucket"
                         }
                     ]
+                },
+                "shouldEncodeFileName": {
+                    "description": "Provide an option to convert '+' to '%2B' to address issues in certain web environments where '+' is misinterpreted",
+                    "type": "boolean"
                 }
             }
         },

diff --git a/pkg/docs/operator/swagger.yaml b/pkg/docs/operator/swagger.yaml
@@ -81,6 +81,10 @@ definitions:
         allOf:
         - $ref: '#/definitions/v1.S3Bucket'
         description: Settings required to export logs to S3 bucket
+      shouldEncodeFileName:
+        description: Provide an option to convert '+' to '%2B' to address issues in
+          certain web environments where '+' is misinterpreted
+        type: boolean
     type: object
   v1.LogMetricRule:
     properties:

diff --git a/pkg/lobster/sink/exporter/bucket/basic.go b/pkg/lobster/sink/exporter/bucket/basic.go
@@ -26,6 +26,7 @@ import (
 	"net/http"
 	"net/url"
 	"path"
+	"strings"
 	"time"
 
 	"github.com/golang/glog"
@@ -90,7 +91,13 @@ func (b BasicBucket) Dir(chunk model.Chunk, date time.Time) string {
 }
 
 func (b BasicBucket) FileName(start, end time.Time) string {
-	return fmt.Sprintf("%s_%s.log", start.Format(layoutFileName), end.Format(layoutFileName))
+	fileName := fmt.Sprintf("%s_%s.log", start.Format(layoutFileName), end.Format(layoutFileName))
+
+	if b.Order.LogExportRule.ShouldEncodeFileName {
+		return strings.ReplaceAll(fileName, "+", "%2B")
+	}
+
+	return fileName
 }
 
 func (b BasicBucket) Validate() error {

diff --git a/pkg/lobster/sink/exporter/bucket/s3.go b/pkg/lobster/sink/exporter/bucket/s3.go
@@ -20,6 +20,7 @@ import (
 	"bytes"
 	"fmt"
 	"path"
+	"strings"
 	"time"
 
 	"github.com/aws/aws-sdk-go/aws"
@@ -75,8 +76,14 @@ func (s S3Bucket) Dir(chunk model.Chunk, date time.Time) string {
 		dirPath)
 }
 
-func (s S3Bucket) FileName(start, end time.Time) string {
-	return fmt.Sprintf("%s_%s.log", start.Format(layoutFileName), end.Format(layoutFileName))
+func (b S3Bucket) FileName(start, end time.Time) string {
+	fileName := fmt.Sprintf("%s_%s.log", start.Format(layoutFileName), end.Format(layoutFileName))
+
+	if b.Order.LogExportRule.ShouldEncodeFileName {
+		return strings.ReplaceAll(fileName, "+", "%2B")
+	}
+
+	return fileName
 }
 
 func (s S3Bucket) Validate() error {

diff --git a/pkg/operator/api/v1/logExportRule.go b/pkg/operator/api/v1/logExportRule.go
@@ -41,6 +41,8 @@ type LogExportRule struct {
 	Filter Filter `json:"filter,omitempty"`
 	// Interval to export logs
 	Interval metav1.Duration `json:"interval,omitempty" swaggertype:"string" example:"time duration(e.g. 1m)"`
+	// Provide an option to convert '+' to '%2B' to address issues in certain web environments where '+' is misinterpreted
+	ShouldEncodeFileName bool `json:"shouldEncodeFileName,omitempty"`
 }
 
 func (r LogExportRule) Validate() error {

diff --git a/web/static/docs/operator/swagger.json b/web/static/docs/operator/swagger.json
@@ -319,6 +319,10 @@
                             "$ref": "#/definitions/v1.S3Bucket"
                         }
                     ]
+                },
+                "shouldEncodeFileName": {
+                    "description": "Provide an option to convert '+' to '%2B' to address issues in certain web environments where '+' is misinterpreted",
+                    "type": "boolean"
                 }
             }
         },