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

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

Merged
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
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
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,12 @@ datadog_checks_base/datadog_checks/base/checks/windows/ @DataDog/wi
/ping_federate/manifest.json @DataDog/saas-integrations @DataDog/documentation
/ping_federate/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend

/ringcentral/ @DataDog/saas-integrations
/ringcentral/*.md @DataDog/saas-integrations @DataDog/documentation
/ringcentral/manifest.json @DataDog/saas-integrations @DataDog/documentation
/ringcentral/metadata.csv @DataDog/saas-integrations @DataDog/documentation
/ringcentral/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend

/trend_micro_email_security/ @DataDog/saas-integrations
/trend_micro_email_security/*.md @DataDog/saas-integrations @DataDog/documentation
/trend_micro_email_security/manifest.json @DataDog/saas-integrations @DataDog/documentation
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/config/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,8 @@ integration/riak:
- riak/**/*
integration/riakcs:
- riakcs/**/*
integration/ringcentral:
- ringcentral/**/*
integration/sap_hana:
- sap_hana/**/*
integration/scylla:
Expand Down
7 changes: 7 additions & 0 deletions ringcentral/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CHANGELOG - Ringcentral

## 1.0.0 / 2024-08-07

***Added***:

* Initial Release
116 changes: 116 additions & 0 deletions ringcentral/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# 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.
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
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.

Copy link
Contributor

Choose a reason for hiding this comment

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

I have updated the changes as per your suggestion.


### The integration collects:

#### Logs for:
- Voice
- Audit

#### Metrics for:
- Voice (Analytics)
- A2P SMS

## Setup
Copy link
Contributor

Choose a reason for hiding this comment

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

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@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.


### Get API Credentials from RingCentral

#### RingCentral Account ID

1. **Access User:**
- Visit [RingCentral][1] and log in as a Super Admin.
- Once logged in, go to the **Users** section.
- Under the **Users** section, click on "Users with Extensions."
- From the list of users, click on the user who has "Super Admin" suffix in their name. This will open the user's details panel.

2. **Locate the Account ID in the URL:**
- Look at the URL in your web browser's address bar. The URL will contain a series of numbers.
- Find the 9-digit number within the URL. This is your RingCentral Account ID.

**Example URL:** https://service.ringcentral.com/application/users/users/default/123456789/settings/default

The `123456789` is your Account ID.

#### RingCentral Application Client ID and Client Secret

1. **Register a New Application:**
- Login to your [RingCentral Developer][2] account using a user with Super Admin role or Custom role (Refer [here][6] to create and assign a custom role).
- Click on Console.
- Under the Apps section, click on **Register App**.
- Select the App type as **Rest API app**.
- Fill in the required details for your application, such as the name and description.
- Select "No" for "Do you intend to promote this app in the RingCentral App Gallery?"
- Select the auth type as **JWT auth flow**.
- Select "Yes" for "Issue refresh tokens?"
- Select the following **Application scopes**:
- Analytics
- Read Audit Trail
- Read Call Log
- A2P SMS
- Click on create App.

2. **Get the Client ID and Client Secret:**
- After creating the application, you'll find the `clientId` and `clientSecret` in the application settings. Copy these credentials for the subsequent configuration steps.
- Ensure these credentials are stored securely and not exposed in public repositories or insecure locations.

#### RingCentral JWT Token

- Login to [RingCentral Developers][2] with the same user as above and click on **Credentials** under your username.
- Click on **Create JWT**.
- Add an appropriate label and Select the **Production** environment.
- Allow this JWT token for only a specific app and add the `clientId` of the application created above.
- If you select an expiration date, ensure to create a new JWT and update it in the integration configuration before the expiry date.
- Click on **Create JWT**.

#### Create and assign a custom role

- Refer to this [link][5] to create a custom role.
- Select **Standard** role as a starting point.
- Provide additional **Audit Trail** and **Company Call Log - View Only** permissions to the role.
- To assign a custom role to a user, refer to this [link][7].

### RingCentral Datadog Integration Configuration

Configure the Datadog endpoint to forward RingCentral logs and metrics to Datadog.

1. Navigate to `RingCentral`.
2. Add your RingCentral credentials.

| RingCentral Parameters | Description |
|------------------------------|-----------------------------------------------------------------------------------------|
| Account ID | The Account ID of RingCentral. |
| Client ID | The Client ID of the RingCentral Application. |
| Client Secret | The Client Secret of the RingCentral Application. |
| JWT Token | The JWT Token from RingCentral. |
| Get Voice Calls | Enable to collect Voice Call Logs from RingCentral. The default value is True. |
| Get Voice(Analytics) Metrics | Enable to collect Voice(Analytics) Metrics from RingCentral. The default value is True. |
| Get SMS Metrics | Enable to collect SMS Metrics from RingCentral. The default value is True. |
| Get Audit Logs | Enable to collect Audit Logs from RingCentral. The default value is True. |

## Data Collected

### Logs

The RingCentral integration collects and forwards Voice and Audit logs to Datadog.

### Metrics

The RingCentral integration collects and forwards Voice(Analytics) and SMS metrics to Datadog. See [metadata.csv][4] for a list of metrics provided by this integration.

### Events

The RingCentral integration does not include any events.

## Support

For further assistance, contact [Datadog Support][3].

[1]: https://service.ringcentral.com/
[2]: https://developers.ringcentral.com/
[3]: https://docs.datadoghq.com/help/
[4]: https://github.com/DataDog/integrations-core/blob/master/ringcentral/metadata.csv
[5]: https://support.ringcentral.com/article-v2/10641-user-roles-permissions-edit-permission-custom-role.html?brand=RC_US&product=RingEX&language=en_US
[6]: #create-and-assign-a-custom-role
[7]: https://support.ringcentral.com/article-v2/10647-user-roles-permissions-assign-role-user-details.html?brand=RC_US&product=RingEX&language=en_US
Loading
Loading