Skip to content

Commit

Permalink
fix(docs): correct snowflake receiver docs
Browse files Browse the repository at this point in the history
  • Loading branch information
smantri-moveworks committed Nov 11, 2024
1 parent 33a5457 commit 2114b3e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
4 changes: 2 additions & 2 deletions receiver/snowflakereceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
48 changes: 24 additions & 24 deletions receiver/snowflakereceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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 |
Expand Down Expand Up @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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 | . | 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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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 |
| ---- | ----------- | ---------- |
Expand All @@ -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 |
| ---- | ----------- | ---------- |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand All @@ -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 |
Expand Down

0 comments on commit 2114b3e

Please sign in to comment.