Skip to content

Commit 71e176b

Browse files
HadhemiDDburaizu
andauthored
Add event integration template to ddev (#21717)
* Add event integration template to ddev * fix pr number * Update datadog_checks_dev/datadog_checks/dev/tooling/templates/integration/event/README.md Co-authored-by: Bryce Eadie <[email protected]> --------- Co-authored-by: Bryce Eadie <[email protected]>
1 parent 66b6ef3 commit 71e176b

File tree

8 files changed

+115
-0
lines changed

8 files changed

+115
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add new template for creating event integrations

datadog_checks_dev/datadog_checks/dev/tooling/constants.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,13 @@
142142
[3]: https://docs.datadoghq.com/help/
143143
"""
144144

145+
EVENT_TILE_LINKS = """\
146+
[1]: **LINK_TO_INTEGRATION_SITE**
147+
[2]: https://app.datadoghq.com/account/settings/agent/latest
148+
[3]: https://docs.datadoghq.com/help/
149+
[4]: https://github.com/DataDog/{repository}/blob/master/{name}/assets/service_checks.json
150+
"""
151+
145152
integration_type_links = {
146153
'check': CHECK_LINKS,
147154
'check_only': CHECK_ONLY_LINKS,
@@ -150,6 +157,7 @@
150157
'snmp_tile': SNMP_TILE_LINKS,
151158
'tile': TILE_LINKS,
152159
'metrics_crawler': TILE_LINKS,
160+
'event': EVENT_TILE_LINKS,
153161
}
154162

155163
# If a file changes in a PR with any of these file extensions,
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Event Integration
2+
3+
Choose this type of integration if your integration primarily sends events to Datadog.
4+
5+
This template is for integrations that focus on event collection.
6+
7+
There is no Python package for this type of integration, only a manifest is essential.
8+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CHANGELOG - {integration_name}
2+
3+
## 1.0.0 / {today}
4+
5+
***Added***:
6+
7+
* Initial Release
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Agent Check: {integration_name}
2+
3+
## Overview
4+
5+
This check monitors [{integration_name}][1].
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 events will your integration collect, and what's the value of that data?
11+
12+
## Setup
13+
14+
### Installation
15+
16+
{install_info}
17+
18+
### Configuration
19+
20+
!!! Add list of steps to set up this integration !!!
21+
22+
### Validation
23+
24+
!!! Add steps to validate integration is functioning as expected !!!
25+
26+
## Data Collected
27+
28+
### Metrics
29+
30+
{integration_name} does not include any metrics.
31+
32+
### Events
33+
34+
{integration_name} includes events.
35+
36+
### Service Checks
37+
38+
See [service_checks.json][4] for a list of service checks provided by this integration.
39+
40+
## Troubleshooting
41+
42+
Need help? Contact [Datadog support][3].
43+
44+
{integration_links}
45+
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[]
2+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{{
2+
"manifest_version": "2.0.0",
3+
"app_uuid": "{app_uuid}",
4+
"app_id": "{integration_id}",
5+
"display_on_public_website": true,
6+
"tile": {{
7+
"overview": "README.md#Overview",
8+
"configuration": "README.md#Setup",
9+
"support": "README.md#Support",
10+
"changelog": "CHANGELOG.md",
11+
"description": "{description}",
12+
"title": "{integration_name}",
13+
"media": [],
14+
"classifier_tags": [
15+
"<Add relevant tags from this list: https://docs.datadoghq.com/developers/integrations/check_references/#classifier-tags>",
16+
"Supported OS::Linux",
17+
"Supported OS::Windows",
18+
"Supported OS::macOS",
19+
"Category::<FILL IN>",
20+
"Offering::<FILL IN>",
21+
"Category::Event Collection",
22+
"Offering::Integration",
23+
"Submitted Data Type::<FILL IN>"
24+
]
25+
}},
26+
"assets": {{
27+
"integration": {{
28+
"auto_install": {auto_install},
29+
"source_type_id": {source_type_id},
30+
"source_type_name": "{integration_name}",
31+
"events": {{
32+
"creates_events": true
33+
}},
34+
"service_checks": {{
35+
"metadata_path": "assets/service_checks.json"
36+
}}
37+
}},
38+
"monitors": {{}},
39+
"saved_views": {{}}
40+
}},{pricing_plan}{terms}{author_info}
41+
}}
42+
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric,sample_tags
2+

0 commit comments

Comments
 (0)