Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Harness Notifications integration (ECOINT-91) #2596

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions harness_harness_notifications/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CHANGELOG - harness-notifications

## 1.0.0 / 2025-02-03

_**Added**_:

* Initial Release
50 changes: 50 additions & 0 deletions harness_harness_notifications/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Harness Notifications

## Overview

The Datadog Notifications in Harness allows you to send pipeline event notifications directly to your Datadog monitoring system using the [Events API (v1)][1]. This integration helps you keep track of important pipeline updates within your existing monitoring workflows. [Learn more][2]

Please note, currently, the Datadog notifications feature is behind the feature flag `PIPE_DATADOG_NOTIFICATIONS`. Please, contact [Harness Support][3] to enable this feature in Harness.

## Setup

The **Harness Notifications** integration allows you to send pipeline event notifications directly to the Events Explorer in Datadog. Once installed, these events will be tagged with `source:harness_notifications`

## [Configure Datadog pipeline notifications in Harness][4]

1. In Harness Pipeline studio, click on Notify on the right sidebar.
2. Click on `+ Notifications` button to create a new channel.
2. Give a name to your Datadog notification channel.
2. Select Pipeline Events as per your requirements.
3. Select Channel type as `Datadog(/v1/events API)` in Notification Method.
![datadog-selection][5]

4. Provide the Datadog URL and API key.: Please provide the Datadog URL followed by `/api/v1/events` eg. `https://app.datadoghq.com/api/v1/events/`
![datadog-API-and-URL][6]

5. (Optional) Add headers if needed.
6. Test and complete the setup.

For details, check Datadog's documentation on [Events API (v1)][1].

## Uninstallation

## [Disable notification rule][8]

Once you've created notification rules, you can enable/disable them in the Notifications page.

![](https://developer.harness.io/assets/images/notify-users-of-pipeline-events-11-e5c8b04889195bd974ef6ab87aacc9a3.png)

## Support

Need help? Contact [Harness support][9].


[1]: https://docs.datadoghq.com/api/latest/events/
[2]: https://developer.harness.io/docs/continuous-delivery/x-platform-cd-features/cd-steps/notify-users-of-pipeline-events/#datadog-notifications
[3]: mailto:[email protected]
[4]: https://developer.harness.io/docs/continuous-delivery/x-platform-cd-features/cd-steps/notify-users-of-pipeline-events/#configuration "Direct link to Configuration"
[5]: https://developer.harness.io/assets/images/datadog-notification-1-b8800da49d5f75575040d229094e9c64.png
[6]: https://developer.harness.io/assets/images/datadog-api-conf-bbc150afdeb25c7693f17a6c8aa04c75.png
[8]: https://developer.harness.io/docs/continuous-delivery/x-platform-cd-features/cd-steps/notify-users-of-pipeline-events/#enable-or-disable-notification-rules "Direct link to Enable or disable notification rules"
[9]: https://www.harness.io/support
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
{
"title": "Harness Notifications Integration Overview",
"description": "This dashboard provides a high-level overview of Notification events from Harness. ",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "This dashboard provides a high-level overview of Notification events from Harness. ",
"description": "This dashboard provides a high-level overview of notification events from Harness.",

"widgets": [
{
"id": 325090501093728,
"definition": {
"title": "Harness Notifications",
"background_color": "vivid_purple",
"show_title": true,
"type": "group",
"layout_type": "ordered",
"widgets": [
{
"id": 2831545235878754,
"definition": {
"type": "image",
"url": "/api/v2/images/bdd2b17f-31e0-40d4-858a-60d0f48989c2",
"url_dark_theme": "/api/v2/images/fb3cfa8d-fa2a-4363-8706-80176fd77052",
"sizing": "contain",
"margin": "md",
"has_background": false,
"has_border": false,
"vertical_align": "center",
"horizontal_align": "center"
},
"layout": {
"x": 2,
"y": 0,
"width": 8,
"height": 2
}
},
{
"id": 6544225029855812,
"definition": {
"type": "note",
"content": "This dashboard provides a high-level overview of Notification events from Harness. ",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"content": "This dashboard provides a high-level overview of Notification events from Harness. ",
"content": "This dashboard provides a high-level overview of notification events from Harness.",

"background_color": "white",
"font_size": "14",
"text_align": "left",
"vertical_align": "top",
"show_tick": false,
"tick_pos": "50%",
"tick_edge": "left",
"has_padding": true
},
"layout": {
"x": 0,
"y": 2,
"width": 6,
"height": 2
}
},
{
"id": 7032118608350450,
"definition": {
"type": "note",
"content": "**Useful links**\n\n- [Send Harness pipeline notifications to Datadog](https://developer.harness.io/docs/continuous-delivery/x-platform-cd-features/cd-steps/notify-users-of-pipeline-events/#datadog-notifications)",
"background_color": "white",
"font_size": "14",
"text_align": "left",
"vertical_align": "top",
"show_tick": false,
"tick_pos": "50%",
"tick_edge": "left",
"has_padding": true
},
"layout": {
"x": 6,
"y": 2,
"width": 6,
"height": 2
}
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 12,
"height": 5
}
}
],
"template_variables": [],
"layout_type": "ordered",
"notify_list": [],
"reflow_type": "fixed",
"tags": []
}
15 changes: 15 additions & 0 deletions harness_harness_notifications/assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions harness_harness_notifications/assets/service_checks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions harness_harness_notifications/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{
"app_id": "harness-harness-notifications",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"app_id": "harness-harness-notifications",
"app_id": "harness-notifications",

"app_uuid": "0194c0d4-f822-7117-be7a-1ed1ccf587e7",
"manifest_version": "2.0.0",
"display_on_public_website": true,
"tile": {
"title": "Harness Notifications",
"description": "Post Harness notifications to Datadog tagged with source:harness_notifications",
"overview": "README.md#Overview",
"configuration": "README.md#Setup",
"uninstallation": "README.md#Uninstallation",
"support": "README.md#Support",
"changelog": "CHANGELOG.md",
"media": [
{
"media_type": "image",
"caption": "Add a Pipeline Notification strategy",
"image_url": "images/Screenshot 2025-02-03 at 2.30.31\u202fPM-2560x1440.png"
},
{
"media_type": "image",
"caption": "Select Pipeline Events for notification",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"caption": "Select Pipeline Events for notification",
"caption": "Select pipeline events for notification",

"image_url": "images/Screenshot 2025-02-03 at 2.34.46\u202fPM-2560x1440.png"
},
{
"media_type": "image",
"caption": "Send pipeline notifications to Datadog using /api/v1/events",
"image_url": "images/Screenshot 2025-02-03 at 2.35.46\u202fPM-2560x1440.png"
}
],
"classifier_tags": [
"Category::Notifications",
"Category::Event Management",
"Category::Alerting",
"Offering::Integration",
"Supported OS::Linux",
"Supported OS::Windows",
"Supported OS::macOS",
"Submitted Data Type::Events"
]
},
"oauth": {},
"author": {
"support_email": "[email protected]",
"name": "Harness",
"homepage": "https://www.harness.io/",
"sales_email": "[email protected]",
"vendor_id": "harness"
},
"assets": {
"dashboards": {
"Harness Notifications Integration Overview": "assets/dashboards/harness_notifications_integration_overview.json"
},
"integration": {
"source_type_name": "harness_notifications",
"auto_install": true,
"process_signatures": [],
"service_checks": {
"metadata_path": "assets/service_checks.json"
},
"source_type_id": 38607293
}
}
}
Loading