forked from temporalio/sdk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_runtime.py
More file actions
256 lines (221 loc) · 8.93 KB
/
Copy pathtest_runtime.py
File metadata and controls
256 lines (221 loc) · 8.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
import logging
import logging.handlers
import queue
import re
import uuid
from datetime import timedelta
from typing import List, cast
from urllib.request import urlopen
from temporalio import workflow
from temporalio.client import Client
from temporalio.runtime import (
LogForwardingConfig,
LoggingConfig,
PrometheusConfig,
Runtime,
TelemetryConfig,
TelemetryFilter,
)
from temporalio.worker import Worker
from tests.helpers import assert_eq_eventually, assert_eventually, find_free_port
@workflow.defn
class HelloWorkflow:
@workflow.run
async def run(self, name: str) -> str:
return f"Hello, {name}!"
async def test_different_runtimes(client: Client):
# Create two workers in separate runtimes and run workflows on them.
# Confirm they each have different Prometheus addresses.
prom_addr1 = f"127.0.0.1:{find_free_port()}"
client1 = await Client.connect(
client.service_client.config.target_host,
namespace=client.namespace,
runtime=Runtime(
telemetry=TelemetryConfig(metrics=PrometheusConfig(bind_address=prom_addr1))
),
)
prom_addr2 = f"127.0.0.1:{find_free_port()}"
client2 = await Client.connect(
client.service_client.config.target_host,
namespace=client.namespace,
runtime=Runtime(
telemetry=TelemetryConfig(metrics=PrometheusConfig(bind_address=prom_addr2))
),
)
async def run_workflow(client: Client):
task_queue = f"task-queue-{uuid.uuid4()}"
async with Worker(client, task_queue=task_queue, workflows=[HelloWorkflow]):
assert "Hello, World!" == await client.execute_workflow(
HelloWorkflow.run,
"World",
id=f"workflow-{uuid.uuid4()}",
task_queue=task_queue,
)
await run_workflow(client1)
await run_workflow(client2)
# Get prom metrics on each
with urlopen(url=f"http://{prom_addr1}/metrics") as f:
assert "long_request" in f.read().decode("utf-8")
with urlopen(url=f"http://{prom_addr2}/metrics") as f:
assert "long_request" in f.read().decode("utf-8")
async def test_runtime_log_forwarding():
# Create logger with record capture
log_queue: queue.Queue[logging.LogRecord] = queue.Queue()
log_queue_list = cast(List[logging.LogRecord], log_queue.queue)
logger = logging.getLogger(f"log-{uuid.uuid4()}")
logger.addHandler(logging.handlers.QueueHandler(log_queue))
async def log_queue_len() -> int:
return len(log_queue_list)
# Create runtime
runtime = Runtime(
telemetry=TelemetryConfig(
logging=LoggingConfig(
filter=TelemetryFilter(core_level="DEBUG", other_level="ERROR"),
forwarding=LogForwardingConfig(logger=logger),
)
)
)
# Set capture only info logs
logger.setLevel(logging.INFO)
# Write some logs
runtime._core_runtime.write_test_info_log("info1", "extra1")
runtime._core_runtime.write_test_debug_log("debug2", "extra2")
runtime._core_runtime.write_test_info_log("info3", "extra3")
# Check the expected records
await assert_eq_eventually(2, log_queue_len)
assert log_queue_list[0].levelno == logging.INFO
assert log_queue_list[0].message.startswith(
"[sdk_core::temporal_sdk_bridge::runtime] info1"
)
assert (
log_queue_list[0].name
== f"{logger.name}-sdk_core::temporal_sdk_bridge::runtime"
)
assert log_queue_list[0].created == log_queue_list[0].temporal_log.time # type: ignore
assert log_queue_list[0].temporal_log.fields == {"extra_data": "extra1"} # type: ignore
assert log_queue_list[1].levelno == logging.INFO
assert log_queue_list[1].message.startswith(
"[sdk_core::temporal_sdk_bridge::runtime] info3"
)
# Clear logs and enable debug and try again
log_queue_list.clear()
logger.setLevel(logging.DEBUG)
runtime._core_runtime.write_test_info_log("info4", "extra4")
runtime._core_runtime.write_test_debug_log("debug5", "extra5")
runtime._core_runtime.write_test_info_log("info6", "extra6")
await assert_eq_eventually(3, log_queue_len)
assert log_queue_list[0].levelno == logging.INFO
assert log_queue_list[0].message.startswith(
"[sdk_core::temporal_sdk_bridge::runtime] info4"
)
assert log_queue_list[1].levelno == logging.DEBUG
assert log_queue_list[1].message.startswith(
"[sdk_core::temporal_sdk_bridge::runtime] debug5"
)
assert log_queue_list[2].levelno == logging.INFO
assert log_queue_list[2].message.startswith(
"[sdk_core::temporal_sdk_bridge::runtime] info6"
)
@workflow.defn
class TaskFailWorkflow:
@workflow.run
async def run(self) -> None:
raise RuntimeError("Intentional error")
async def test_runtime_task_fail_log_forwarding(client: Client):
# Client with lo capturing runtime
log_queue: queue.Queue[logging.LogRecord] = queue.Queue()
log_queue_list = cast(List[logging.LogRecord], log_queue.queue)
logger = logging.getLogger(f"log-{uuid.uuid4()}")
logger.addHandler(logging.handlers.QueueHandler(log_queue))
logger.setLevel(logging.WARN)
client = await Client.connect(
client.service_client.config.target_host,
namespace=client.namespace,
runtime=Runtime(
telemetry=TelemetryConfig(
logging=LoggingConfig(
filter=TelemetryFilter(core_level="WARN", other_level="ERROR"),
forwarding=LogForwardingConfig(logger=logger),
)
)
),
)
# Start workflow
task_queue = f"task-queue-{uuid.uuid4()}"
async with Worker(client, task_queue=task_queue, workflows=[TaskFailWorkflow]):
handle = await client.start_workflow(
TaskFailWorkflow.run,
id=f"workflow-{uuid.uuid4()}",
task_queue=task_queue,
)
# Wait for log to appear
async def has_log() -> bool:
return any(
l for l in log_queue_list if "Failing workflow task" in l.message
)
await assert_eq_eventually(True, has_log)
# Check record
record = next((l for l in log_queue_list if "Failing workflow task" in l.message))
assert record.levelno == logging.WARNING
assert record.name == f"{logger.name}-sdk_core::temporal_sdk_core::worker::workflow"
assert record.temporal_log.fields["run_id"] == handle.result_run_id # type: ignore
async def test_prometheus_histogram_bucket_overrides(client: Client):
# Set up a Prometheus configuration with custom histogram bucket overrides
prom_addr = f"127.0.0.1:{find_free_port()}"
special_value = float(1234.5678)
histogram_overrides = {
"temporal_long_request_latency": [special_value / 2, special_value],
"custom_histogram": [special_value / 2, special_value],
}
runtime = Runtime(
telemetry=TelemetryConfig(
metrics=PrometheusConfig(
bind_address=prom_addr,
counters_total_suffix=False,
unit_suffix=False,
durations_as_seconds=False,
histogram_bucket_overrides=histogram_overrides,
),
),
)
# Create a custom histogram metric
custom_histogram = runtime.metric_meter.create_histogram(
"custom_histogram", "Custom histogram", "ms"
)
# Record a value to the custom histogram
custom_histogram.record(600)
# Create client with overrides
client_with_overrides = await Client.connect(
client.service_client.config.target_host,
namespace=client.namespace,
runtime=runtime,
)
async def run_workflow(client: Client):
task_queue = f"task-queue-{uuid.uuid4()}"
async with Worker(
client,
task_queue=task_queue,
workflows=[HelloWorkflow],
):
assert "Hello, World!" == await client.execute_workflow(
HelloWorkflow.run,
"World",
id=f"workflow-{uuid.uuid4()}",
task_queue=task_queue,
)
await run_workflow(client_with_overrides)
async def check_metrics() -> None:
with urlopen(url=f"http://{prom_addr}/metrics") as f:
metrics_output = f.read().decode("utf-8")
for key, buckets in histogram_overrides.items():
assert (
key in metrics_output
), f"Missing {key} in full output: {metrics_output}"
for bucket in buckets:
# expect to have {key}_bucket and le={bucket} in the same line with arbitrary strings between them
regex = re.compile(f'{key}_bucket.*le="{bucket}"')
assert regex.search(
metrics_output
), f"Missing bucket for {key} in full output: {metrics_output}"
# Wait for metrics to appear and match the expected buckets
await assert_eventually(check_metrics)