fix(docs): correct snowflake receiver docs (open-telemetry#36294)

rnishtala-sumo · Dec 4, 2024 · 52f28f3 · 52f28f3
1 parent 8e92d28
commit 52f28f3
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 38 deletions.
diff --git a/receiver/snowflakereceiver/README.md b/receiver/snowflakereceiver/README.md
@@ -38,11 +38,11 @@ receivers:
     password: securepassword
     account: bigbusinessaccount
     warehouse: metricWarehouse
-    collection_interval: 18m
+    collection_interval: 5m
     metrics:
       snowflake.database.bytes_scanned.avg:
         enabled: true
-      snowflake.database.bytes_deketed.avg:
+      snowflake.query.bytes_deleted.avg:
         enabled: false
 ```
 

diff --git a/receiver/snowflakereceiver/documentation.md b/receiver/snowflakereceiver/documentation.md
@@ -26,7 +26,7 @@ Average bytes scanned in a database over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -46,7 +46,7 @@ Total query count for database over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -80,7 +80,7 @@ Average bytes deleted in database over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -100,7 +100,7 @@ Average bytes written by database over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -120,7 +120,7 @@ Average time taken to compile query over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -154,7 +154,7 @@ Average time spent executing queries in database over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -202,7 +202,7 @@ Average time spent in warehouse queue due to warehouse being overloaded over the
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -222,7 +222,7 @@ Average time spent in warehouse queue waiting for resources to provision over th
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -242,7 +242,7 @@ Average time spent in warehouse queue waiting for compute resources to be repair
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -278,7 +278,7 @@ Average elapsed time over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -306,7 +306,7 @@ Reported total credits used in the cloud service over the last 24 hour window.
 
 | Name | Description | Values |
 | ---- | ----------- | ------ |
-| service_type | Service type associateed with metric query | Any Str |
+| service_type | Service type associateed with metric query. | Any Str |
 
 ### snowflake.billing.total_credit.total
 
@@ -320,7 +320,7 @@ Reported total credits used across account over the last 24 hour window.
 
 | Name | Description | Values |
 | ---- | ----------- | ------ |
-| service_type | Service type associateed with metric query | Any Str |
+| service_type | Service type associateed with metric query. | Any Str |
 
 ### snowflake.billing.virtual_warehouse.total
 
@@ -334,7 +334,7 @@ Reported total credits used by virtual warehouse service over the last 24 hour w
 
 | Name | Description | Values |
 | ---- | ----------- | ------ |
-| service_type | Service type associateed with metric query | Any Str |
+| service_type | Service type associateed with metric query. | Any Str |
 
 ### snowflake.billing.warehouse.cloud_service.total
 
@@ -390,8 +390,8 @@ Total login attempts for account over the last 24 hour window.
 
 | Name | Description | Values |
 | ---- | ----------- | ------ |
-| error_message | Error message reported by query if present | Any Str |
-| reported_client_type | Client type used for attempt | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
+| reported_client_type | Client type used for attempt. | Any Str |
 | is_success | Login status (success or failure). | Any Str |
 
 ### snowflake.pipe.credits_used.total
@@ -410,7 +410,7 @@ Snow pipe credits contotaled over the last 24 hour window.
 
 ### snowflake.query.bytes_spilled.local.avg
 
-Avergae bytes spilled (intermediate results do not fit in memory) by local storage over the last 24 hour window.
+Average bytes spilled (intermediate results do not fit in memory) by local storage over the last 24 hour window.
 
 | Unit | Metric Type | Value Type |
 | ---- | ----------- | ---------- |
@@ -422,15 +422,15 @@ Avergae bytes spilled (intermediate results do not fit in memory) by local stora
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
 | warehouse_size | Size of warehouse being reported on. | Any Str |
 
 ### snowflake.query.bytes_spilled.remote.avg
 
-Avergae bytes spilled (intermediate results do not fit in memory) by remote storage over the last 24 hour window.
+Average bytes spilled (intermediate results do not fit in memory) by remote storage over the last 24 hour window.
 
 | Unit | Metric Type | Value Type |
 | ---- | ----------- | ---------- |
@@ -442,7 +442,7 @@ Avergae bytes spilled (intermediate results do not fit in memory) by remote stor
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -462,7 +462,7 @@ Average percentage of data scanned from cache over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -482,7 +482,7 @@ Number of partitions scanned during query so far over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -502,7 +502,7 @@ Number of rows deleted from a table (or tables) over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -522,7 +522,7 @@ Number of rows inserted into a table (or tables) over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -542,7 +542,7 @@ Average number of rows produced by statement over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -562,7 +562,7 @@ Average number of rows unloaded during data export over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |
@@ -582,7 +582,7 @@ Average number of rows updated in a table over the last 24 hour window.
 | ---- | ----------- | ------ |
 | schema_name | Name of schema associated with query result. | Any Str |
 | execution_status | Execution status of query being reported. | Any Str |
-| error_message | Error message reported by query if present | Any Str |
+| error_message | Error message reported by query if present. | Any Str |
 | query_type | Type of query performed. | Any Str |
 | warehouse_name | Name of warehouse in query being reported on. | Any Str |
 | database_name | Name of database being queried (default is snowflake). | Any Str |

diff --git a/receiver/snowflakereceiver/internal/metadata/generated_metrics.go b/receiver/snowflakereceiver/internal/metadata/generated_metrics.go
diff --git a/receiver/snowflakereceiver/internal/metadata/generated_metrics_test.go b/receiver/snowflakereceiver/internal/metadata/generated_metrics_test.go
diff --git a/receiver/snowflakereceiver/metadata.yaml b/receiver/snowflakereceiver/metadata.yaml
@@ -17,13 +17,13 @@ resource_attributes:
 
 attributes:
   service_type:
-    description: Service type associateed with metric query
+    description: Service type associateed with metric query.
     type: string
   error_message:
-    description: Error message reported by query if present
+    description: Error message reported by query if present.
     type: string 
   reported_client_type:
-    description: Client type used for attempt
+    description: Client type used for attempt.
     type: string
   is_success:
     description: Login status (success or failure).
@@ -164,14 +164,14 @@ metrics:
     enabled: true
     attributes: [schema_name, execution_status, error_message, query_type, warehouse_name, database_name, warehouse_size]
   snowflake.query.bytes_spilled.local.avg:
-    description: Avergae bytes spilled (intermediate results do not fit in memory) by local storage over the last 24 hour window.
+    description: Average bytes spilled (intermediate results do not fit in memory) by local storage over the last 24 hour window.
     unit: By 
     gauge:
       value_type: double
     enabled: false 
     attributes: [schema_name, execution_status, error_message, query_type, warehouse_name, database_name, warehouse_size]
   snowflake.query.bytes_spilled.remote.avg:
-    description: Avergae bytes spilled (intermediate results do not fit in memory) by remote storage over the last 24 hour window.
+    description: Average bytes spilled (intermediate results do not fit in memory) by remote storage over the last 24 hour window.
     unit: By
     gauge:
       value_type: double
@@ -320,4 +320,4 @@ tests:
     ignore:
       any:
         # Regarding the godbus/dbus ignore: see https://github.com/99designs/keyring/issues/103
-        - "github.com/godbus/dbus.(*Conn).inWorker"
+        - "github.com/godbus/dbus.(*Conn).inWorker"