New Integration: Snowflake

.azure-pipelines/templates/test-all-checks.yml

@@ -358,6 +358,9 @@ jobs:
     - checkName: snmp
       displayName: SNMP
       os: linux
+    - checkName: snowflake
+      displayName: Snowflake
+      os: linux
     - checkName: solr
       displayName: Solr
       os: linux

.codecov.yml

@@ -427,6 +427,10 @@ coverage:
         target: 75
         flags:
         - scylla
+      Snowflake:
+        target: 75
+        flags:
+        - snowflake
       Spark:
         target: 75
         flags:
@@ -1041,6 +1045,11 @@ flags:
     paths:
     - snmp/datadog_checks/snmp
     - snmp/tests
+  snowflake:
+    carryforward: true
+    paths:
+    - snowflake/datadog_checks/snowflake
+    - snowflake/tests
   spark:
     carryforward: true
     paths:

datadog_checks_base/datadog_checks/base/data/agent_requirements.in

@@ -72,6 +72,7 @@ serpent==1.27; sys_platform == 'win32'
 service_identity[idna]==18.1.0
 simplejson==3.6.5
 six==1.14.0
+snowflake-connector-python==2.1.3
 supervisor==4.1.0
 tuf==0.12.2
 typing==3.7.4.1; python_version < '3.0'

snowflake/CHANGELOG.md

@@ -0,0 +1,2 @@
+# CHANGELOG - Snowflake
+

snowflake/MANIFEST.in

@@ -0,0 +1,10 @@
+graft datadog_checks
+graft tests
+
+include MANIFEST.in
+include README.md
+include requirements.in
+include requirements-dev.txt
+include manifest.json
+
+global-exclude *.py[cod] __pycache__

snowflake/README.md

@@ -0,0 +1,57 @@
+# Agent Check: Snowflake
+
+## Overview
+
+This check monitors [Snowflake][1] through the Datadog Agent. Snowflake is a SaaS-analytic data warehouse and runs completely on cloud infrastructure. 
+This integration monitors credit, billing, and storage usage, query history, and more.
+
+**NOTE**: Metrics are collected via queries to Snowflake. Queries from the integration are billable by Snowflake.
+
+## Setup
+
+Follow the instructions below to install and configure this check for an Agent running on a host.
+
+### Installation
+
+The Snowflake check is included in the [Datadog Agent][2] package.
+No additional installation is needed on your server.
+
+### Configuration
+
+1. Edit the `snowflake.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your snowflake performance data. See the [sample snowflake.d/conf.yaml][3] for all available configuration options.
+
+    **Note**: By default, this integration monitors the `SNOWFLAKE` database and `ACCOUNT_USAGE` schema.
+    This database is available by default and only viewable by users in the `ACCOUNTADMIN` role or [any role granted by the ACCOUNTADMIN][8].
+
+2. [Restart the Agent][4].
+
+### Validation
+
+[Run the Agent's status subcommand][5] and look for `snowflake` under the Checks section.
+
+## Data Collected
+
+### Metrics
+
+See [metadata.csv][6] for a list of metrics provided by this check.
+
+### Service Checks
+
+`snowflake.can_connect`: Returns `CRITICAL` if the Agent cannot authenticate and connect to Snowflake, `OK` otherwise.
+
+### Events
+
+Snowflake does not include any events.
+
+## Troubleshooting
+
+Need help? Contact [Datadog support][7].
+
+[1]: https://www.snowflake.com/
+[2]: https://docs.datadoghq.com/agent/kubernetes/integrations/
+[3]: https://github.com/DataDog/integrations-core/blob/master/snowflake/datadog_checks/snowflake/data/conf.yaml.example
+[4]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
+[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
+[6]: https://github.com/DataDog/integrations-core/blob/master/snowflake/metadata.csv
+[7]: https://docs.datadoghq.com/help/
+[8]: https://docs.snowflake.com/en/sql-reference/account-usage.html#enabling-account-usage-for-other-roles

snowflake/assets/configuration/spec.yaml

@@ -0,0 +1,119 @@
+name: Snowflake
+files:
+- name: snowflake.yaml
+  options:
+  - template: init_config
+    options:
+      - template: init_config/db
+      - template: init_config/default
+  - template: instances
+    options:
+      - name: account
+        required: true
+        description: |
+          Name of your account (provided by Snowflake), including the platform and region if applicable.
+          For more information on Snowflake account names,
+          see https://docs.snowflake.com/en/user-guide/connecting.html#your-snowflake-account-name
+        value:
+          type: string
+          example: <ACCOUNT>
+      - name: user
+        required: true
+        description: Login name for the user.
+        value:
+          type: string
+          example: <USER>
+      - name: password
+        required: true
+        description: Password for the user
+        value:
+          type: string
+          example: <PASSWORD>
+      - name: database
+        description: Name of the default database to use.
+        value:
+          type: string
+          example: SNOWFLAKE
+      - name: schema
+        description: Name of the default schema to use for the database.
+        value:
+          type: string
+          example: ACCOUNT_USAGE
+      - name: role
+        description: Name of the default role to use.
+        value:
+          type: string
+          example: ACCOUNTADMIN
+      - name: warehouse
+        description: Name of the default warehouse to use.
+        value:
+          type: string
+          example: <WAREHOUSE>
+      - name: client_prefetch_threads
+        description: |
+          The number of threads used to download the results sets. Increasing the value improves fetch
+          performance but requires more memory.
+        value:
+          type: integer
+          example: 4
+      - name: login_timeout
+        description: |
+          Timeout in seconds for login. The login request gives up after the timeout length if the HTTP response succeeds.
+        value:
+          type: integer
+          example: 60
+      - name: ocsp_response_cache_filename
+        description: |
+          Path for the OCSP response cache file. By default, the file is created in the cache directory:
+            Linux   - ~/.cache/snowflake/ocsp_response_cache
+            macOS   - ~/Library/Caches/Snowflake/ocsp_response_cache
+            Windows - %USERPROFILE%\AppData\Local\Snowflake\Caches\ocsp_response_cache
+        value:
+          type: string
+          example: <OCSP_RESPONSE_CACHE_FILENAME>
+      - name: metric_groups
+        description: |
+          List Snowflake metric groups to collect. Metric groups are determined by the metric prefixes.
+
+          The available metric groups are:
+
+            - snowflake.query
+            - snowflake.billing
+            - snowflake.storage
+            - snowflake.storage.database
+            - snowflake.storage.table
+            - snowflake.logins
+            - snowflake.data_transfer
+            - snowflake.auto_recluster
+            - snowflake.pipe
+            - snowflake.replication
+        value:
+          type: array
+          items:
+            type: string
+          example:
+            - snowflake.query
+            - snowflake.billing
+            - snowflake.storage
+            - snowflake.logins
+      - template: instances/db
+        overrides:
+          custom_queries.value.example:
+            - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
+              columns:
+                - name: foo
+                  type: tag
+                - name: event.total
+                  type: gauge
+              tags:
+                - test:snowflake
+      - template: instances/default
+        overrides:
+          min_collection_interval.description: |
+            This changes the collection interval of the check. For more information, see:
+            https://docs.datadoghq.com/developers/write_agent_check/#collection-interval
+
+            NOTE: Most Snowflake ACCOUNT_USAGE views are populated on an hourly basis,
+            so to minimize unnecessary queries the `min_collection_interval` defaults to 1 hour.
+          min_collection_interval.default: 3600
+          min_collection_interval.value.example: 3600

snowflake/assets/recommended_monitors/snowflake_failed_logins.json

@@ -0,0 +1,27 @@
+{
+	"name": "[Snowflake] Increased Failed Login Attempts",
+	"type": "metric alert",
+	"query": "sum(last_1d):avg:snowflake.logins.fail.count{*}.as_count() > 3",
+	"message": "There has been at least 3 failed login attempts in the past 24 hours. ",
+	"tags": [
+		"integration:snowflake"
+	],
+	"options": {
+		"notify_audit": false,
+		"locked": false,
+		"timeout_h": 0,
+		"new_host_delay": 300,
+		"require_full_window": true,
+		"notify_no_data": false,
+		"renotify_interval": "0",
+		"escalation_message": "",
+		"no_data_timeframe": null,
+		"include_tags": true,
+		"thresholds": {
+			"critical": 3
+		}
+	},
+	"recommended_monitor_metadata": {
+		"description": "Notify your team when there has been increased failed login attempts to your account."
+	}
+}

snowflake/assets/service_checks.json

@@ -0,0 +1,17 @@
+[
+    {
+        "agent_version": "7.23.0",
+        "integration": "Snowflake",
+        "groups": [
+            "host",
+            "endpoint"
+        ],
+        "check": "snowflake.can_connect",
+        "statuses": [
+            "ok",
+            "critical"
+        ],
+        "name": "Snowflake can connect",
+        "description": "Returns `CRITICAL` if the check cannot authenticate Snowflake credentials. Returns `OK` otherwise."
+    }
+]

snowflake/datadog_checks/__init__.py

@@ -0,0 +1,4 @@
+# (C) Datadog, Inc. 2020-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: ignore

snowflake/datadog_checks/snowflake/__about__.py

@@ -0,0 +1,4 @@
+# (C) Datadog, Inc. 2020-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+__version__ = '0.0.1'

snowflake/datadog_checks/snowflake/__init__.py

@@ -0,0 +1,7 @@
+# (C) Datadog, Inc. 2020-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .__about__ import __version__
+from .check import SnowflakeCheck
+
+__all__ = ['__version__', 'SnowflakeCheck']