Skip to content

Commit

Permalink
[INTPLAT-448] DDSaaS: Temporal Cloud Crawler Integration v1.0.0 (#19250)
Browse files Browse the repository at this point in the history
* temporal_cloud project skeleton

* temporal_cloud labeler and codeowners added

* CODEOWNERS updated

* Empty dashboard section removed for now

* SVG logo added

* Added Temporal Cloud integration assets

* Resolved github check failure about metadata csv

* Resolved README check failure

* Updated monitor message

* Updated dashboard

* Review comments incorporated

* Minor README comment change

* Update temporal_cloud/README.md

Co-authored-by: David Pointeau <davidmpointeau@gmail.com>

---------

Co-authored-by: Bhavik Parmar <bhavik.parmar@crestdatasys.com>
Co-authored-by: Bhavik Parmar <84003960+bparmar-crest@users.noreply.github.com>
Co-authored-by: David Pointeau <davidmpointeau@gmail.com>
  • Loading branch information
4 people authored Dec 18, 2024
1 parent 32a93c3 commit bc90221
Show file tree
Hide file tree
Showing 14 changed files with 3,954 additions and 21 deletions.
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,11 @@ datadog_checks_base/datadog_checks/base/checks/windows/ @DataDog/wi
/temporal_cloud/manifest.json @DataDog/saas-integrations @DataDog/documentation
/temporal_cloud/metadata.csv @DataDog/saas-integrations @DataDog/documentation

/temporal_cloud/ @DataDog/saas-integrations
/temporal_cloud/*.md @DataDog/saas-integrations @DataDog/documentation
/temporal_cloud/manifest.json @DataDog/saas-integrations @DataDog/documentation
/temporal_cloud/metadata.csv @DataDog/saas-integrations @DataDog/documentation

/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: 1 addition & 1 deletion temporal_cloud/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CHANGELOG - Temporal_Cloud
# CHANGELOG - Temporal Cloud

## 1.0.0 / 2024-11-26

Expand Down
49 changes: 32 additions & 17 deletions temporal_cloud/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,56 @@
## Overview

This check monitors [Temporal_Cloud][1].
[Temporal Cloud][1] is a scalable platform for orchestrating complex workflows, with built-in reliability, resilience, and timing controls. Temporal Cloud enables developers to focus on application logic without worrying about fault tolerance and consistency.


This integration gathers Temporal Cloud metrics into Datadog, offering insights into system health, workflow efficiency, task execution, and performance bottlenecks.

## Setup

### Installation
### Generate a Metrics endpoint URL in Temporal Cloud

1. To generate a CA certificate and an end-entity certificate, see [certificate management][2].
- **Note**: An expired root CA certificate invalidates all downstream certificates. To avoid disruptions to your systems, use certificates with long validity periods.
2. Log in to [Temporal Cloud][3] with an account owner or global admin role.
3. Go to **Settings**, and select the **Observability** tab.
4. Under the **Certificates** section, add your root CA certificate (`.pem` file content) and save it.
- **Note**: If an observability endpoint is already set up, you can append your root CA certificate.
5. Click **Save** to generate the endpoint URL under the **Endpoint** section. The URL should look like: `https://<account_id>.tmprl.cloud/prometheus`.

The Temporal_Cloud check is included in the [Datadog Agent][2] package.
No additional installation is needed on your server.

### Configuration
### Connect your Temporal Cloud account to Datadog

!!! Add list of steps to set up this integration !!!
1. Add your Account ID, End-entity Certificate file content, and End-entity Certificate key file content
|Parameters|Description|
|--------------------|--------------------|
|Account ID|Temporal Cloud account ID to be used as part of the metrics endpoint URL: `https://<account_id>.tmprl.cloud/prometheus`.|
|End-entity certificate file content|Contents of the end-entity certificate for secure access and communication with the Metrics endpoint.|
|End-entity certificate key file content|Content of the end-entity certificate key for secure access and communication with the Metrics endpoint.|

### Validation
2. Click the **Save** button to save your settings.

!!! Add steps to validate integration is functioning as expected !!!

## Data Collected

### Metrics

Temporal_Cloud does not include any metrics.
See [metadata.csv][4] for a list of metrics provided by this integration.


### Service Checks

Temporal_Cloud does not include any service checks.
The Temporal Cloud integration does not include any service checks.

### Events

Temporal_Cloud does not include any events.

## Troubleshooting
The Temporal Cloud 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/
Need help? Contact [Datadog support][5].

[1]: https://temporal.io/cloud/
[2]: https://docs.temporal.io/cloud/certificates#use-certstrap/
[3]: https://cloud.temporal.io/
[4]: https://github.com/DataDog/integrations-core/blob/master/temporal_cloud/metadata.csv
[5]: https://docs.datadoghq.com/help/
Loading

0 comments on commit bc90221

Please sign in to comment.