Skip to content

Commit

Permalink
Add kepler integration (#2519)
Browse files Browse the repository at this point in the history
* Add kepler integration scaffolding

* validate ci

* sync config and models

* Add kepler codeowners

* Add description

* update manifest

* lint

* add e2e test

* skip e2e for now

* remove dash

* update metrics types

* Add dashboard

* Add full test and metadata

* Add metric to check

* Add service check and update readme

* update readme

* fix service check

* update readme

* Update kepler/README.md

Co-authored-by: Esther Kim <esther.kim@datadoghq.com>

* Fix link

---------

Co-authored-by: Esther Kim <esther.kim@datadoghq.com>
  • Loading branch information
sarah-witt and estherk15 authored Nov 20, 2024
1 parent 565fdce commit 86d5636
Show file tree
Hide file tree
Showing 30 changed files with 2,228 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ coverage:
target: 75
flags:
- jfrog_platform_self_hosted
Kepler:
target: 75
flags:
- kepler
Kernelcare:
target: 75
flags:
Expand Down Expand Up @@ -428,6 +432,11 @@ flags:
paths:
- jfrog_platform_self_hosted/datadog_checks/jfrog_platform_self_hosted
- jfrog_platform_self_hosted/tests
kepler:
carryforward: true
paths:
- kepler/datadog_checks/kepler
- kepler/tests
kernelcare:
carryforward: true
paths:
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
/kameleoon/ @slava-inyu product@kameleoon.com @DataDog/ecosystems-review
/kernelcare/ @grubberr schvaliuk@cloudlinux.com
/keep/ @talboren tal@keephq.dev @DataDog/documentation
/kepler/ @sarah-witt
/komodor/ @komodorio/sales-engineers @DataDog/ecosystems-review
/launchdarkly/ support@launchdarkly.com @DataDog/ecosystems-review
/lacework/ @DataDog/agent-integrations
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/test-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,25 @@ jobs:
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
j43aee0d:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@master
with:
job-name: Kepler
target: kepler
platform: linux
runner: '["ubuntu-22.04"]'
repo: "${{ inputs.repo }}"
python-version: "${{ inputs.python-version }}"
standard: ${{ inputs.standard }}
latest: ${{ inputs.latest }}
agent-image: "${{ inputs.agent-image }}"
agent-image-py2: "${{ inputs.agent-image-py2 }}"
agent-image-windows: "${{ inputs.agent-image-windows }}"
agent-image-windows-py2: "${{ inputs.agent-image-windows-py2 }}"
test-py2: ${{ inputs.test-py2 }}
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
ja3e78b9:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@master
with:
Expand Down
8 changes: 8 additions & 0 deletions kepler/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# CHANGELOG - Kepler

## 1.0.0 / 2024-05-21

***Added***:

* Initial Release

59 changes: 59 additions & 0 deletions kepler/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Agent Check: Kepler

## Overview

This check brings Kuberenetes workloads energy usage estimates from [Kepler][1] into Datadog.

## Setup

### Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Kepler check on your host. See [Use Community Integrations][3] to install with the Docker Agent or earlier versions of the Agent.

1. Run the following command to install the integration:

```shell
datadog-agent integration install -t datadog-kepler==<INTEGRATION_VERSION>
```

2. Configure your integration similar to core [integrations][4].

### Configuration


1. Edit the `kepler.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your kepler performance data. See the [sample kepler.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 `kepler` under the Checks section.

## Data Collected

### Metrics

Kepler does not include any metrics.

### Service Checks

See [service_checks.json][8] for a list of service checks provided by this integration.

### Events

Kepler does not include any events.

## Troubleshooting

Need help? Contact [Datadog support][3].

[1]: https://sustainable-computing.io/
[2]: https://app.datadoghq.com/account/settings/agent/latest
[3]: https://docs.datadoghq.com/agent/guide/use-community-integrations/?tab=agentv721v621
[4]: https://github.com/DataDog/integrations-extras/blob/master/kepler/datadog_checks/kepler/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-extras/blob/master/kepler/metadata.csv
[8]: https://github.com/DataDog/integrations-extras/blob/master/kepler/assets/service_checks.json
[9]: https://docs.datadoghq.com/help/

12 changes: 12 additions & 0 deletions kepler/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Kepler
files:
- name: kepler.yaml
options:
- template: init_config
options:
- template: init_config/default
template: init_config/openmetrics
- template: instances
options:
- template: instances/default
template: instances/openmetrics
Loading

0 comments on commit 86d5636

Please sign in to comment.