[INTPLAT-484] DDSaaS: Sanity: Integration v1.0.0 (#19333)

* Sanity integration skeleton * Added Sanity integration assets * Resolved log pipeline test failures * Updated dashboard and monitors * README changes * README update * Update sanity/assets/dashboards/sanity_activity_overview.json Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/assets/dashboards/sanity_activity_overview.json Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/assets/dashboards/sanity_activity_overview.json Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/manifest.json Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * Update sanity/README.md Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> * CODEOWNERS updated * CODEOWNERS reverted --------- Co-authored-by: Bhavik Parmar <bhavik.parmar@crestdatasys.com> Co-authored-by: Bhavik Parmar <84003960+bparmar-crest@users.noreply.github.com> Co-authored-by: Mauneel Sorathia <mauneel.sorathia@crestdatasys.com> Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
DataDog · Feb 25, 2025 · 1369f96 · 1369f96
1 parent 85b3267
commit 1369f96
Show file tree

Hide file tree

Showing 18 changed files with 5,123 additions and 21 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -331,6 +331,11 @@ datadog_checks_base/datadog_checks/base/checks/windows/              @DataDog/wi
 /postmark/manifest.json                                             @DataDog/saas-integrations @DataDog/documentation
 /postmark/assets/logs/                                              @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend
 
+/sanity/                                                            @DataDog/saas-integrations
+/sanity/*.md                                                        @DataDog/saas-integrations @DataDog/documentation
+/sanity/manifest.json                                               @DataDog/saas-integrations @DataDog/documentation
+/sanity/assets/logs/                                                @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend @DataDog/logs-core
+
 /snowflake/                                                          @DataDog/saas-integrations
 /snowflake/*.md                                                      @DataDog/saas-integrations @DataDog/documentation @DataDog/agent-integrations
 /snowflake/changelog.d/                                              @DataDog/saas-integrations @DataDog/documentation @DataDog/agent-integrations

diff --git a/sanity/README.md b/sanity/README.md
@@ -2,37 +2,83 @@
 
 ## Overview
 
-This check monitors [Sanity][1].
+[Sanity][1] is a headless content management system (CMS) designed for building flexible, real-time websites and applications. It enables developers and content teams to efficiently manage structured content across multiple platforms.
 
-## Setup
-
-### Configuration
+Integrate Sanity with Datadog to gain insights into content and project-related activity logs through the Sanity API and GROQ-powered Webhook. Pre-built dashboard visualizations provide immediate insights into Sanity activity logs.
 
-!!! Add list of steps to set up this integration !!!
-
-### Validation
+## Setup
 
-!!! Add steps to validate integration is functioning as expected !!!
+### Generate API Token in Sanity
+
+1. Log in to your [Sanity account][2] as an Administrator. You are automatically redirected to the [manage page][3].
+2. Select your project.
+3. In the navigation panel, click **API**.
+4. In the left sidebar, select **Tokens**.
+5. Click **Add API Token**.
+6. Enter a name and set the permission to **Viewer**.
+7. Click **Save** to copy a newly generated token.
+
+### Connect your Sanity account to Datadog
+
+1. Add your Sanity API Token    
+    |Parameters|Description|
+    |--------------------|--------------------|
+    |API Token|API Token of your Sanity project.|
+
+2. Click the **Save** button to save your settings.
+
+**Note**: These steps enable collection of project activity logs.
+
+### Webhook Configuration
+Configure the Datadog endpoint to forward Sanity activity logs to Datadog. See [Sanity webhook documentation][4] for more details.
+
+1. Select an existing API key or create a new one by clicking one of the buttons below: <!-- UI Component to be added by Datadog team -->
+2. Log in to your [Sanity account][2] as an Administrator. You are automatically redirected to the [manage page][3].
+3. Select your project.
+4. In the navigation panel, click **API**.
+5. Click **Create Webhook**.
+6. Add the name and webhook URL generated in step 1.
+7. Select Dataset as `* (all datasets)`.
+8. Under the **Trigger on** section, select the types of Document events you want to send to Datadog.
+9. Under the **Projection** section, paste the below JSON:
+    ```         
+      { 
+        "documentId": _id, 
+        "documentType": _type, 
+        "projectId": sanity::projectId(),
+        "datasetName": sanity::dataset(),
+        "action": "document." + delta::operation(),
+        "beforeValues": before(),
+        "afterValues": after(),
+        "timestamp": now()
+      }
+    ```
+    **Note**: It is recommended to _**uncheck**_ the **Trigger webhook when drafts are modified** checkbox in the Drafts section.
+10. Ensure **POST** is selected under **HTTP method** in the **Advanced settings section**.
+11. Click **Save**.
+
+**Note**: These steps enable collection of document changes along with task and comment activity logs.
 
 ## Data Collected
 
-### Metrics
+### Logs
 
-Sanity does not include any metrics.
+The Sanity integration collects and forwards Sanity activity logs to Datadog.
 
-### Service Checks
+### Metrics
 
-Sanity does not include any service checks.
+The Sanity integration does not include any metrics.
 
 ### Events
 
-Sanity does not include any events.
-
-## Troubleshooting
+The Sanity integration does not include any events.
 
-Need help? Contact [Datadog support][3].
+## Support
 
-[1]: **LINK_TO_INTEGRATION_SITE**
-[2]: https://app.datadoghq.com/account/settings/agent/latest
-[3]: https://docs.datadoghq.com/help/
+For further assistance, contact [Datadog Support][5].
 
+[1]: https://www.sanity.io/
+[2]: https://www.sanity.io/login
+[3]: https://www.sanity.io/manage
+[4]: https://www.sanity.io/docs/webhooks#
+[5]: https://docs.datadoghq.com/help/