Skip to content

Commit 42c2d67

Browse files
[ECOINT-40] Add Gravitee integration (#2695)
* Add Gravitee integration * Update Gravitee APIM integration * Update Gravitee APIM integration * Update Gravitee APIM integration * Update Gravitee APIM integration * Update Gravitee APIM integration * fix logs * manually fix identation * copy from `checks` tab with indentations * Update Gravitee APIM integration * Update Gravitee APIM integration * fix logs * Update Gravitee APIM integration * fix logs * Update Gravitee APIM integration * fix log * Update Gravitee APIM integration * fix logs * add codeowners --------- Co-authored-by: dd-pub-platform[bot] <157534740+dd-pub-platform[bot]@users.noreply.github.com> Co-authored-by: David Feng <david.feng@datadoghq.com>
1 parent 7753445 commit 42c2d67

12 files changed

Lines changed: 2075 additions & 0 deletions

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1159,6 +1159,7 @@
11591159
/hawkeye_by_neubird/ @DataDog/ecosystems-review
11601160
/zilliz_cloud_zilliz_cloud/ @DataDog/ecosystems-review
11611161
/appomni/ @DataDog/ecosystems-review
1162+
/gravitee/ @DataDog/ecosystems-review
11621163
/gatling_enterprise/ @DataDog/ecosystems-review
11631164

11641165
/downdetector/ @DataDog/ecosystems-review

gravitee/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CHANGELOG - Gravitee APIM
2+
3+
## 1.0.0 / 2025-07-19
4+
5+
_**Added**_:
6+
7+
* Initial Release

gravitee/README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Gravitee APIM
2+
3+
## Overview
4+
5+
Gravitee APIM is an enterprise-class agentic AI, API, and event stream management platform. It enables you to manage event streams and agentic AI as securely and easily as traditional APIs, bringing all your APIs together in a unified, full lifecycle management solution.
6+
7+
This integration allows you to monitor API and event stream performance, connection details, and API Gateway metrics, providing insights into the health and behavior of your Gravitee infrastructure. You can track top APIs, request and response times, content sizes, latency, slow performing APIs, gateway performance metrics, logs, and more.
8+
9+
This integration includes a pre-built Datadog dashboard to support comprehensive monitoring and observability of Gravitee APIM.
10+
11+
## Setup
12+
13+
### Download and install
14+
15+
1. Download the Datadog Reporter plugin [here][1].
16+
2. Add the downloaded ZIP file to your [Gateway(s)][2] `{GRAVITEE_HOME}/plugins` folder.
17+
3. Or, if you are installing the Gravitee Gateway via Helm, add the following entry in the `additionalPlugins` section (changing the version as needed):
18+
```yaml
19+
gateway:
20+
additionalPlugins:
21+
- https://download.gravitee.io/graviteeio-ee/apim/plugins/reporters/gravitee-reporter-datadog/gravitee-reporter-datadog-5.0.0.zip
22+
```
23+
4. Create a [Datadog API Key][3]. You will need this when _configuring_ the Reporter in Gravitee.
24+
25+
> **Note**: As with other reporter plugins, the Datadog Reporter plugin only needs to be installed on the Gateway container, not the Management API container.
26+
27+
> **Note**: If you want to collect system metrics and logs from the Management API service, use the [Datadog Agent][4] to tail the Management API logs, or collect them from stdout.
28+
29+
### Configuration
30+
31+
1. To configure the Datadog Reporter plugin on the Gateway, enable the `reporters` section in your Gravitee `values.yaml` file. See the example below:
32+
33+
```yaml
34+
reporters:
35+
datadog:
36+
enabled: true
37+
site: "datadoghq.eu"
38+
authentication:
39+
#apiKeyPrefix: ""
40+
apiKey: "YOUR_API_KEY"
41+
#appKey: "YOUR_APP_KEY"
42+
#tokenScheme: ""
43+
#token: "YOUR_TOKEN"
44+
#username: "YOUR_USERNAME"
45+
#password: "YOUR_PASSWORD"
46+
```
47+
> **Note**: You can obscure the value of this API key by using [configuration-level secrets][5] in your Gravitee `values.yaml` file.
48+
49+
### Data Type Mapping
50+
51+
Gravitee has different types of reporting data, and each type maps to a different resource type in Datadog. The mapping is as follows:
52+
53+
| Gravitee Convention | Examples | Datadog Convention |
54+
| ---------------------------------------- | ----------------------------- | ------------------ |
55+
| Metadata | API name, user agent | Tags |
56+
| Monitoring | CPU, memory usage | Metrics |
57+
| EndpointStatus | Health check status | Events |
58+
| [Metrics][6] | Response time, content length | Metrics |
59+
| [Logs][7] | Request body, response body | Log |
60+
61+
## Uninstallation
62+
63+
### In Gravitee
64+
65+
1. To delete the Reporter, delete the `gravitee-reporter-datadog-5.0.0.zip` from your Gateway `{GRAVITEE_HOME}/plugins` folder.
66+
2. To disable the Reporter, change the `reporters.datadog.enabled` attribute to `false` (in your Gravitee `values.yaml` file).
67+
68+
### In Datadog
69+
1. Click **Uninstall** on the integration tile to remove the dashboard.
70+
71+
## Support
72+
73+
Need help? Contact [Gravitee support][8].
74+
75+
Have feedback about the integration? Email Gravitee at <contact@graviteesource.com>.
76+
77+
78+
[1]: https://download.gravitee.io/#graviteeio-ee/apim/plugins/reporters/gravitee-reporter-datadog/
79+
[2]: https://documentation.gravitee.io/apim/getting-started/plugins
80+
[3]: https://docs.datadoghq.com/account_management/api-app-keys/#add-an-api-key-or-client-token
81+
[4]: https://docs.datadoghq.com/agent/?tab=Linux
82+
[5]: https://documentation.gravitee.io/apim/configure-apim/sensitive-data-management/configuration-level-secrets
83+
[6]: https://documentation.gravitee.io/apim/gravitee-gateway/reporters#metrics-sent-via-reporters
84+
[7]: https://documentation.gravitee.io/apim/gravitee-gateway/reporters#log-data-sent-via-reporters
85+
[8]: https://www.gravitee.io/contact-us

0 commit comments

Comments
 (0)