Skip to content

Commit c718d15

Browse files
authored
Initial commit for KrakenD scaffolding (#20422)
* Initial commit for KrakenD scaffolding * Add process signatures
1 parent e83973e commit c718d15

24 files changed

+557
-0
lines changed

.codecov.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,10 @@ coverage:
334334
target: 75
335335
flags:
336336
- kong
337+
KrakenD:
338+
target: 75
339+
flags:
340+
- krakend
337341
KubeVirt_API:
338342
target: 75
339343
flags:
@@ -1218,6 +1222,11 @@ flags:
12181222
paths:
12191223
- kong/datadog_checks/kong
12201224
- kong/tests
1225+
krakend:
1226+
carryforward: true
1227+
paths:
1228+
- krakend/datadog_checks/krakend
1229+
- krakend/tests
12211230
kube_apiserver_metrics:
12221231
carryforward: true
12231232
paths:

.github/workflows/config/labeler.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,8 @@ integration/klaviyo:
347347
- klaviyo/**/*
348348
integration/kong:
349349
- kong/**/*
350+
integration/krakend:
351+
- krakend/**/*
350352
integration/kube_apiserver_metrics:
351353
- kube_apiserver_metrics/**/*
352354
integration/kube_controller_manager:

.github/workflows/test-all.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2094,6 +2094,26 @@ jobs:
20942094
minimum-base-package: ${{ inputs.minimum-base-package }}
20952095
pytest-args: ${{ inputs.pytest-args }}
20962096
secrets: inherit
2097+
ja001417:
2098+
uses: ./.github/workflows/test-target.yml
2099+
with:
2100+
job-name: KrakenD
2101+
target: krakend
2102+
platform: linux
2103+
runner: '["ubuntu-22.04"]'
2104+
repo: "${{ inputs.repo }}"
2105+
python-version: "${{ inputs.python-version }}"
2106+
standard: ${{ inputs.standard }}
2107+
latest: ${{ inputs.latest }}
2108+
agent-image: "${{ inputs.agent-image }}"
2109+
agent-image-py2: "${{ inputs.agent-image-py2 }}"
2110+
agent-image-windows: "${{ inputs.agent-image-windows }}"
2111+
agent-image-windows-py2: "${{ inputs.agent-image-windows-py2 }}"
2112+
test-py2: ${{ inputs.test-py2 }}
2113+
test-py3: ${{ inputs.test-py3 }}
2114+
minimum-base-package: ${{ inputs.minimum-base-package }}
2115+
pytest-args: ${{ inputs.pytest-args }}
2116+
secrets: inherit
20972117
j92491f1:
20982118
uses: ./.github/workflows/test-target.yml
20992119
with:

krakend/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CHANGELOG - KrakenD
2+
3+
<!-- towncrier release notes start -->
4+

krakend/README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Agent Check: KrakenD
2+
3+
## Overview
4+
5+
This check monitors [KrakenD][1] through the Datadog Agent.
6+
7+
Include a high level overview of what this integration does:
8+
- What does your product do (in 1-2 sentences)?
9+
- What value will customers get from this integration, and why is it valuable to them?
10+
- What specific data will your integration monitor, and what's the value of that data?
11+
12+
## Setup
13+
14+
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.
15+
16+
### Installation
17+
18+
The KrakenD check is included in the [Datadog Agent][2] package.
19+
No additional installation is needed on your server.
20+
21+
### Configuration
22+
23+
1. Edit the `krakend.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your krakend performance data. See the [sample krakend.d/conf.yaml][4] for all available configuration options.
24+
25+
2. [Restart the Agent][5].
26+
27+
### Validation
28+
29+
[Run the Agent's status subcommand][6] and look for `krakend` under the Checks section.
30+
31+
## Data Collected
32+
33+
### Metrics
34+
35+
See [metadata.csv][7] for a list of metrics provided by this integration.
36+
37+
### Events
38+
39+
The KrakenD integration does not include any events.
40+
41+
### Service Checks
42+
43+
The KrakenD integration does not include any service checks.
44+
45+
See [service_checks.json][8] for a list of service checks provided by this integration.
46+
47+
## Troubleshooting
48+
49+
Need help? Contact [Datadog support][9].
50+
51+
52+
[1]: **LINK_TO_INTEGRATION_SITE**
53+
[2]: https://app.datadoghq.com/account/settings/agent/latest
54+
[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/
55+
[4]: https://github.com/DataDog/integrations-core/blob/master/krakend/datadog_checks/krakend/data/conf.yaml.example
56+
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
57+
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
58+
[7]: https://github.com/DataDog/integrations-core/blob/master/krakend/metadata.csv
59+
[8]: https://github.com/DataDog/integrations-core/blob/master/krakend/assets/service_checks.json
60+
[9]: https://docs.datadoghq.com/help/
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Please build an out-of-the-box dashboard for your integration following our best practices here: https://datadoghq.dev/integrations-core/guidelines/dashboards/#best-practices

krakend/assets/service_checks.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[]

krakend/datadog_checks/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# (C) Datadog, Inc. 2025-present
2+
# All rights reserved
3+
# Licensed under a 3-clause BSD style license (see LICENSE)
4+
__path__ = __import__('pkgutil').extend_path(__path__, __name__) # type: ignore
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# (C) Datadog, Inc. 2025-present
2+
# All rights reserved
3+
# Licensed under a 3-clause BSD style license (see LICENSE)
4+
__version__ = '0.0.1'
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# (C) Datadog, Inc. 2025-present
2+
# All rights reserved
3+
# Licensed under a 3-clause BSD style license (see LICENSE)
4+
from .__about__ import __version__
5+
from .check import KrakendCheck
6+
7+
__all__ = ['__version__', 'KrakendCheck']

0 commit comments

Comments
 (0)