You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: temporal/README.md
+82-4Lines changed: 82 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -17,17 +17,28 @@ No additional installation is needed on your server.
17
17
18
18
### Configuration
19
19
20
+
<!-- xxx tabs xxx -->
21
+
<!-- xxx tab "Host" xxx -->
22
+
23
+
#### Host
24
+
25
+
##### Metric collection
26
+
20
27
1. Configure your Temporal services to expose metrics via a `prometheus` endpoint by following the [official Temporal documentation][10].
21
28
22
29
2. Edit the `temporal.d/conf.yaml` file located in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Temporal performance data.
23
30
24
-
To get started, configure the `openmetrics_endpoint` option to match the `listenAddress` and `handlerPath` options from your Temporal server configuration.
31
+
Configure the `openmetrics_endpoint` option to match the `listenAddress` and `handlerPath` options from your Temporal server configuration.
25
32
26
-
Note that when Temporal services in a cluster are deployed independently, every service exposes its own metrics. As a result, you need to configure the `prometheus` endpoint for every service that you want to monitor and define a separate `instance` on the integration's configuration for each of them.
See the [sample temporal.d/conf.yaml][4]for all available configuration options.
39
+
Note that when Temporal services in a cluster are deployed independently, every service exposes its own metrics. As a result, you need to configure the `prometheus` endpoint for every service that you want to monitor and define a separate `instance` on the integration's configuration for each of them.
29
40
30
-
#### Log collection
41
+
##### Log collection
31
42
32
43
1. Collecting logs is disabled by default in the Datadog Agent. Enable it in your `datadog.yaml` file:
33
44
@@ -48,6 +59,68 @@ See the [sample temporal.d/conf.yaml][4] for all available configuration options
48
59
49
60
4. [Restart the Agent][5].
50
61
62
+
<!-- xxz tab xxx -->
63
+
64
+
<!-- xxx tab "Containerized" xxx -->
65
+
66
+
#### Containerized
67
+
68
+
##### Metric collection
69
+
70
+
For containerized environments, refer to [Configure integrations with Autodiscovery on Kubernetes][14] or [Configure integrations with Autodiscovery on Docker][15] for instructions on using the parameters below. See the [sample temporal.d/conf.yaml][4] for a complete list of configuration options.
| `<INSTANCES_CONFIG>` | `{"openmetrics_endpoint": "<LISTEN_ADDRESS>/<HANDLER_PATH>"}`, where `<LISTEN_ADDRESS>` and `<HANDLER_PATH>` are replaced by the `listenAddress` and `handlerPath` from your Temporal server configuration. |
77
+
78
+
Note that when Temporal services in a cluster are deployed independently, every service exposes its own metrics. As a result, you need to configure the `prometheus` endpoint for every service that you want to monitor and define a separate `instance` on the integration's configuration for each of them.
79
+
80
+
**Example**
81
+
82
+
The following Kubernetes annotation is applied to a pod under `metadata`, where `<CONTAINER_NAME>` is the name of your Temporal container (or a [custom identifier][16]):
The following Kubernetes annotation is applied to a pod under `metadata`, where `<CONTAINER_NAME>` is the name of your Temporal container (or a [custom identifier][16]):
107
+
108
+
```
109
+
ad.datadoghq.com/<CONTAINER_NAME>.logs: |
110
+
[
111
+
{
112
+
"source": "temporal",
113
+
"type": "file",
114
+
"path": "/var/log/temporal/temporal-server.log"
115
+
}
116
+
]
117
+
```
118
+
119
+
<!-- xxz tab xxx -->
120
+
121
+
<!-- xxz tabs xxx -->
122
+
123
+
51
124
### Validation
52
125
53
126
[Run the Agent's status subcommand][6] and look for `temporal` under the Checks section.
@@ -94,3 +167,8 @@ Additional helpful documentation, links, and articles:
0 commit comments