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

Common readme update for multiple integrations as per new format #19280

Open
wants to merge 19 commits into
base: master
Choose a base branch
from

Conversation

vrajpatel-crest
Copy link
Contributor

What does this PR do?

Common readme update for multiple integrations as per new format

Motivation

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • 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


### The integration collects:
[RingCentral][5] is a leading cloud-based communication and collaboration platform for businesses. It offers services such as voice, messaging, and video conferencing, seamlessly integrating with various business applications. Known for its reliability, security, and scalability, RingCentral enhances communication efficiency and collaboration.
Copy link
Contributor

Choose a reason for hiding this comment

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

remove: "Known for its reliability, security, and scalability, RingCentral enhances communication efficiency and collaboration."

#### Metrics for:
- Voice (Analytics)
- A2P SMS
The RingCentral integration seamlessly collects voice and audit logs, as well as Voice (Analytics) and A2P SMS metrics, and sends them to Datadog for comprehensive analysis.
Copy link
Contributor

Choose a reason for hiding this comment

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

remove "seamlessly" since It's being overused across all configs already.

@@ -4,16 +4,14 @@

This integration ingests the following logs:

- Policy events and detection
- Mail tracking
- Policy events and detection - This logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.
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
- Policy events and detection - This logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.
- Policy events and detection - These logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.

- Policy events and detection
- Mail tracking
- Policy events and detection - This logs provide information about policy events and detection, allowing you to monitor and respond to potential security threats effectively.
- Mail tracking - This logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.
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
- Mail tracking - This logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.
- Mail tracking - These logs provide information about email activities, including accepted and blocked traffic, allowing you to track email messages that have passed through the system and monitor their delivery status.

@rtrieu rtrieu self-requested a review December 18, 2024 19:50
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

Left feedback primarily around style consistency.


| Parameters | Description |
| ---------- | ----------- |
| Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
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
| Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
| Host Name | Host name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |

| Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
| Client ID | Client ID from Cisco Secure Email Threat Defense Account |
| Client Password | Client Password from Cisco Secure Email Threat Defense Account |
| API Key | API Key from Cisco Secure Email Threat Defense Account |
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
| API Key | API Key from Cisco Secure Email Threat Defense Account |
| API Key | API key from your Cisco Secure Email Threat Defense Account. |

| ---------- | ----------- |
| Host Name | Host Name is based on the region where your Cisco Secure Email Threat Defense server is located. For details, please reach out to your system administrator. |
| Client ID | Client ID from Cisco Secure Email Threat Defense Account |
| Client Password | Client Password from Cisco Secure Email Threat Defense Account |
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
| Client Password | Client Password from Cisco Secure Email Threat Defense Account |
| Client Password | Client password from your Cisco Secure Email Threat Defense Account. |

| Client ID | Client ID from Cisco Secure Email Threat Defense Account |
| Client Password | Client Password from Cisco Secure Email Threat Defense Account |
| API Key | API Key from Cisco Secure Email Threat Defense Account |
| Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay |
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
| Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay |
| Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay. |

@@ -12,12 +12,8 @@ The Cisco Secure Endpoint integration provides out-of-the-box dashboards so you

## Setup

### Configuration
### Generate API Credentials in Cisco Secure Endpoint
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
### Generate API Credentials in Cisco Secure Endpoint
### Generate API credentials in Cisco Secure Endpoint

1. Add your API Host, Application ID, API Key and select the Time Zone from the dropdown.
| Parameters | Description |
| -------------- | ----------------------------------------------------------------------- |
| API Host | The API Host of Trend Micro Vision One Endpoint Security console. |
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
| API Host | The API Host of Trend Micro Vision One Endpoint Security console. |
| API Host | The API host of Trend Micro Vision One Endpoint Security console. |

| Parameters | Description |
| -------------- | ----------------------------------------------------------------------- |
| API Host | The API Host of Trend Micro Vision One Endpoint Security console. |
| Application ID | The Application ID of Trend Micro Vision One Endpoint Security console. |
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
| Application ID | The Application ID of Trend Micro Vision One Endpoint Security console. |
| Application ID | The application ID of Trend Micro Vision One Endpoint Security console. |

| -------------- | ----------------------------------------------------------------------- |
| API Host | The API Host of Trend Micro Vision One Endpoint Security console. |
| Application ID | The Application ID of Trend Micro Vision One Endpoint Security console. |
| API Key | The API Key of of Trend Micro Vision One Endpoint Security console. |
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
| API Key | The API Key of of Trend Micro Vision One Endpoint Security console. |
| API Key | The API key of of Trend Micro Vision One Endpoint Security console. |

| API Host | The API Host of Trend Micro Vision One Endpoint Security console. |
| Application ID | The Application ID of Trend Micro Vision One Endpoint Security console. |
| API Key | The API Key of of Trend Micro Vision One Endpoint Security console. |
| Time Zone | The Time Zone of the Trend Micro Vision One console. |
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
| Time Zone | The Time Zone of the Trend Micro Vision One console. |
| Time Zone | The time zone of the Trend Micro Vision One console. |

- Application ID
- API Key
- Time Zone (This timezone should be the same as the Trend Vision One console.)
2. Click the Save button to save your settings.
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
2. Click the Save button to save your settings.
2. Click the **Save** button to save your settings.

| Verdict Delay | Events are fetched with a delay according to the time(in minute) specified in the Verdict Delay |


2. Click the Save button to save your settings.
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
2. Click the Save button to save your settings.
2. Click the **Save** button to save your settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants