feat: add common point option (#18)

Author: coanor

diskcache/diskcache.go

@@ -104,12 +104,14 @@ func (c *DiskCache) String() string {
 	c.rwlock.Lock()
 	defer c.rwlock.Unlock()
 
+	// nolint: lll
 	// if there too many files(>10), only print file count
 	if n := len(c.dataFiles); n > 10 {
 		return fmt.Sprintf("%s/[size: %d][fallback: %v][nosync: %v][nopos: %v][nolock: %v][files: %d][maxDataSize: %d][batchSize: %d][capacity: %d][dataFiles: %d]",
 			c.path, c.size, c.noFallbackOnError, c.noSync, c.noPos, c.noLock, len(c.dataFiles), c.maxDataSize, c.batchSize, c.capacity, n,
 		)
 	} else {
+		// nolint: lll
 		return fmt.Sprintf("%s/[size: %d][fallback: %v][nosync: %v][nopos: %v][nolock: %v][files: %d][maxDataSize: %d][batchSize: %d][capacity: %d][dataFiles: %v]",
 			c.path, c.size, c.noFallbackOnError, c.noSync, c.noLock, c.noPos, len(c.dataFiles), c.maxDataSize, c.batchSize, c.capacity, c.dataFiles,
 		)

point/category_test.go

@@ -25,14 +25,14 @@ func TestURL(t *testing.T) {
 		{c: "/v1/write/rum", expect: RUM},
 		{c: "/v1/write/security", expect: Security},
 		{c: "/v1/write/profiling", expect: Profiling},
-		{c: "/v1/write/event", expect: KeyEvent},
+		{c: "/v1/write/keyevent", expect: KeyEvent},
 		{c: "/v1/write/tracing", expect: Tracing},
 		{c: "/v1/write/dynamic_dw", expect: DynamicDWCategory},
 	}
 
 	for _, tc := range cases {
 		t.Run(tc.c, func(t *testing.T) {
-			assert.Equal(t, tc.expect, CatURL(tc.c))
+			assert.Equal(t, tc.expect.String(), CatURL(tc.c).String())
 		})
 	}
 }
@@ -76,7 +76,7 @@ func TestString(t *testing.T) {
 		{c: "rum", expect: RUM},
 		{c: "security", expect: Security},
 		{c: "profiling", expect: Profiling},
-		{c: "event", expect: KeyEvent},
+		{c: "keyevent", expect: KeyEvent},
 		{c: "tracing", expect: Tracing},
 		{c: "dynamic_dw", expect: DynamicDWCategory},
 	}

point/encode.go

@@ -13,6 +13,19 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
+type Encoding int
+
+func EncodingStr(s string) Encoding {
+	switch s {
+	case "protobuf":
+		return Protobuf
+	case "lineproto", "lineprotocol":
+		return LineProtocol
+	default:
+		return LineProtocol
+	}
+}
+
 // EncodeFn used to iterate on []*Point payload, if error returned, the iterate terminated.
 type EncodeFn func(batchSize int, payload []byte) error
 

point/option.go

@@ -10,19 +10,6 @@ import (
 	"time"
 )
 
-type Encoding int
-
-func EncodingStr(s string) Encoding {
-	switch s {
-	case "protobuf":
-		return Protobuf
-	case "lineproto", "lineprotocol":
-		return LineProtocol
-	default:
-		return LineProtocol
-	}
-}
-
 const (
 	LineProtocol Encoding = iota
 	Protobuf
@@ -176,6 +163,7 @@ func WithRequiredKeys(keys ...*Key) Option {
 	}
 }
 
+// DefaultObjectOptions defined options on Object/CustomObject point.
 func DefaultObjectOptions() []Option {
 	return []Option{
 		WithDisabledKeys(disabledKeys[Object]...),
@@ -185,15 +173,16 @@ func DefaultObjectOptions() []Option {
 	}
 }
 
+// DefaultLoggingOptions defined options on Logging point.
 func DefaultLoggingOptions() []Option {
-	return []Option{
+	return append(CommonLoggingOptions(), []Option{
 		WithDisabledKeys(disabledKeys[Logging]...),
 		WithMaxFieldValLen(defaultMaxFieldValLen),
-		WithDotInKey(false),
 		WithRequiredKeys(requiredKeys[Logging]...),
-	}
+	}...)
 }
 
+// DefaultMetricOptions defined options on Metric point.
 func DefaultMetricOptions() []Option {
 	return []Option{
 		WithStrField(false),
@@ -208,3 +197,10 @@ func DefaultMetricOptionsForInflux1X() []Option {
 		WithU64Field(false),
 	}
 }
+
+// CommonLoggingOptions defined options on RUM/Tracing/Security/Event/Profile/Network point.
+func CommonLoggingOptions() []Option {
+	return []Option{
+		WithDotInKey(false),
+	}
+}