Initial release

Signed-off-by: Sylvain Hellegouarch <sh@defuze.org>

Author: Lawouach

.github/workflows/build.yaml

@@ -8,11 +8,11 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '3.7'
       - name: Install dependencies
@@ -22,11 +22,11 @@ jobs:
         run : |
           make build
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '3.7'
       - name: Install dependencies
@@ -36,14 +36,14 @@ jobs:
         run: |
           make lint
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         python-version: [3.7, 3.8, 3.9, "3.10"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.github/workflows/release.yaml

@@ -3,7 +3,7 @@ name: Release
 on:
   pull_request:
     branches-ignore:
-      - 'master'
+      - 'main'
   push:
     tags:
       - '[0-9]+.[0-9]+.[0-9]+'
@@ -12,11 +12,11 @@ on:
 jobs:
   release-to-pypi:
     needs: [check-release]
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: '3.7'
     - name: Install dependencies
@@ -25,7 +25,7 @@ jobs:
         pip install -U setuptools wheel twine
     - name: Build and publish
       env:
-        TWINE_USERNAME: chaostoolkit
+        TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.PYPI_PWD }}
       run: |
         python3 setup.py release

CHANGELOG.md

@@ -2,24 +2,12 @@
 
 ## [Unreleased][]
 
-[Unreleased]: https://github.com/chaostoolkit/chaostoolkit-extension-template/compare/0.1.0...HEAD
-
-## [0.2.0][]
-
-[0.2.0]: https://github.com/chaostoolkit/chaostoolkit-extension-template/compare/0.1.0...0.2.0
-
-### Changed
-
--   Switched to github actions
--   Updated dependencies
--   Added black and isort for linting
+[Unreleased]: https://github.com/chaostoolkit-incubator/chaostoolkit-datadog/compare/0.1.0...HEAD
 
 ## [0.1.0][]
 
-[0.1.0]: https://github.com/chaostoolkit/chaostoolkit-extension-template/tree/0.1.0
+[0.1.0]: https://github.com/chaostoolkit-incubator/chaostoolkit-datadog/tree/0.1.0
 
 ### Added
 
 -   Initial release
--   Added Travis CI
--   Added empty example tests for probes and actions

Makefile

@@ -14,14 +14,14 @@ build:
 
 .PHONY: lint
 lint:
-	flake8 chaosext/ tests/
-	isort --check-only --profile black chaosext/ tests/
-	black --check --diff --line-length=80 chaosext/ tests/
+	flake8 chaosdatadog/ tests/
+	isort --check-only --profile black chaosdatadog/ tests/
+	black --check --diff --line-length=80 chaosdatadog/ tests/
 
 .PHONY: format
 format:
-	isort --profile black chaosext/ tests/
-	black --line-length=80 chaosext/ tests/
+	isort --profile black chaosdatadog/ tests/
+	black --line-length=80 chaosdatadog/ tests/
 
 .PHONY: tests
 tests:

README.md

@@ -1,14 +1,13 @@
 # Chaos Toolkit Extension Template
 
-[![Version](https://img.shields.io/pypi/v/chaostoolkit-my-extension.svg)](https://img.shields.io/pypi/v/chaostoolkit-lib.svg)
-[![License](https://img.shields.io/pypi/l/chaostoolkit-my-extension.svg)](https://img.shields.io/pypi/l/chaostoolkit-lib.svg)
+[![Version](https://img.shields.io/pypi/v/chaostoolkit-datadog.svg)](https://img.shields.io/pypi/v/chaostoolkit-datadog.svg)
+[![License](https://img.shields.io/pypi/l/chaostoolkit-datadog.svg)](https://img.shields.io/pypi/l/chaostoolkit-datadog.svg)
 
-![Build](https://github.com/chaostoolkit/chaostoolkit-lib/workflows/Build/badge.svg)
-[![codecov](https://codecov.io/gh/chaostoolkit/chaostoolkit-my-extension/branch/master/graph/badge.svg)](https://codecov.io/gh/chaostoolkit/chaostoolkit-lib)
-[![Python versions](https://img.shields.io/pypi/pyversions/chaostoolkit-my-extension.svg)](https://www.python.org/)
+![Build](https://github.com/chaostoolkit-incubator/chaostoolkit-datadog/workflows/Build/badge.svg)
+[![Python versions](https://img.shields.io/pypi/pyversions/chaostoolkit-datadog.svg)](https://www.python.org/)
 
-This project should be used as a starting point to create your own
-Chaos Toolkit extension.
+This project contains Chaos Toolkit activities and tolerances to work
+with DataDog.
 
 ## Install
 
@@ -20,20 +19,74 @@ environment where [chaostoolkit][] already lives.
 [chaostoolkit]: https://github.com/chaostoolkit/chaostoolkit
 
 ```
-$ pip install chaostoolkit-<your extension name here>
+$ pip install chaostoolkit-datadog
 ```
 
 ## Usage
 
-<Explain your probes and actions usage from the experiment.json here>
+A typical experiment using this extension would look like this:
+
+```json
+{
+    "version": "1.0.0",
+    "title": "Run a, experiment using a DataDog SLO to verify our system",
+    "description": "n/a",
+    "configuration": {
+        "datadog_host": "https://datadoghq.eu"
+    },
+    "steady-state-hypothesis": {
+        "title": "n/a",
+        "probes": [
+            {
+                "type": "probe",
+                "name": "read-slo",
+                "tolerance": {
+                    "type": "probe",
+                    "name": "check-slo",
+                    "provider": {
+                        "type": "python",
+                        "module": "chaosdatadog.slo.tolerances",
+                        "func": "slo_must_be_met",
+                        "arguments": {
+                            "threshold": "7d"
+                        }
+                    }
+                },
+                "provider": {
+                    "type": "python",
+                    "module": "chaosdatadog.slo.probes",
+                    "func": "get_slo",
+                    "arguments": {
+                        "slo_id": "..."
+                    }
+                }
+            }
+        ]
+    },
+    "method": []
+}
+```
 
 That's it!
 
 Please explore the code to see existing probes and actions.
 
 ## Configuration
 
-<Specify any extra configuration your extension relies on here>
+In the `configuration` block you may want to specify the DataDog host you are
+targetting:
+
+```json
+    "configuration": {
+        "datadog_host": "https://datadoghq.eu"
+    },
+```
+
+The authentication can be set using the typical DataDog environment variables,
+notably:
+
+* `DD_API_KEY`: the API key
+* `DD_APP_KEY`: the application key
 
 ## Test
 

chaosdatadog/__init__.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+import warnings
+from contextlib import contextmanager
+from typing import Generator, List
+
+from chaoslib.discovery.discover import (
+    discover_probes,
+    initialize_discovery_result,
+)
+from chaoslib.types import (
+    Configuration,
+    DiscoveredActivities,
+    Discovery,
+    Secrets,
+)
+from datadog_api_client import ApiClient
+from datadog_api_client import Configuration as DDCfg
+from logzero import logger
+
+warnings.filterwarnings("ignore", message="Using unstable operation")
+__version__ = "0.1.0"
+
+
+@contextmanager
+def get_client(
+    configuration: Configuration = None, secrets: Secrets = None, **kwargs
+) -> Generator[ApiClient, None, None]:
+    configuration = configuration or {}
+    secrets = secrets or {}
+
+    dd_host = configuration.get("datadog_host", "https://api.datadoghq.com")
+    api_key = secrets.get("api_key")
+    app_key = secrets.get("app_key")
+
+    keys = None
+    if api_key or app_key:
+        keys = {"apiKeyAuth": api_key, "appKeyAuth": app_key}
+
+    c = DDCfg(api_key=keys, host=dd_host)
+    with ApiClient(c) as api:
+        yield api
+
+
+def discover(discover_system: bool = True) -> Discovery:
+    """
+    Discover DataDog capabilities from this extension.
+    """
+    logger.info("Discovering capabilities from chaostoolkit-datadog")
+
+    discovery = initialize_discovery_result(
+        "chaostoolkit-datadog", __version__, "datadog"
+    )
+    discovery["activities"].extend(load_exported_activities())
+
+    return discovery
+
+
+###############################################################################
+# Private functions
+###############################################################################
+def load_exported_activities() -> List[DiscoveredActivities]:
+    """
+    Extract metadata from actions, probes and tolerances
+    exposed by this extension.
+    """
+    activities = []  # type: ignore
+
+    activities.extend(discover_probes("chaosdatadog.slo.probes"))
+
+    return activities

chaosdatadog/slo/__init__.py

@@ -0,0 +1,71 @@
+from typing import Any, Dict
+
+import arrow
+from chaoslib.types import Configuration, Secrets
+from datadog_api_client.v1.api.service_level_objectives_api import (
+    ServiceLevelObjectivesApi,
+)
+from logzero import logger
+
+from chaosdatadog import get_client
+
+__all__ = ["get_slo", "get_slo_details"]
+
+
+def get_slo_details(
+    slo_id: str, configuration: Configuration = None, secrets: Secrets = None
+) -> Dict[str, Any]:
+    """
+    Get a SLO's details.
+
+    Please visit https://docs.datadoghq.com/api/latest/service-level-objectives/#get-an-slos-details
+    for more information on the response payload, which is returned as a
+    dictionary.
+    """  # noqa: E501
+    with get_client(configuration, secrets) as c:
+        api = ServiceLevelObjectivesApi(c)
+        response = api.get_slo(slo_id=slo_id)
+
+        return response.to_dict()
+
+
+def get_slo(
+    slo_id: str,
+    start_period: str = "2 minutes ago",
+    end_period: str = None,
+    configuration: Configuration = None,
+    secrets: Secrets = None,
+) -> Dict[str, Any]:
+    """
+    Get a SLO's history for the given period.
+
+    Periods should be given relative to each other. If `end_period` isn't
+    provided it will resolve to now (UTC). `start_period` is always relative
+    to `end_period`. You can use a format such as: `"X minutes ago"` for both.
+
+    Please visit https://docs.datadoghq.com/api/latest/service-level-objectives/#get-an-slos-history
+    for more information on the response payload, which is returned as a
+    dictionary.
+    """  # noqa: E501
+    with get_client(configuration, secrets) as c:
+        c.configuration.unstable_operations["get_slo_history"] = True
+        api = ServiceLevelObjectivesApi(c)
+
+        now = arrow.utcnow()
+        if not end_period:
+            end = now
+        else:
+            end = now.dehumanize(end_period)
+
+        if not start_period:
+            start = now
+        else:
+            start = end.dehumanize(start_period)
+
+        response = api.get_slo_history(
+            slo_id=slo_id, from_ts=start.int_timestamp, to_ts=now.int_timestamp
+        )
+
+        slo = response.to_dict()
+        logger.debug(f"SLO history is: {slo}")
+        return slo