[SIEMINT-84] DDSaaS: RingCentral: Crawler Integration v1.0.0 #18296

vrajpatel-crest · 2024-08-12T04:27:24Z

What does this PR do?

This is an initial release PR of RingCentral integration including all the required assets.

Additional Notes

Crawler code for this integration has been committed in its respective repo
Pipeline and Facet group created for this integration are available in our sandbox and would be shared separately with the required teams.
Samples for the pipeline review would also be shared separately with the required teams.
Since during the standard attribute remapping we are not preserving the source attributes as per suggested best practices, it would result in filters using these standard attributes populating the values of other integrations as well as per current Datadog behaviour.

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Changelog entries must be created for modifications to shipped code
Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

cswatt · 2024-08-12T20:17:31Z

Added DOCS-8695 for docs to review

estherk15 · 2024-08-13T15:07:52Z

ringcentral/README.md

+# RingCentral
+
+## Overview
+The RingCentral integration seamlessly collects Voice, Audit, A2P SMS and Voice(Analytics) data and ingests them into Datadog for comprehensive analysis. Leveraging the built-in logs pipeline, these logs are parsed and enriched, enabling effortless search and analysis. The integration empowers users with deep insights into call activities, SMS trends, and audit trails through intuitive, out-of-the-box dashboards. Additionally, it includes pre-configured monitors for proactive notifications on SMS budget overrun and SMS error rates.


Suggested change

The RingCentral integration seamlessly collects Voice, Audit, A2P SMS and Voice(Analytics) data and ingests them into Datadog for comprehensive analysis. Leveraging the built-in logs pipeline, these logs are parsed and enriched, enabling effortless search and analysis. The integration empowers users with deep insights into call activities, SMS trends, and audit trails through intuitive, out-of-the-box dashboards. Additionally, it includes pre-configured monitors for proactive notifications on SMS budget overrun and SMS error rates.

The RingCentral integration seamlessly collects Voice, Audit, A2P SMS, and Voice(Analytics) data and ingests them into Datadog for comprehensive analysis. Leveraging the built-in logs pipeline, these logs are parsed and enriched, enabling effortless search and analysis. Through intuitive, out-of-the-box dashboards the integration provides insights into call activities, SMS trends, and audit trails. Additionally, it includes pre-configured monitors for proactive notifications on SMS budget overrun and SMS error rates.

I have updated the changes as per your suggestion.

estherk15 · 2024-08-14T00:03:50Z

ringcentral/README.md

+- Voice (Analytics)
+- A2P SMS
+
+## Setup


I created a PR to address some suggestions for formatting this page: bhargavnariyanicrest#1
Mainly, I moved some of the content around for information flow and formatted the instructions so that all actions were on the same level. I didn't verify these against the RingCentral UI, so let me know if the suggestions are incorrect!

@estherk15 Thanks for the PR. There were some formatting issues in the table that we have fixed, along with other changes. Let me know if any further changes are needed.

estherk15 · 2024-08-14T00:08:43Z

ringcentral/assets/dashboards/ringcentral_audit.json

@@ -0,0 +1,589 @@
+{
+  "title": "RingCentral Audit",
+  "description": "The RingCentral Audit dashboard provides a detailed examination of activity within the RingCentral account. It includes the total number of audit logs, highlighting frequent and infrequent actions and detailed insights into audit activities.",


I wasn't sure if it was highlighting frequent and infrequent audit logs, or if frequent and infrequent actions was a separate feature of the dashboard.

Suggested change

"description": "The RingCentral Audit dashboard provides a detailed examination of activity within the RingCentral account. It includes the total number of audit logs, highlighting frequent and infrequent actions and detailed insights into audit activities.",

"description": "The RingCentral Audit dashboard provides a detailed examination of activity within the RingCentral account. It includes the total number of audit logs (highlighting frequent and infrequent actions), and detailed insights into audit activities.",

There are three separate panels in the dashboard: Total number of audit logs, Frequent audit logs and Infrequent audit logs. So, I have updated the description accordingly. Please let me know if any additional changes are needed.

estherk15 · 2024-08-14T00:10:12Z

ringcentral/assets/dashboards/ringcentral_audit.json

+      "id": 727466998845956,
+      "definition": {
+        "type": "note",
+        "content": "**Dashboard Overview**\n\nThe RingCentral Audit dashboard provides a detailed examination of activity within the RingCentral account. It includes the total number of audit logs, highlighting frequent and infrequent actions and detailed insights into audit activities.\n\nFor more information, see the [RingCentral Integration Documentation](https://docs.datadoghq.com/integrations/ringcentral/).\n\n**Tips**\n- Use the timeframe selector in the top right of the dashboard to change the default timeframe.\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.",


Same here, can you clarify if frequent and infrequent actions are part of log actions or a separate feature?

Both Frequent and infrequent audit logs are part of log actions only, but they are displayed in two separate panels.

estherk15 · 2024-08-14T00:13:39Z

ringcentral/assets/dashboards/ringcentral_message.json

@@ -0,0 +1,907 @@
+{
+  "title": "RingCentral Message",
+  "description": "The Message Dashboard delivers an in-depth look at A2P SMS metrics within RingCentral, focusing on performance, costs, and message delivery status and provides valuable insights, aiding in effective decision-making and operational efficiency.",


Suggested change

"description": "The Message Dashboard delivers an in-depth look at A2P SMS metrics within RingCentral, focusing on performance, costs, and message delivery status and provides valuable insights, aiding in effective decision-making and operational efficiency.",

"description": "The Message Dashboard delivers an in-depth look at A2P SMS metrics within RingCentral, focusing on performance, costs, and message delivery status. It provides valuable insights, to help you make effective decision and improve operational efficiency.",

Updated the changes as per your suggestion.

estherk15 · 2024-08-14T00:20:27Z

ringcentral/assets/monitors/sms_budget_overrun.json

+	"version": 2,
+	"created_at": "2024-08-07",
+	"last_updated_at": "2024-08-07",
+	"title": "[RingCentral] SMS budget overrun",


Suggested change

"title": "[RingCentral] SMS budget overrun",

"title": "SMS budget overrun",

Changes have been done as per your suggestion.

estherk15 · 2024-08-14T00:22:49Z

ringcentral/assets/monitors/sms_budget_overrun.json

+	"created_at": "2024-08-07",
+	"last_updated_at": "2024-08-07",
+	"title": "[RingCentral] SMS budget overrun",
+	"description": "The monitor tracks and alerts when the daily budget allocated for RingCentral SMS messages is exceeded. It provides notifications to ensure timely awareness and action can be taken to manage SMS usage within the allocated budget limits.",


Suggested change

"description": "The monitor tracks and alerts when the daily budget allocated for RingCentral SMS messages is exceeded. It provides notifications to ensure timely awareness and action can be taken to manage SMS usage within the allocated budget limits.",

"description": "The monitor tracks and alerts when the total cost for RingCentral SMS messages exceeds the daily allocated budget. It provides notifications to ensure timely awareness and action can be taken to manage SMS usage within the allocated budget limits.",

I have applied the changes as per your suggestion.

estherk15 · 2024-08-14T12:52:31Z

ringcentral/assets/monitors/sms_budget_overrun.json

+		"name": "[RingCentral] SMS budget overrun",
+		"type": "query alert",
+		"query": "sum(last_1mo):sum:ringcentral.message.cost_total{*} by {accountid}.as_count() > 500",
+		"message": "{{#is_alert}}\nThe budget allocated for RingCentral SMS has been exceeded the alert threshold.\nThe total cost incurred is {{value}} , which exceeds the threshold of {{threshold}} . Please review your RingCentral account.\n{{/is_alert}}\n\n{{#is_warning}}\nThe budget allocated for RingCentral SMS has been exceeded the warning threshold.\nThe total cost incurred is {{value}} , which exceeds the threshold of {{warn_threshold}} . Please review your RingCentral account.\n{{/is_warning}}",


Suggested change

"message": "{{#is_alert}}\nThe budget allocated for RingCentral SMS has been exceeded the alert threshold.\nThe total cost incurred is {{value}} , which exceeds the threshold of {{threshold}} . Please review your RingCentral account.\n{{/is_alert}}\n\n{{#is_warning}}\nThe budget allocated for RingCentral SMS has been exceeded the warning threshold.\nThe total cost incurred is {{value}} , which exceeds the threshold of {{warn_threshold}} . Please review your RingCentral account.\n{{/is_warning}}",

"message": "{{#is_alert}}\nThe total cost for RingCentral SMS has exceeded the alert threshold.\nThe total cost incurred is {{value}} , which exceeds the threshold of {{threshold}} . Please review your RingCentral account.\n{{/is_alert}}\n\n{{#is_warning}}\nThe total cost for RingCentral SMS has exceeded the warning threshold.\nThe total cost incurred is {{value}} , which exceeds the threshold of {{warn_threshold}} . Please review your RingCentral account.\n{{/is_warning}}",

Updated the changes as per your suggestion.

estherk15 · 2024-08-14T12:52:51Z

ringcentral/assets/monitors/sms_high_error_rate_detected.json

+	"version": 2,
+	"created_at": "2024-08-07",
+	"last_updated_at": "2024-08-07",
+	"title": "[RingCentral] SMS high error rate detected",


Suggested change

"title": "[RingCentral] SMS high error rate detected",

"title": "SMS error rate is higher than usual",

Changes done as per your suggestion.

estherk15 · 2024-08-14T13:02:46Z

ringcentral/assets/monitors/sms_high_error_rate_detected.json

+	"created_at": "2024-08-07",
+	"last_updated_at": "2024-08-07",
+	"title": "[RingCentral] SMS high error rate detected",
+	"description": "This monitor triggers an alert when a high error rate occurs while sending SMS through RingCentral. This ensures prompt attention to potential issues affecting SMS delivery reliability.",


Can you provide extra context around the failure mode and also about the impact this mode can have on the system. This description should allow users to understand at a glance whether it is relevant or not for them to create a monitor out of it. For an example, see this guide.

Suggested change

"description": "This monitor triggers an alert when a high error rate occurs while sending SMS through RingCentral. This ensures prompt attention to potential issues affecting SMS delivery reliability.",

"description": "This monitor triggers an alert when a high error rate occurs while sending SMS through RingCentral. This ensures prompt attention to potential issues affecting SMS delivery reliability.",

I have applied the changes accordingly.

README changes suggestions for documentation review

estherk15

Thanks for making those changes, approved for documentation!

ringcentral/README.md

Co-authored-by: Esther Kim <[email protected]>

ringcentral/assets/logs/ringcentral_tests.yaml

MatthewMSaucedo

Screen.Recording.2024-09-13.at.1.25.08.PM.mov

Screen.Recording.2024-09-13.at.1.25.42.PM.mov

LGTM

* RingCentral Crawler integration with assets * Resolved assets check error * Sorted metadata.csv by metric name * README changes suggestions for documentation review * pipeline and sample result changes as per the change in log structure * fixed pipeline failure * addressed review comments * modified source_type_name in manifest.json file * Updated CHANGELOG.md title * Update ringcentral/README.md Co-authored-by: Esther Kim <[email protected]> * addressed review comments related to extension.id * changes as per checks failure * adding changes for result section to fix the check * Change to extension id --------- Co-authored-by: Akshit Vaid <[email protected]> Co-authored-by: Esther Kim <[email protected]> Co-authored-by: Esther Kim <[email protected]> 8d5b9cd

RingCentral Crawler integration with assets

9917832

datadog-agent-integrations-bot bot added documentation changelog/no-changelog dev/testing dev/tooling qa/skip-qa Automatically skip this PR for the next QA labels Aug 12, 2024

avaid-crest and others added 3 commits August 12, 2024 12:02

Resolved assets check error

7433e0c

Merge branch 'master' into ringcentral-assets-v1.0.0

2e3874b

Sorted metadata.csv by metric name

05fc984

vrajpatel-crest marked this pull request as ready for review August 12, 2024 18:17

vrajpatel-crest requested review from a team as code owners August 12, 2024 18:17

datadog-agent-integrations-bot bot added team/agent-integrations team/documentation team/logs-backend team/siem-logs-reviewers labels Aug 12, 2024

cswatt added the editorial review Waiting on a more in-depth review from a docs team editor label Aug 12, 2024

README changes suggestions for documentation review

29b0f12

estherk15 mentioned this pull request Aug 13, 2024

README changes suggestions for documentation review bhargavnariyanicrest/integrations-core#1

Merged

4 tasks

estherk15 reviewed Aug 14, 2024

View reviewed changes

dj0well changed the title ~~DDSaaS: RingCentral: Crawler Integration v1.0.0~~ [SIEMINT-84] DDSaaS: RingCentral: Crawler Integration v1.0.0 Aug 19, 2024

vrajpatel-crest and others added 5 commits August 23, 2024 17:03

Merge pull request #1 from DataDog/documentation_review

b0c6960

README changes suggestions for documentation review

pipeline and sample result changes as per the change in log structure

843c24d

fixed pipeline failure

cfb4ea9

addressed review comments

ec1aef7

modified source_type_name in manifest.json file

fff56a9

vrajpatel-crest marked this pull request as draft August 23, 2024 13:01

Merge branch 'master' into ringcentral-assets-v1.0.0

8d8fdb9

datadog-agent-integrations-bot bot added the integration/ringcentral label Aug 30, 2024

Updated CHANGELOG.md title

a998962

vrajpatel-crest marked this pull request as ready for review August 30, 2024 10:05

vrajpatel-crest requested a review from a team as a code owner August 30, 2024 10:05

datadog-agent-integrations-bot bot added the team/saas-integrations label Aug 30, 2024

estherk15 previously approved these changes Sep 5, 2024

View reviewed changes

ringcentral/README.md Outdated Show resolved Hide resolved

Update ringcentral/README.md

265f021

Co-authored-by: Esther Kim <[email protected]>

vrajpatel-crest dismissed estherk15’s stale review via 265f021 September 6, 2024 14:32

Merge branch 'master' into ringcentral-assets-v1.0.0

57527f4

MatthewMSaucedo added the assets/deploy-logs-staging ONLY USED BY Logs Backend - Validates that a PR is OK to go to staging label Sep 9, 2024

MatthewMSaucedo requested changes Sep 10, 2024

View reviewed changes

ringcentral/assets/logs/ringcentral_tests.yaml Outdated Show resolved Hide resolved

ringcentral/assets/logs/ringcentral_tests.yaml Outdated Show resolved Hide resolved

avaid-crest and others added 5 commits September 11, 2024 15:03

addressed review comments related to extension.id

f4ec531

changes as per checks failure

ca7e163

adding changes for result section to fix the check

cf765f7

Change to extension id

21d7213

Merge branch 'master' into ringcentral-assets-v1.0.0

3ded873

MatthewMSaucedo approved these changes Sep 13, 2024

View reviewed changes

estherk15 approved these changes Sep 30, 2024

View reviewed changes

datadog-assets bot added docs/approved ecosystems/review-requested product/review-requested labels Sep 30, 2024

dj0well added the crest/asset-pr label Oct 13, 2024

BoyangHuang approved these changes Oct 15, 2024

View reviewed changes

BoyangHuang merged commit 8d5b9cd into DataDog:master Oct 15, 2024
48 of 49 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SIEMINT-84] DDSaaS: RingCentral: Crawler Integration v1.0.0 #18296

[SIEMINT-84] DDSaaS: RingCentral: Crawler Integration v1.0.0 #18296

vrajpatel-crest commented Aug 12, 2024 •

edited

Loading

cswatt commented Aug 12, 2024

estherk15 Aug 13, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

vrajpatel-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 Aug 14, 2024

avaid-crest Aug 23, 2024

estherk15 left a comment

MatthewMSaucedo left a comment

	"description": "The RingCentral Audit dashboard provides a detailed examination of activity within the RingCentral account. It includes the total number of audit logs, highlighting frequent and infrequent actions and detailed insights into audit activities.",
	"description": "The RingCentral Audit dashboard provides a detailed examination of activity within the RingCentral account. It includes the total number of audit logs (highlighting frequent and infrequent actions), and detailed insights into audit activities.",

	"description": "The Message Dashboard delivers an in-depth look at A2P SMS metrics within RingCentral, focusing on performance, costs, and message delivery status and provides valuable insights, aiding in effective decision-making and operational efficiency.",
	"description": "The Message Dashboard delivers an in-depth look at A2P SMS metrics within RingCentral, focusing on performance, costs, and message delivery status. It provides valuable insights, to help you make effective decision and improve operational efficiency.",

	"title": "[RingCentral] SMS budget overrun",
	"title": "SMS budget overrun",

	"description": "The monitor tracks and alerts when the daily budget allocated for RingCentral SMS messages is exceeded. It provides notifications to ensure timely awareness and action can be taken to manage SMS usage within the allocated budget limits.",
	"description": "The monitor tracks and alerts when the total cost for RingCentral SMS messages exceeds the daily allocated budget. It provides notifications to ensure timely awareness and action can be taken to manage SMS usage within the allocated budget limits.",

	"title": "[RingCentral] SMS high error rate detected",
	"title": "SMS error rate is higher than usual",

	"description": "This monitor triggers an alert when a high error rate occurs while sending SMS through RingCentral. This ensures prompt attention to potential issues affecting SMS delivery reliability.",
	"description": "This monitor triggers an alert when a high error rate occurs while sending SMS through RingCentral. This ensures prompt attention to potential issues affecting SMS delivery reliability.",

[SIEMINT-84] DDSaaS: RingCentral: Crawler Integration v1.0.0 #18296

[SIEMINT-84] DDSaaS: RingCentral: Crawler Integration v1.0.0 #18296

Conversation

vrajpatel-crest commented Aug 12, 2024 • edited Loading

What does this PR do?

Additional Notes

Review checklist (to be filled by reviewers)

cswatt commented Aug 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

estherk15 left a comment

Choose a reason for hiding this comment

MatthewMSaucedo left a comment

Choose a reason for hiding this comment

vrajpatel-crest commented Aug 12, 2024 •

edited

Loading