Add the Teleport Integration

teleport/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG - Teleport
+
+## 1.0.0 / 2024-02-07
+
+***Added***:
+
+* Initial Release

teleport/README.md

@@ -0,0 +1,55 @@
+# Agent Check: Teleport
+
+## Overview
+
+This check monitors [Teleport][1] through the Datadog Agent.
+
+## Setup
+
+Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying these instructions.
+
+### Installation
+
+The Teleport check is included in the [Datadog Agent][2] package.
+No additional installation is needed on your server.
+
+### Configuration
+
+1. Edit the `teleport.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your teleport performance data. See the [sample teleport.d/conf.yaml][4] for all available configuration options.
+
+2. [Restart the Agent][5].
+
+### Validation
+
+[Run the Agent's status subcommand][6] and look for `teleport` under the Checks section.
+
+## Data Collected
+
+### Metrics
+
+See [metadata.csv][7] for a list of metrics provided by this integration.
+
+### Events
+
+The Teleport integration does not include any events.
+
+### Service Checks
+
+The Teleport integration does not include any service checks.
+
+See [service_checks.json][8] for a list of service checks provided by this integration.
+
+## Troubleshooting
+
+Need help? Contact [Datadog support][9].
+
+
+[1]: **LINK_TO_INTEGRATION_SITE**
+[2]: https://app.datadoghq.com/account/settings/agent/latest
+[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/
+[4]: https://github.com/DataDog/integrations-core/blob/master/teleport/datadog_checks/teleport/data/conf.yaml.example
+[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
+[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
+[7]: https://github.com/DataDog/integrations-core/blob/master/teleport/metadata.csv
+[8]: https://github.com/DataDog/integrations-core/blob/master/teleport/assets/service_checks.json
+[9]: https://docs.datadoghq.com/help/

teleport/assets/configuration/spec.yaml

@@ -0,0 +1,10 @@
+name: Teleport
+files:
+- name: teleport.yaml
+  options:
+  - template: init_config
+    options:
+    - template: init_config/default
+  - template: instances
+    options:
+    - template: instances/default

teleport/assets/service_checks.json

@@ -0,0 +1 @@
+[]

teleport/datadog_checks/__init__.py

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

teleport/datadog_checks/teleport/__about__.py

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

teleport/datadog_checks/teleport/__init__.py

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

teleport/datadog_checks/teleport/check.py

@@ -0,0 +1,44 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+from datadog_checks.base import OpenMetricsBaseCheckV2
+
+COMMON_METRICS_MAP = {
+    'process_state': 'process.state',
+    'certificate_mismatch': 'certificate_mismatch',
+    'rx': 'rx',
+    'server_interactive_sessions_total': 'server_interactive_sessions_total',
+    'teleport_build_info': 'teleport.build_info',
+    'teleport_cache_events': 'teleport.cache_events',
+    'teleport_cache_stale_events': 'teleport.cache_stale_events',
+    'tx': 'tx',
+}
+
+METRIC_MAP = {
+    **COMMON_METRICS_MAP
+}
+class TeleportCheck(OpenMetricsBaseCheckV2):
+    __NAMESPACE__ = 'teleport'
+
+    def __init__(self, name, init_config, instances):
+        super().__init__(name, init_config, instances)
+        self.check_initializations.appendleft(self._parse_config)
+
+    def check(self, _):
+        try:
+            super().check(_)
+            response = self.http.get(self.diagnostic_url + "/healthz")
+            response.raise_for_status()
+            self.service_check("health.up", self.OK)
+        except Exception as e:
+            self.service_check("health.up", self.CRITICAL, message=str(e))
+        finally:
+            pass
+
+    def _parse_config(self):
+        self.diagnostic_url = self.instance.get("diagnostic_url")
+        if self.diagnostic_url:
+            self.instance.setdefault("openmetrics_endpoint", self.diagnostic_url + "/metrics")
+            self.instance.setdefault("metrics", [METRIC_MAP])
+            self.instance.setdefault("rename_labels", {'version': "teleport_version"})

teleport/datadog_checks/teleport/config_models/__init__.py

@@ -0,0 +1,25 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+# This file is autogenerated.
+# To change this file you should edit assets/configuration/spec.yaml and then run the following commands:
+#     ddev -x validate config -s <INTEGRATION_NAME>
+#     ddev -x validate models -s <INTEGRATION_NAME>
+
+
+from .instance import InstanceConfig
+from .shared import SharedConfig
+
+
+class ConfigMixin:
+    _config_model_instance: InstanceConfig
+    _config_model_shared: SharedConfig
+
+    @property
+    def config(self) -> InstanceConfig:
+        return self._config_model_instance
+
+    @property
+    def shared_config(self) -> SharedConfig:
+        return self._config_model_shared

teleport/datadog_checks/teleport/config_models/defaults.py

@@ -0,0 +1,16 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+# This file is autogenerated.
+# To change this file you should edit assets/configuration/spec.yaml and then run the following commands:
+#     ddev -x validate config -s <INTEGRATION_NAME>
+#     ddev -x validate models -s <INTEGRATION_NAME>
+
+
+def instance_empty_default_hostname():
+    return False
+
+
+def instance_min_collection_interval():
+    return 15

teleport/datadog_checks/teleport/config_models/instance.py

@@ -0,0 +1,51 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+# This file is autogenerated.
+# To change this file you should edit assets/configuration/spec.yaml and then run the following commands:
+#     ddev -x validate config -s <INTEGRATION_NAME>
+#     ddev -x validate models -s <INTEGRATION_NAME>
+
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, field_validator, model_validator
+
+from datadog_checks.base.utils.functions import identity
+from datadog_checks.base.utils.models import validation
+
+from . import defaults, validators
+
+
+class InstanceConfig(BaseModel):
+    model_config = ConfigDict(
+        validate_default=True,
+        arbitrary_types_allowed=True,
+        frozen=True,
+    )
+    empty_default_hostname: Optional[bool] = None
+    min_collection_interval: Optional[float] = None
+    service: Optional[str] = None
+    tags: Optional[tuple[str, ...]] = None
+
+    @model_validator(mode='before')
+    def _initial_validation(cls, values):
+        return validation.core.initialize_config(getattr(validators, 'initialize_instance', identity)(values))
+
+    @field_validator('*', mode='before')
+    def _validate(cls, value, info):
+        field = cls.model_fields[info.field_name]
+        field_name = field.alias or info.field_name
+        if field_name in info.context['configured_fields']:
+            value = getattr(validators, f'instance_{info.field_name}', identity)(value, field=field)
+        else:
+            value = getattr(defaults, f'instance_{info.field_name}', lambda: value)()
+
+        return validation.utils.make_immutable(value)
+
+    @model_validator(mode='after')
+    def _final_validation(cls, model):
+        return validation.core.check_model(getattr(validators, 'check_instance', identity)(model))

teleport/datadog_checks/teleport/config_models/shared.py

@@ -0,0 +1,48 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+# This file is autogenerated.
+# To change this file you should edit assets/configuration/spec.yaml and then run the following commands:
+#     ddev -x validate config -s <INTEGRATION_NAME>
+#     ddev -x validate models -s <INTEGRATION_NAME>
+
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, field_validator, model_validator
+
+from datadog_checks.base.utils.functions import identity
+from datadog_checks.base.utils.models import validation
+
+from . import defaults, validators
+
+
+class SharedConfig(BaseModel):
+    model_config = ConfigDict(
+        validate_default=True,
+        arbitrary_types_allowed=True,
+        frozen=True,
+    )
+    service: Optional[str] = None
+
+    @model_validator(mode='before')
+    def _initial_validation(cls, values):
+        return validation.core.initialize_config(getattr(validators, 'initialize_shared', identity)(values))
+
+    @field_validator('*', mode='before')
+    def _validate(cls, value, info):
+        field = cls.model_fields[info.field_name]
+        field_name = field.alias or info.field_name
+        if field_name in info.context['configured_fields']:
+            value = getattr(validators, f'shared_{info.field_name}', identity)(value, field=field)
+        else:
+            value = getattr(defaults, f'shared_{info.field_name}', lambda: value)()
+
+        return validation.utils.make_immutable(value)
+
+    @model_validator(mode='after')
+    def _final_validation(cls, model):
+        return validation.core.check_model(getattr(validators, 'check_shared', identity)(model))

teleport/datadog_checks/teleport/config_models/validators.py

@@ -0,0 +1,13 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+# Here you can include additional config validators or transformers
+#
+# def initialize_instance(values, **kwargs):
+#     if 'my_option' not in values and 'my_legacy_option' in values:
+#         values['my_option'] = values['my_legacy_option']
+#     if values.get('my_number') > 10:
+#         raise ValueError('my_number max value is 10, got %s' % str(values.get('my_number')))
+#
+#     return values

teleport/datadog_checks/teleport/data/conf.yaml.example

@@ -0,0 +1,44 @@
+## All options defined here are available to all instances.
+#
+init_config:
+
+    ## @param service - string - optional
+    ## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.
+    ##
+    ## Additionally, this sets the default `service` for every log source.
+    #
+    # service: <SERVICE>
+
+## Every instance is scheduled independently of the others.
+#
+instances:
+
+  -
+    ## @param tags - list of strings - optional
+    ## A list of tags to attach to every metric and service check emitted by this instance.
+    ##
+    ## Learn more about tagging at https://docs.datadoghq.com/tagging
+    #
+    # tags:
+    #   - <KEY_1>:<VALUE_1>
+    #   - <KEY_2>:<VALUE_2>
+
+    ## @param service - string - optional
+    ## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.
+    ##
+    ## Overrides any `service` defined in the `init_config` section.
+    #
+    # service: <SERVICE>
+
+    ## @param min_collection_interval - number - optional - default: 15
+    ## This changes the collection interval of the check. For more information, see:
+    ## https://docs.datadoghq.com/developers/write_agent_check/#collection-interval
+    #
+    # min_collection_interval: 15
+
+    ## @param empty_default_hostname - boolean - optional - default: false
+    ## This forces the check to send metrics with no hostname.
+    ##
+    ## This is useful for cluster-level checks.
+    #
+    # empty_default_hostname: false

teleport/hatch.toml

@@ -0,0 +1,4 @@
+[env.collectors.datadog-checks]
+
+[[envs.default.matrix]]
+python = ["3.11"]

teleport/images/IMAGES_README.md

@@ -0,0 +1,46 @@
+# Marketplace Media Carousel Guidelines
+
+## Using the media gallery
+
+To use the media gallery, you must upload a minimum of one image. The gallery
+can hold a maximum of 8 pieces of media total, and one of these pieces of media
+can be a video (guidelines and submission steps below). Images should be
+added to your /images directory and referenced in the manifest.json file.
+
+
+## Image and video requirements
+
+### Images
+
+```
+File type       : .jpg or .png
+File size       : ~500 KB per image, with a max of 1 MB per image
+File dimensions : The aspect ratio must be 16:9 minimum, with these constraints:
+
+                    Width: 1440px
+                    Min height: 810px
+                    Max height: 2560px
+
+File name       : Use only letters, numbers, underscores, and hyphens
+Color mode      : RGB
+Color profile   : sRGB
+Description     : 300 characters maximum
+```
+
+### Video
+
+To display a video in your media gallery, please send our team the zipped file
+or a link to download the video at `marketplace@datadog.com`. In addition,
+please upload a thumbnail image for your video as a part of the pull request.
+Once approved, we will upload the file to Vimeo and provide you with the
+vimeo_id to add to your manifest.json file.  Please note that the gallery can
+only hold one video.
+
+```
+File type       : MP4 H.264
+File size       : Max 1 video; 1 GB maximum size
+File dimensions : The aspect ratio must be exactly 16:9, and the resolution must be 1920x1080 or higher
+File name       : partnerName-appName.mp4
+Run time        : Recommendation of 60 seconds or less
+Description     : 300 characters maximum
+```