Skip to content

Change telemetry request to use persistent session http proxy #637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 15, 2025
Merged

Change telemetry request to use persistent session http proxy #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions payu/telemetry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
# Required telemetry configuration fields
CONFIG_FIELDS = {
"URL": "telemetry_url",
"PROXY_URL": "telemetry_proxy_url",
"TOKEN": "telemetry_token",
"SERVICE_NAME": "telemetry_service_name",
"HOST": "telemetry_host",
"HOSTNAME": "hostname",
}

Expand Down Expand Up @@ -185,10 +185,10 @@ def write_error_log(


def post_telemetry_data(url: str,
proxy_url: str,
token: str,
data: dict[str, Any],
service_name: str,
host: str,
archive_path: Path,
job_file_path: Path,
request_timeout: int = REQUEST_TIMEOUT,
Expand All @@ -199,14 +199,14 @@ def post_telemetry_data(url: str,
----------
url: str
Endpoint for the telemetry
proxy_url: str
Proxy URL for the telemetry record request
token: str
Header token for the telemetry request
data: dict[str, Any]
Data to be posted in the telemetry request
service_name: str
Service name for the telemetry record
host: str
Host for the telemetry record header
archive_path: Path
Path to the archive directory for the experiment. This is used for
writing error logs if the telemetry request fails
Expand All @@ -219,7 +219,6 @@ def post_telemetry_data(url: str,
headers = {
"Content-type": "application/json",
"Authorization": "Token " + token,
"HOST": host,
}

data = {
Expand All @@ -234,7 +233,7 @@ def post_telemetry_data(url: str,
data=json.dumps(data),
headers=headers,
timeout=request_timeout,
verify=False
proxies={"https": proxy_url, "http": proxy_url},
)
if response.status_code >= 400:
error_message = (
Expand Down Expand Up @@ -279,10 +278,10 @@ def record_telemetry(run_info: dict[str, Any],
target=post_telemetry_data,
kwargs={
"url": external_config[CONFIG_FIELDS["URL"]],
"proxy_url": external_config[CONFIG_FIELDS["PROXY_URL"]],
"token": external_config[CONFIG_FIELDS["TOKEN"]],
"data": run_info,
"service_name": external_config[CONFIG_FIELDS["SERVICE_NAME"]],
"host": external_config[CONFIG_FIELDS["HOST"]],
"archive_path": archive_path,
"job_file_path": job_file_path,
},
Expand Down
9 changes: 4 additions & 5 deletions test/test_telemetry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ def setup_config(config_path):
"hostname": "gadi",
"telemetry_service_name": "payu",
"telemetry_token": "some_token",
"telemetry_host": "some_host",
"telemetry_proxy_url": "some_persistent_session_url",
}
with open(config_path, 'w') as f:
json.dump(config_data, f)
Expand Down Expand Up @@ -172,7 +172,7 @@ def test_get_external_telemetry_config_no_file(
"hostname",
"telemetry_service_name",
"telemetry_token",
"telemetry_host"
"telemetry_proxy_url"
])
def test_get_external_telemetry_config_missing_fields(
tmp_path, setup_env, config_path, missing_field
Expand All @@ -182,7 +182,7 @@ def test_get_external_telemetry_config_missing_fields(
"hostname": "gadi",
"telemetry_service_name": "payu",
"telemetry_token": "some_token",
"telemetry_host": "some_host",
"telemetry_proxy_url": "some_persistent_session_url",
}
# Remove the specified missing field
config_data.pop(missing_field)
Expand Down Expand Up @@ -523,10 +523,9 @@ def start_side_effect():
assert kwargs.get('headers') == {
'Content-type': 'application/json',
'Authorization': 'Token some_token',
'HOST': 'some_host',
}
assert kwargs.get('timeout') == 10
assert kwargs.get('verify') is False
assert kwargs.get('proxies') == {"https": "some_persistent_session_url", "http": "some_persistent_session_url"}

assert sent_data["service"] == "payu"
assert sent_data["version"] == "1.0.0"
Expand Down
Loading