initial commit

streamnative/CHANGELOG.md

@@ -1,6 +1,6 @@
 # CHANGELOG - StreamNative
 
-## 1.0.0 / 2024-10-01
+## 1.0.0 / 2024-10-07
 
 ***Added***:
 

streamnative/README.md

@@ -2,17 +2,58 @@
 
 ## Overview
 
-StreamNative is a cloud-native platform built on Apache Pulsar, offering scalable real-time messaging and event streaming. It supports multi-tenant architecture, data replication, and geo-replication, with features like long-term storage integration. StreamNative is ideal for messaging, data pipelines, and event-driven applications, with enterprise-grade security and observability.
+[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:
+
+1. Health
+2. Pulsar Resource
+3. Source Connector
+4. Sink Connector
+5. Kafka Connect
 
 ## Setup
 
 ### Configuration
 
-!!! Add list of steps to set up this integration !!!
+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:
+
+#### Steps to retrieve Organization ID, Instance Name, Client Id & Client Secret
+
+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.
+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.
+7. Choose the Service Account for which **Admin** permission is **True**.
+8. If the Service Account does not exist, click on **New -> Service Account** to create a new one, and ensure the **Super Admin** type is enabled.
+9. Click on the 3 dots on the right side of the selected Service Account.
+10. Click on **Download OAuth2 Key**, this file will have required **Client ID** & **Client Secret** to configure in the Integration.
+
+> **Tip**: If the service account does not exist, click on **New -> Service Account** to create a new one, and ensure the **Super Admin** type is enabled.
+
+
+#### StreamNative DataDog integration configuration
+
+Configure the Datadog endpoint to forward StreamNative metrics to Datadog.
+
+1. Navigate to the `StreamNative` integration tile in Datadog.
+2. Add your StreamNative credentials.
+
+| StreamNative parameters | Description                                    |
+| ------------------------------ | ---------------------------------------------  |
+| Organization ID                   | Organization ID of your StreamNative account.     |
+| Instance Name                   | Instance name of the desired organization.     |
+| Client ID                   | Client ID of your service account.     |
+| Client Secret                   | Client Secret of your service account.     |
+| Get Pulsar Resource Metrics                   | Enable to collect Pulsar Resource Metrics from StreamNative. Default value is True.     |
+| Get Source Connector Metrics                   | Enable to collect Source Connector Metrics from StreamNative. Default value is True.     |
+| Get Sink Connector Metrics                   | Enable to collect Sink Connector Metrics from StreamNative. Default value is True.     |
+| Get Kafka Connect Metrics                   | Enable to collect Kafka Connect Metrics from StreamNative. Default value is True.     |
+| Get Health Metrics                   | Enable to collect Health Metrics from StreamNative. Default value is True.     |
 
-### Validation
 
-!!! Add steps to validate integration is functioning as expected !!!
 
 ## Data Collected
 
@@ -22,15 +63,26 @@ The StreamNative integration does not include any logs.
 
 ### Metrics
 
-The StreamNative integration collects and forward metrics to Datadog.
+The StreamNative integration collects and forward below metrics to Datadog.
+
+1. Health
+2. Pulsar Resource
+3. Source Connector
+4. Sink Connector
+5. Kafka Connect
+
+### Service Checks
+
+The StreamNative integration does not include any service checks.
 
 ### Events
 
 The StreamNative integration does not include any events.
 
 ## Troubleshooting
 
-Need help? Contact [Datadog support][1].
-
-[1]: https://docs.datadoghq.com/help/
+Need help? Contact [Datadog support][3].
 
+[1]: https://streamnative.io/
+[2]: https://console.streamnative.cloud/
+[3]: https://docs.datadoghq.com/help/