Temporal Cloud integration

Install the infrastructure agent

To use the Temporal Cloud integration, you need to first install the infrastructure agent on the same host. The infrastructure agent monitors the host itself, while the integration you'll install in the next step extends your monitoring with Temporal-specific data such as database and instance metrics.

Configure nri-flex for Temporal Cloud

Once the Temporal Cloud metrics are exposed on the Prometheus endpoint, accessible via https://<account-id>.tmprl.cloud/prometheus, you will need to configure your setup accordingly.

1. Create file with named nri-flex-temporal-cloud-config.yml in this path:

   bash

   Copy

   $
   touch /etc/newrelic-infra/integrations.d/

2. Below is a nri-flex configuration file. Be sure to copy and paste its contents into your previously created nri-flex-temporal-cloud-config.yml file, and remember to update your account ID in the Prometheus endpoint URL, as well as the paths for the certificate files:

   integrations:
    - name: nri-flex
      config:
        name: temporalCloudIntegration
        global:
          base_url: https://<your_account_id>.tmprl.cloud/prometheus/api/v1/
          headers:
            accept: application/json
          tls_config:
            enable: true
            key: /certs/client.key
            cert: /certs/client.pem
        interval: 60s
        timeout: 55s
        apis:
          - event_type: temporalCloudFrontendServiceError
            # sum(increase(temporal_cloud_v0_frontend_service_error_count[1m])) by (temporal_namespace,operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_frontend_service_error_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2Coperation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudFrontendServiceRequest
            # sum(increase(temporal_cloud_v0_frontend_service_request_count[1m])) by (temporal_namespace,operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_frontend_service_request_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2Coperation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudPollSuccess
            # sum(increase(temporal_cloud_v0_poll_success_count[1m])) by (temporal_namespace,operation,task_type)
            url: query?query=sum%28increase%28temporal_cloud_v0_poll_success_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2Coperation%2Ctask_type%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudPollSuccessSync
            # sum(increase(temporal_cloud_v0_poll_success_sync_count[1m])) by (temporal_namespace,operation,task_type)
            url: query?query=sum%28increase%28temporal_cloud_v0_poll_success_sync_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2Coperation%2Ctask_type%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudPollTimeout
            # sum(increase(temporal_cloud_v0_poll_timeout_count[1m])) by (temporal_namespace,operation,task_type)
            url: query?query=sum%28increase%28temporal_cloud_v0_poll_timeout_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2Coperation%2Ctask_type%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudResourceExhaustedErrors
            # sum(increase(temporal_cloud_v0_resource_exhausted_error_count[1m])) by (temporal_namespace,resource_exhausted_cause)
            url: query?query=sum%28increase%28temporal_cloud_v0_resource_exhausted_error_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2Cresource_exhausted_cause%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudScheduleActionSuccess
            # sum(increase(temporal_cloud_v0_schedule_action_success_count[1m])) by (temporal_namespace)
            url: query?query=sum%28increase%28temporal_cloud_v0_schedule_action_success_count%5B1m%5D%29%29%20by%20%28temporal_namespace%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudScheduleBufferOverruns
            # sum(increase(temporal_cloud_v0_schedule_buffer_overruns_count[1m])) by (temporal_namespace)
            url: query?query=sum%28increase%28temporal_cloud_v0_schedule_buffer_overruns_count%5B1m%5D%29%29%20by%20%28temporal_namespace%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudScheduleMissedCatchupWindow
            # sum(increase(temporal_cloud_v0_schedule_missed_catchup_window_count[1m])) by (temporal_namespace)
            url: query?query=sum%28increase%28temporal_cloud_v0_schedule_missed_catchup_window_count%5B1m%5D%29%29%20by%20%28temporal_namespace%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudScheduleRateLimited
            # sum(increase(temporal_cloud_v0_schedule_rate_limited_count[1m])) by (temporal_namespace)
            url: query?query=sum%28increase%28temporal_cloud_v0_schedule_rate_limited_count%5B1m%5D%29%29%20by%20%28temporal_namespace%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudStateTransition
            # sum(increase(temporal_cloud_v0_state_transition_count[1m])) by (temporal_namespace)
            url: query?query=sum%28increase%28temporal_cloud_v0_state_transition_count%5B1m%5D%29%29%20by%20%28temporal_namespace%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudTotalAction
            # sum(increase(temporal_cloud_v0_total_action_count[1m])) by (temporal_namespace, namespace_mode)
            url: query?query=sum%28increase%28temporal_cloud_v0_total_action_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2C%20namespace_mode%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudWorkflowCancel
            # sum(increase(temporal_cloud_v0_workflow_cancel_count[1m])) by (temporal_namespace, operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_workflow_cancel_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2C%20operation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudWorkflowContinued
            # sum(increase(temporal_cloud_v0_workflow_continued_as_new_count[1m])) by (temporal_namespace, operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_workflow_continued_as_new_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2C%20operation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudWorkflowFailed
            # sum(increase(temporal_cloud_v0_workflow_failed_count[1m])) by (temporal_namespace, operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_workflow_failed_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2C%20operation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudWorkflowSuccess
            # sum(increase(temporal_cloud_v0_workflow_success_count[1m])) by (temporal_namespace, operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_workflow_success_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2C%20operation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudWorkflowTerminate
            # sum(increase(temporal_cloud_v0_workflow_terminate_count[1m])) by (temporal_namespace, operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_workflow_terminate_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2C%20operation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudWorkflowTimeout
            # sum(increase(temporal_cloud_v0_workflow_timeout_count[1m])) by (temporal_namespace, operation)
            url: query?query=sum%28increase%28temporal_cloud_v0_workflow_timeout_count%5B1m%5D%29%29%20by%20%28temporal_namespace%2C%20operation%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudWorkflowExecutionLatencySecP95
            # histogram_quantile(0.95, sum(rate(temporal_cloud_v0_service_latency_bucket[1m] offset 1m)) by (temporal_namespace, operation, le))
            url: query?query=histogram_quantile%280.95%2C%20sum%28rate%28temporal_cloud_v0_service_latency_bucket%5B1m%5D%20offset%201m%29%29%20by%20%28temporal_namespace%2C%20operation%2C%20le%29%29
            split_array: true
            leaf_array: true
          - event_type: temporalCloudReplicationLagSecP95
            # histogram_quantile(0.95, sum(rate(temporal_cloud_v0_replication_lag_bucket[1m] offset 1m)) by (temporal_namespace, le))
            url: query?query=histogram_quantile%280.95%2C%20sum%28rate%28temporal_cloud_v0_replication_lag_bucket%5B1m%5D%20offset%201m%29%29%20by%20%28temporal_namespace%2C%20le%29%29
            split_array: true
            leaf_array: true

   Copy

3. Use our instructions to restart your infrastructure agent:

   bash

   Copy

   $
   sudo systemctl restart newrelic-infra.service

4. Wait a few minutes until data starts folowing into your New Relic account.

Find your data

You can choose our pre-built dashboard template named Temporal Cloud to monitor your Temporal Cloud metrics. Follow these steps to use our pre-built dashboard template:

1. From one.newrelic.com, go to the + Integrations & Agents page.

2. Click on Dashboards.

3. In the search bar, type Temporal Cloud.

4. The Temporal Cloud dashboard should appear. Click on it to install it.

   Your Temporal Cloud dashboard is considered a custom dashboard and can be found in the Dashboards UI. For docs on using and editing dashboards, see our dashboard docs.

   Here is a NRQL query to check the Temporal Cloud frontend service requests count:

   FROM temporalCloudFrontendServiceRequest SELECT latest(`data.result-value1`) FACET `data.result-metric-__name__`

   Copy