Scylla new integration

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

@@ -302,6 +302,9 @@ jobs:
     - checkName: sap_hana
       displayName: SAP HANA
       os: linux
+    - checkName: scylla
+      displayName: Scylla
+      os: linux
     - checkName: snmp
       displayName: SNMP
       os: linux

scylla/CHANGELOG.md

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

scylla/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__

scylla/README.md

@@ -0,0 +1,53 @@
+# Agent Check: Scylla
+
+## Overview
+
+This check monitors [Scylla][1] through the Datadog Agent.
+
+Scylla is an open-source NoSQL data store that can act as "a drop-in Apache Cassandra alternative." It has rearchitected the Cassandra model tuned for modern hardware, reducing the size of required clusters while improving theoretical throughput and performance.
+
+This integration collects a majority of the exposed metrics by default, with the ability to customize additional groups based on specific user needs.
+
+## Setup
+
+Follow the instructions below to install and configure this check for an Agent running on a host.
+
+### Installation
+
+The Scylla check is included in the [Datadog Agent][2] package. No additional installation is needed on your server.
+
+### Configuration
+
+1. Edit the `scylla.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your scylla performance data. See the [sample scylla.d/conf.yaml][3] for all available configuration options.
+
+2. [Restart the Agent][4].
+
+### Validation
+
+[Run the Agent's status subcommand][5] and look for `scylla` under the Checks section.
+
+## Data Collected
+
+### Metrics
+
+See [metadata.csv][6] for a list of metrics provided by this check.
+
+### Service Checks
+
+`scylla.prometheus.health`: Returns `CRITICAL` if the Agent cannot reach the metrics endpoints, `OK` otherwise.
+
+### Events
+
+Scylla does not include any events.
+
+## Troubleshooting
+
+Need help? Contact [Datadog support][7].
+
+[1]: https://scylla.io
+[2]: https://docs.datadoghq.com/agent
+[3]: https://github.com/DataDog/integrations-core/blob/master/scylla/datadog_checks/scylla/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/scylla/metadata.csv
+[7]: https://docs.datadoghq.com/help

scylla/assets/service_checks.json

@@ -0,0 +1,17 @@
+[
+    {
+        "agent_version": "6.18.0",
+        "integration": "Scylla",
+        "groups": [
+            "host",
+            "endpoint"
+        ],
+        "check": "scylla.prometheus.health",
+        "statuses": [
+            "ok",
+            "critical"
+        ],
+        "name": "Scylla prometheus health",
+        "description": "Returns `CRITICAL` if the check cannot access the metrics endpoint. Returns `OK` otherwise."
+    }
+]

scylla/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__)

scylla/datadog_checks/scylla/__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'

scylla/datadog_checks/scylla/__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 .scylla import ScyllaCheck
+
+__all__ = ['__version__', 'ScyllaCheck']

scylla/datadog_checks/scylla/data/conf.yaml.example

@@ -0,0 +1,149 @@
+init_config:
+
+instances:
+
+    ## @param prometheus_url - string - required
+    ## The URL where your database metrics are exposed by Prometheus.
+    #
+  - prometheus_url: http://localhost:9180/metrics
+
+    ## @param metric_groups - list of strings - optional
+    ## List of additional scylla metric groups to collect in addition to the default
+    #
+    # metric_groups:
+    #   - scylla.alien
+    #   - scylla.batchlog
+    #   - scylla.commitlog
+    #   - scylla.compaction
+    #   - scylla.cql
+    #   - scylla.database
+    #   - scylla.execution
+    #   - scylla.hints
+    #   - scylla.httpd
+    #   - scylla.io
+    #   - scylla.lsa
+    #   - scylla.memory
+    #   - scylla.memtables
+    #   - scylla.query
+    #   - scylla.scheduler
+    #   - scylla.sstables
+    #   - scylla.thrift
+    #   - scylla.tracing
+
+    ## @param tags - list of key:value elements - optional
+    ## List of tags to attach to every metrics, events and service checks emitted by this integration.
+    ## Learn more about tagging: https://docs.datadoghq.com/tagging/
+    #
+    # tags:
+    #   - <KEY_1>:<VALUE_1>
+    #   - <KEY_2>:<VALUE_2>
+
+    ## @param timeout - integer - optional - default: 10
+    ## Overrides the default timeout value in second
+    #
+    # timeout: 10
+
+    ## @param health_service_check - boolean - optional - default: true
+    ## Send a service check reporting about the health of the prometheus endpoint
+    ## It's named scylla.prometheus.health
+    #
+    # health_service_check: true
+
+    ## @param label_to_hostname - string - optional
+    ## Override the hostname with the value of one label.
+    #
+    # label_to_hostname: <LABEL>
+
+    ## @param label_joins - object - optional
+    ## The label join allows to target a metric and retrieve it's label via a 1:1 mapping
+    #
+    # label_joins:
+    #   target_metric:
+    #     label_to_match: <MATCHED_LABEL>
+    #     labels_to_get:
+    #       - <EXTRA_LABEL_1>
+    #       - <EXTRA_LABEL_2>
+
+    ## @param labels_mapper - list of key:value elements - optional
+    ## The label mapper allows you to rename labels.
+    ## Format is <LABEL_TO_RENAME>: <NEW_LABEL_NAME>
+    #
+    # labels_mapper:
+    #   flavor: origin
+
+    ## @param type_overrides - list of key:value elements - optional
+    ## Type override allows you to override a type in the prometheus payload
+    ## or type an untyped metrics (they're ignored by default)
+    ## Supported <METRIC_TYPE> are `gauge`, `counter`, `histogram`, `summary`
+    #
+    # type_overrides:
+    #   <METRIC_NAME>: <METRIC_TYPE>
+
+    ## @param send_histograms_buckets - boolean - optional - default: true
+    ## Set send_histograms_buckets to true to send the histograms bucket.
+    #
+    # send_histograms_buckets: true
+
+    ## @param send_distribution_buckets - boolean - optional - default: false
+    ## Set `send_distribution_buckets` to `true` to send histograms as Datadog distribution metrics.
+    ##
+    ## Learn more about distribution metrics: https://docs.datadoghq.com/developers/metrics/distributions/
+    #
+    # send_distribution_buckets: false
+
+    ## @param send_monotonic_counter - boolean - optional - default: true
+    ## Set send_monotonic_counter to true to send counters as monotonic counter.
+    #
+    # send_monotonic_counter: true
+
+    ## @param send_distribution_counts_as_monotonic - boolean - optional - default: false
+    ## Set send_distribution_counts_as_monotonic to true to send histograms & summary
+    ## counters as monotonic counters (instead of gauges).
+    #
+    # send_distribution_counts_as_monotonic: false
+
+    ## @param exclude_labels - list of strings - optional
+    ## List of label to be excluded
+    #
+    # exclude_labels:
+    #   - timestamp
+
+    ## @param tls_verify - boolean - optional - default: true
+    ## Instructs the check to validate the TLS certificate of services.
+    #
+    # tls_verify: true
+
+    ## @param tls_ignore_warning - boolean - optional - default: false
+    ## If `tls_verify` is disabled, security warnings are logged by the check.
+    ## Disable those by setting `tls_ignore_warning` to true.
+    #
+    # tls_ignore_warning: false
+
+    ## @param tls_cert - string - optional
+    ## The path to a single file in PEM format containing a certificate as well as any
+    ## number of CA certificates needed to establish the certificate's authenticity for
+    ## use when connecting to services. It may also contain an unencrypted private key to use.
+    #
+    # tls_cert: <CERT_PATH>
+
+    ## @param tls_private_key - string - optional
+    ## The unencrypted private key to use for `tls_cert` when connecting to services. This is
+    ## required if `tls_cert` is set and it does not already contain a private key.
+    #
+    # tls_private_key: <PRIVATE_KEY_PATH>
+
+    ## @param tls_ca_cert - string - optional
+    ## The path to a file of concatenated CA certificates in PEM format or a directory
+    ## containing several CA certificates in PEM format. If a directory, the directory
+    ## must have been processed using the c_rehash utility supplied with OpenSSL. See:
+    ## https://www.openssl.org/docs/manmaster/man3/SSL_CTX_load_verify_locations.html
+    #
+    # tls_ca_cert: <CA_CERT_PATH>
+
+    ## @param extra_headers - list of key:value elements - optional
+    ## A list of additional HTTP headers to send in queries to the openmetrics endpoint.
+    ## Can be combined with autodiscovery template variables. Eg: "Authorization: Bearer %%env_TOKEN%%".
+    ## Note: if the "Authorization" header is present it will be replaced when "bearer_token_auth" is enabled.
+    #
+    # extra_headers:
+    #   <HEADER_NAME>: <HEADER_VALUE>