Adding connector metadata to useragent. (#348)

ClickHouse · Aug 4, 2024 · 6dd82f1 · 6dd82f1
1 parent 5779763
commit 6dd82f1
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/clickhouse-core/src/main/scala/com/clickhouse/spark/client/NodeClient.scala b/clickhouse-core/src/main/scala/com/clickhouse/spark/client/NodeClient.scala
@@ -40,6 +40,20 @@ object NodeClient {
 
 class NodeClient(val nodeSpec: NodeSpec) extends AutoCloseable with Logging {
 
+  private lazy val userAgent = {
+    val title = getClass.getPackage.getImplementationTitle
+    val version = getClass.getPackage.getImplementationVersion
+    if (version != null) {
+      val versions = version.split("_")
+      val sparkVersion = versions(0)
+      val scalaVersion = versions(1)
+      val connectorVersion = versions(2)
+      s"${title}/${connectorVersion} (fv:spark/${sparkVersion}, lv:scala/${scalaVersion})"
+    } else {
+      "Spark-ClickHouse-Connector"
+    }
+  }
+
   private val node: ClickHouseNode = ClickHouseNode.builder()
     .options(nodeSpec.options)
     .host(nodeSpec.host)
@@ -50,6 +64,10 @@ class NodeClient(val nodeSpec: NodeSpec) extends AutoCloseable with Logging {
 
   private val client: ClickHouseClient = ClickHouseClient.builder()
     .option(ClickHouseClientOption.FORMAT, ClickHouseFormat.RowBinary)
+    .option(
+      ClickHouseClientOption.PRODUCT_NAME,
+      userAgent
+    )
     .nodeSelector(ClickHouseNodeSelector.of(node.getProtocol))
     .build()
 

diff --git a/spark-3.3/build.gradle b/spark-3.3/build.gradle
@@ -58,6 +58,12 @@ project(":clickhouse-spark-runtime-${spark_binary_version}_$scala_binary_version
 
     jar {
         archiveClassifier="empty"
+        manifest {
+            attributes(
+                    'Implementation-Title': 'Spark-ClickHosue-Connnector',
+                    'Implementation-Version': "${spark_binary_version}_${scala_binary_version}_${getProjectVersion()}"
+            )
+        }
     }
 }
 

diff --git a/spark-3.4/build.gradle b/spark-3.4/build.gradle
@@ -58,6 +58,12 @@ project(":clickhouse-spark-runtime-${spark_binary_version}_$scala_binary_version
 
     jar {
         archiveClassifier="empty"
+        manifest {
+            attributes(
+                    'Implementation-Title': 'Spark-ClickHosue-Connnector',
+                    'Implementation-Version': "${spark_binary_version}_${scala_binary_version}_${getProjectVersion()}"
+            )
+        }
     }
 }
 

diff --git a/spark-3.5/build.gradle b/spark-3.5/build.gradle
@@ -17,6 +17,7 @@ project.ext {
     spark_binary_version = "3.5"
 }
 
+
 project(":clickhouse-spark-${spark_binary_version}_$scala_binary_version") {
     dependencies {
         api project(":clickhouse-core")
@@ -58,6 +59,12 @@ project(":clickhouse-spark-runtime-${spark_binary_version}_$scala_binary_version
 
     jar {
         archiveClassifier="empty"
+        manifest {
+            attributes(
+                    'Implementation-Title': 'Spark-ClickHouse-Connector',
+                    'Implementation-Version': "${spark_binary_version}_${scala_binary_version}_${getProjectVersion()}"
+            )
+        }
     }
 }