chore(greptimedb_metrics sink): fix greptimedb examples (#21984)

* docs: fix greptimedb example * ci: add greptimedb sinks to semantic ci * fix: remove examples for bool field
vectordotdev · Dec 12, 2024 · 70837f3 · 70837f3
1 parent 18de1ea
commit 70837f3
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 8 deletions.
diff --git a/.github/workflows/semantic.yml b/.github/workflows/semantic.yml
@@ -207,6 +207,8 @@ jobs:
             gcp_pubsub sink
             gcp_stackdriver_logs sink
             gcp_stackdriver_metrics sink
+            greptimedb_metrics sink
+            greptimedb_logs sink
             honeycomb sink
             http sink
             humio_logs sink

diff --git a/src/sinks/greptimedb/metrics/config.rs b/src/sinks/greptimedb/metrics/config.rs
@@ -70,9 +70,6 @@ pub struct GreptimeDBMetricsConfig {
     ///
     /// The address _must_ include a port.
     #[configurable(metadata(docs::examples = "example.com:4001"))]
-    #[configurable(metadata(
-        docs::examples = "1nge17d2r3ns.ap-southeast-1.aws.greptime.cloud:4001"
-    ))]
     pub endpoint: String,
     /// The username for your GreptimeDB instance.
     ///
@@ -88,7 +85,7 @@ pub struct GreptimeDBMetricsConfig {
     pub password: Option<SensitiveString>,
     /// Set gRPC compression encoding for the request
     /// Default to none, `gzip` or `zstd` is supported.
-    #[configurable(metadata(docs::examples = "grpc_compression"))]
+    #[configurable(metadata(docs::examples = "gzip"))]
     #[serde(default)]
     pub grpc_compression: Option<String>,
 

diff --git a/website/cue/reference/components/sinks/base/greptimedb.cue b/website/cue/reference/components/sinks/base/greptimedb.cue
@@ -89,15 +89,17 @@ base: components: sinks: greptimedb: configuration: {
 			The address _must_ include a port.
 			"""
 		required: true
-		type: string: examples: ["example.com:4001", "1nge17d2r3ns.ap-southeast-1.aws.greptime.cloud:4001"]
+		type: string: examples: ["example.com:4001"]
 	}
 	grpc_compression: {
 		description: """
 			Set gRPC compression encoding for the request
 			Default to none, `gzip` or `zstd` is supported.
 			"""
 		required: false
-		type: string: examples: ["grpc_compression"]
+		type: string: examples: [
+			"gzip",
+		]
 	}
 	new_naming: {
 		description: """

diff --git a/website/cue/reference/components/sinks/base/greptimedb_metrics.cue b/website/cue/reference/components/sinks/base/greptimedb_metrics.cue
@@ -89,15 +89,17 @@ base: components: sinks: greptimedb_metrics: configuration: {
 			The address _must_ include a port.
 			"""
 		required: true
-		type: string: examples: ["example.com:4001", "1nge17d2r3ns.ap-southeast-1.aws.greptime.cloud:4001"]
+		type: string: examples: ["example.com:4001"]
 	}
 	grpc_compression: {
 		description: """
 			Set gRPC compression encoding for the request
 			Default to none, `gzip` or `zstd` is supported.
 			"""
 		required: false
-		type: string: examples: ["grpc_compression"]
+		type: string: examples: [
+			"gzip",
+		]
 	}
 	new_naming: {
 		description: """