[INTPLAT-448] DDSaaS: Temporal Cloud Crawler Integration v1.0.0 #19250

mauneelsorathia-crest · 2024-12-11T13:05:24Z

What does this PR do?

This is an initial release PR of Temporal Cloud integration including all the required assets.

Motivation

Crawler code for this integration has been committed in its respective repo.
The assets are available in our sandbox and can be shared separately with the required teams.

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

drichards-87 · 2024-12-11T19:59:47Z

Created Jira card for Docs Team editorial review.

urseberry · 2024-12-13T18:09:27Z

temporal_cloud/README.md

@@ -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 enabling developers to focus on application logic without worrying about fault tolerance and consistency.


Suggested change

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

[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.

urseberry · 2024-12-13T18:09:44Z

temporal_cloud/README.md

+[Temporal Cloud][1] is a scalable platform for orchestrating complex workflows, with built-in reliability, resilience and timing controls enabling developers to focus on application logic without worrying about fault tolerance and consistency.
+
+
+This integration collects Temporal Cloud metrics and directs them into Datadog to provide insights into system health, workflow efficiency, task execution and performance bottlenecks.


Suggested change

This integration collects Temporal Cloud metrics and directs them into Datadog to provide insights into system health, workflow efficiency, task execution and performance bottlenecks.

This integration collects Temporal Cloud metrics and directs them into Datadog to provide insights into system health, workflow efficiency, task execution, and performance bottlenecks.

urseberry · 2024-12-13T18:12:15Z

temporal_cloud/README.md

-### Installation
+### Generate Metrics Endpoint URL in Temporal Cloud
+
+1. In order to generate security CA Certificate and End-entity Certificate refer to this [link][2].


Suggested change

1. In order to generate security CA Certificate and End-entity Certificate refer to this [link][2].

1. To generate a CA certificate and an end-entity certificate, see [certificate management][2].

urseberry · 2024-12-13T18:14:47Z

temporal_cloud/README.md

+### Generate Metrics Endpoint URL in Temporal Cloud
+
+1. In order to generate security CA Certificate and End-entity Certificate refer to this [link][2].
+    - **Note**: It is recommended to define longer expiry duration of the certificates.


Suggested change

- **Note**: It is recommended to define longer expiry duration of the certificates.

- **Note**: An expired root CA certificate invalidates all downstream certificates. To avoid disruptions to your systems, use certificates with long validity periods.

urseberry · 2024-12-13T18:15:24Z

temporal_cloud/README.md

+
+1. In order to generate security CA Certificate and End-entity Certificate refer to this [link][2].
+    - **Note**: It is recommended to define longer expiry duration of the certificates.
+2. Log in to [Temporal Cloud][3] with an Account Owner or Global Admin role.


Suggested change

2. Log in to [Temporal Cloud][3] with an Account Owner or Global Admin role.

2. Log in to [Temporal Cloud][3] with an account owner or global admin role.

urseberry · 2024-12-13T18:18:15Z

temporal_cloud/README.md


 ## Setup

-### Installation
+### Generate Metrics Endpoint URL in Temporal Cloud


Suggested change

### Generate Metrics Endpoint URL in Temporal Cloud

### Generate a Metrics endpoint URL in Temporal Cloud

urseberry · 2024-12-13T18:19:14Z

temporal_cloud/README.md

+    |--------------------|--------------------|
+    |Account ID|Temporal Cloud account ID to be used as part of metrics endpoint URL: https://<account_id>.tmprl.cloud/prometheus.|
+    |End-entity Certificate file content|Content of End-entity Certificate for secure access and communication with Metrics Endpoint.|
+    |End-entity Certificate key file content|Content of End-entity Certificate key for secure access and communication with Metrics Endpoint.|


Suggested change

|End-entity Certificate key file content|Content of End-entity Certificate key for secure access and communication with Metrics Endpoint.|

|End-entity certificate key file content|Content of the end-entity certificate key for secure access and communication with the Metrics endpoint.|

urseberry · 2024-12-13T18:19:25Z

temporal_cloud/README.md


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


Suggested change

2. Click the Save button to save your settings.

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

urseberry · 2024-12-13T18:24:27Z

temporal_cloud/README.md


 ## Data Collected

 ### Metrics

-Temporal_Cloud does not include any metrics.
+The Temporal Cloud integration collects and forwards Frontend Service metrics, Poll metrics, Replication lag metrics, Schedule metrics, Service latency metrics and Workflow metrics to Datadog. See [metadata.csv][4] for a list of metrics provided by this integration.


Suggested change

The Temporal Cloud integration collects and forwards Frontend Service metrics, Poll metrics, Replication lag metrics, Schedule metrics, Service latency metrics and Workflow metrics to Datadog. See [metadata.csv][4] for a list of metrics provided by this integration.

See [metadata.csv][4] for a list of metrics provided by this integration.

The above is a magic phrase that embeds the table of metrics in the integration doc. It needs to be the only text under the Metrics heading in order for the code that inserts the table to work.

urseberry · 2024-12-13T18:31:20Z

temporal_cloud/metadata.csv

+temporal_cloud.cloud_metrics.v0_replication_lag_p99,gauge,,second,,P99 value using histogram of replication lag during a specific time interval for a multi-region Namespace.,-1,temporal_cloud,Replication Lag P59,,
+temporal_cloud.cloud_metrics.v0_resource_exhausted_error_increase1m,count,60,,,Increase in gRPC requests received that were rate-limited,-1,temporal_cloud,Resource Exhausted Error,,
+temporal_cloud.cloud_metrics.v0_schedule_action_success_increase1m,count,60,,,Increase in count of successful execution of a Scheduled Workflow.,1,temporal_cloud,Schedule Action Success,,
+temporal_cloud.cloud_metrics.v0_schedule_buffer_overruns_increase1m,count,60,,,"When average schedule run length is greater than average schedule interval while a buffer_all overlap policy is configured, this is increase in count of such scheduled workflow executions",-1,temporal_cloud,Schedule Buffer Overruns,,


Suggested change

temporal_cloud.cloud_metrics.v0_schedule_buffer_overruns_increase1m,count,60,,,"When average schedule run length is greater than average schedule interval while a buffer_all overlap policy is configured, this is increase in count of such scheduled workflow executions",-1,temporal_cloud,Schedule Buffer Overruns,,

temporal_cloud.cloud_metrics.v0_schedule_buffer_overruns_increase1m,count,60,,,"When average schedule run length is greater than average schedule interval while a buffer_all overlap policy is configured, this is the increase in count of such scheduled workflow executions",-1,temporal_cloud,Schedule Buffer Overruns,,

bparmar-crest and others added 8 commits November 26, 2024 16:03

temporal_cloud project skeleton

0b60178

Merge branch 'DataDog:master' into temporal-cloud-v1.0.0

4a1a530

temporal_cloud labeler and codeowners added

7e5908b

CODEOWNERS updated

24f9e86

Empty dashboard section removed for now

7849ab3

SVG logo added

76fbbcb

Merge branch 'DataDog:master' into temporal-cloud-assets-v1.0.0

65a330a

Added Temporal Cloud integration assets

c4e85f4

datadog-assets bot added docs/review-requested ecosystems/review-requested product/review-requested labels Dec 11, 2024

mauneelsorathia-crest added 2 commits December 11, 2024 18:41

Resolved github check failure about metadata csv

9f940ed

Resolved README check failure

2d90e46

mauneelsorathia-crest marked this pull request as ready for review December 11, 2024 13:20

mauneelsorathia-crest requested review from a team as code owners December 11, 2024 13:20

mauneelsorathia-crest changed the title ~~DDSaaS: Temporal Cloud Crawler Integration v1.0.0~~ [INTPLAT-448] DDSaaS: Temporal Cloud Crawler Integration v1.0.0 Dec 11, 2024

drichards-87 self-assigned this Dec 11, 2024

drichards-87 added the editorial review Waiting on a more in-depth review from a docs team editor label Dec 11, 2024

drichards-87 removed their assignment Dec 11, 2024

mauneelsorathia-crest added 2 commits December 12, 2024 15:10

Updated monitor message

4146696

Updated dashboard

b32e2a6

urseberry reviewed Dec 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[INTPLAT-448] DDSaaS: Temporal Cloud Crawler Integration v1.0.0 #19250

[INTPLAT-448] DDSaaS: Temporal Cloud Crawler Integration v1.0.0 #19250

mauneelsorathia-crest commented Dec 11, 2024

drichards-87 commented Dec 11, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

urseberry Dec 13, 2024

	[Temporal Cloud][1] is a scalable platform for orchestrating complex workflows, with built-in reliability, resilience and timing controls enabling developers to focus on application logic without worrying about fault tolerance and consistency.
	[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.

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


		This integration collects Temporal Cloud metrics and directs them into Datadog to provide insights into system health, workflow efficiency, task execution and performance bottlenecks.

	1. In order to generate security CA Certificate and End-entity Certificate refer to this [link][2].
	1. To generate a CA certificate and an end-entity certificate, see [certificate management][2].

	- Note: It is recommended to define longer expiry duration of the certificates.
	- 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.
	2. Log in to [Temporal Cloud][3] with an account owner or global admin role.

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

	\|End-entity Certificate key file content\|Content of End-entity Certificate key for secure access and communication with 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.

	2. Click the Save button to save your settings.
	2. Click the Save button to save your settings.

	The Temporal Cloud integration collects and forwards Frontend Service metrics, Poll metrics, Replication lag metrics, Schedule metrics, Service latency metrics and Workflow metrics to Datadog. See [metadata.csv][4] for a list of metrics provided by this integration.
	See [metadata.csv][4] for a list of metrics provided by this integration.

	temporal_cloud.cloud_metrics.v0_schedule_buffer_overruns_increase1m,count,60,,,"When average schedule run length is greater than average schedule interval while a buffer_all overlap policy is configured, this is increase in count of such scheduled workflow executions",-1,temporal_cloud,Schedule Buffer Overruns,,
	temporal_cloud.cloud_metrics.v0_schedule_buffer_overruns_increase1m,count,60,,,"When average schedule run length is greater than average schedule interval while a buffer_all overlap policy is configured, this is the increase in count of such scheduled workflow executions",-1,temporal_cloud,Schedule Buffer Overruns,,

[INTPLAT-448] DDSaaS: Temporal Cloud Crawler Integration v1.0.0 #19250

Are you sure you want to change the base?

[INTPLAT-448] DDSaaS: Temporal Cloud Crawler Integration v1.0.0 #19250

Conversation

mauneelsorathia-crest commented Dec 11, 2024

What does this PR do?

Motivation

Review checklist (to be filled by reviewers)

drichards-87 commented Dec 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment