-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
DDSaaS: StreamNative: Crawler Integration v1.0.0 #18782
base: master
Are you sure you want to change the base?
DDSaaS: StreamNative: Crawler Integration v1.0.0 #18782
Conversation
…avnariyanicrest/integrations-core into streamnative-assets-v1.0.0
streamnative/README.md
Outdated
|
||
[StreamNative][1] provides an enterprise-grade messaging and event streaming platform built on Apache Pulsar. It offers scalable, real-time data streaming solutions with features like multi-tenancy, geo-replication, and seamless integration with cloud services. | ||
|
||
The StreamNative integration collects below types of metrics: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we please get a link to the types of metrics collected?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
streamnative/README.md
Outdated
|
||
### Configuration | ||
|
||
StreamNative integration requires a StreamNative account and its Client Id, Client Secret, Organization ID and Instance Name. Below are the steps to fetch these details from StreamNative console: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Id > ID for consistency please. Would also be great to see these formatted as code with ``. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
streamnative/README.md
Outdated
|
||
#### Steps to retrieve Organization ID, Instance Name, Client Id & Client Secret | ||
|
||
1. Login to the [StreamNative Cloud Console Account][2] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add a .
at the end of #1 for consistency. Thanks!
streamnative/README.md
Outdated
|
||
1. Login to the [StreamNative Cloud Console Account][2] | ||
2. Go to the profile icon and select to the **Organizations** option. | ||
3. Go into the **Organization** from which data needs to be collected in the Datadog. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the Datadog > Datadog
streamnative/README.md
Outdated
1. Login to the [StreamNative Cloud Console Account][2] | ||
2. Go to the profile icon and select to the **Organizations** option. | ||
3. Go into the **Organization** from which data needs to be collected in the Datadog. | ||
4. Copy and save the **Organization ID** to configure in the Integration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the Integration > the Streamnative Integration Tile
streamnative/README.md
Outdated
2. Go to the profile icon and select to the **Organizations** option. | ||
3. Go into the **Organization** from which data needs to be collected in the Datadog. | ||
4. Copy and save the **Organization ID** to configure in the Integration. | ||
5. From the **Select an Instance** section, Copy and save the **Instance Name** to configure in the Integration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copy > copy
streamnative/README.md
Outdated
3. Go into the **Organization** from which data needs to be collected in the Datadog. | ||
4. Copy and save the **Organization ID** to configure in the Integration. | ||
5. From the **Select an Instance** section, Copy and save the **Instance Name** to configure in the Integration. | ||
6. Go to the profile icon and select the **Accounts & Accesses** tab. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Go to > "click"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
Thanks for all of the updates, we're running this by our docs team and PM. |
streamnative/assets/dashboards/streamnative_pulsar_resource.json
Outdated
Show resolved
Hide resolved
streamnative/assets/dashboards/streamnative_sink_connector.json
Outdated
Show resolved
Hide resolved
streamnative/assets/dashboards/streamnative_sink_connector.json
Outdated
Show resolved
Hide resolved
streamnative/assets/dashboards/streamnative_source_connector.json
Outdated
Show resolved
Hide resolved
streamnative/assets/dashboards/streamnative_source_connector.json
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies, I missed these capitalization tweaks the first time around.
streamnative/README.md
Outdated
|
||
The StreamNative integration collects and forwards the following metrics to Datadog. | ||
|
||
1. Health |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@apiazza-dd is this where we should have the table view with all the metric names + descriptions for the public docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Metrics section on the public docs should reflect a table view of all the metrics collected that show up on the "Data collected" tab on the tile (from the metadata.csv)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see comment above
@narendranandaniya-crest Can you please take this PR out of draft? We have reviews from all stakeholders, so once they're addressed, we're happy to approve and merge! Thanks! |
Hi @apiazza-dd , normally we follow this path where once the without Assets PR is merged we will move the Assets PR in Ready for Review State. |
This looks good, thanks for all of the updates! I'll need to verify the docs build once the PR is completely finished and ready to ship, just mention me here and I'll be happy to run the final check and approve it. |
streamnative/README.md
Outdated
|
||
[StreamNative][1] provides an enterprise-grade messaging and event streaming platform built on Apache Pulsar. It offers scalable, real-time data streaming solutions with features like multi-tenancy, geo-replication, and seamless integration with cloud services. | ||
|
||
The StreamNative integration collects the below types of [metrics][2]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"collects the below" > Collects the following types of metrics
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
5. Click **Download OAuth2 Key** to get the **Client ID** and **Client Secret**. | ||
|
||
|
||
#### Add StreamNative credentials |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add more clarity here. What do you think of the following:
1. Click the profile icon and select **Organizations**.
2. Choose the **Organization** for which data needs to be collected.
3. From the **Select an Instance** dropdown, note the **Instance Name**.
#### Get the `Client ID` and `Client Secret`:
1. Click the profile icon and navigate to the **Accounts & Accesses** tab.
2. Find the Service Account with **Admin** permissions set to **Enabled**.
- If no Service Account exists, select **New -> Service Account** to create one, and make sure to enable the **Super Admin** option.
3. On the right side of the chosen Service Account, click the `...` button.
4. Select **Download OAuth2 Key** to obtain the **Client ID** and **Client Secret**.
### Setting Up the Integration Tile
After gathering the necessary details, add the following Stream Native credentials to the integration tile
- **Organization ID**
- **Instance Name**
- **Client ID**
- **Client Secret**
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @apiazza-dd, we have updated the first half including the steps to get the configuration details.
Regarding the second part from "Setting Up the Integration Tile", earlier on the similar lines we have had an discussion around this over slack with @dpoint01 ( ref ). Can you please have a look. thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ashah-crest Thanks, I don't have access to that slack environment, but if @dpoint01 approved, lgtm.
streamnative/README.md
Outdated
|
||
[StreamNative][1] provides an enterprise-grade messaging and event streaming platform built on Apache Pulsar. It offers scalable, real-time data streaming solutions with features like multi-tenancy, geo-replication, and seamless integration with cloud services. | ||
|
||
The StreamNative integration Collects the following types of [metrics][2]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The StreamNative integration Collects the following types of [metrics][2]: | |
The StreamNative integration collects the following types of [metrics][2]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
streamnative/README.md
Outdated
|
||
#### Get StreamNative credentials | ||
|
||
##### Log in to the [StreamNative Cloud Console Account][3]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
##### Log in to the [StreamNative Cloud Console Account][3]. | |
Log into the [StreamNative Cloud Console Account][3]. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
What does this PR do?
This is an initial release PR of StreamNative integration including all the required assets.
Motivation
Review checklist (to be filled by reviewers)
qa/skip-qa
label if the PR doesn't need to be tested during QA.backport/<branch-name>
label to the PR and it will automatically open a backport PR once this one is merged