Repository navigation
feat(orchestrator): Add refresh duration and completion lag metrics #425
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.
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| """Tests for the orchestrator metric helpers.""" | ||
|
|
||
| import datetime | ||
| from unittest import mock | ||
|
|
||
| import pytest | ||
|
|
||
| from cloud_pipelines_backend import backend_types_sql as bts | ||
| from cloud_pipelines_backend.instrumentation import metrics | ||
|
|
||
|
|
||
| @pytest.fixture() | ||
| def refresh_duration(monkeypatch: pytest.MonkeyPatch) -> mock.MagicMock: | ||
| histogram = mock.MagicMock() | ||
| monkeypatch.setattr(metrics, "container_execution_refresh_duration", histogram) | ||
| return histogram | ||
|
|
||
|
|
||
| @pytest.fixture() | ||
| def completion_lag_duration(monkeypatch: pytest.MonkeyPatch) -> mock.MagicMock: | ||
| histogram = mock.MagicMock() | ||
| monkeypatch.setattr( | ||
| metrics, "container_execution_completion_lag_duration", histogram | ||
| ) | ||
| return histogram | ||
|
|
||
|
|
||
| def _seconds_ago(seconds: float) -> datetime.datetime: | ||
| return datetime.datetime.now(tz=datetime.timezone.utc) - datetime.timedelta( | ||
| seconds=seconds | ||
| ) | ||
|
|
||
|
|
||
| def test_refresh_duration_records_each_phase_in_seconds(refresh_duration): | ||
| metrics.record_refresh_duration( | ||
| queries_duration_ms=250, processing_duration_ms=1500 | ||
| ) | ||
|
|
||
| assert refresh_duration.record.call_args_list == [ | ||
| mock.call(0.25, attributes={"container_execution.refresh.phase": "queries"}), | ||
| mock.call(1.5, attributes={"container_execution.refresh.phase": "processing"}), | ||
| ] | ||
|
|
||
|
|
||
| def test_completion_lag_records_seconds_since_the_container_ended( | ||
| completion_lag_duration, | ||
| ): | ||
| metrics.record_completion_lag( | ||
| ended_at=_seconds_ago(42), status=bts.ContainerExecutionStatus.FAILED | ||
| ) | ||
|
|
||
| (seconds,), kwargs = completion_lag_duration.record.call_args | ||
| assert 42 <= seconds < 43 | ||
| assert kwargs == {"attributes": {"container_execution.status": "FAILED"}} | ||
|
|
||
|
|
||
| def test_completion_lag_clamps_an_end_time_in_the_future_to_zero( | ||
| completion_lag_duration, | ||
| ): | ||
| metrics.record_completion_lag( | ||
| ended_at=_seconds_ago(-5), status=bts.ContainerExecutionStatus.SUCCEEDED | ||
| ) | ||
|
|
||
| (seconds,), _ = completion_lag_duration.record.call_args | ||
| assert seconds == 0.0 | ||
|
|
||
|
|
||
| def test_completion_lag_treats_a_naive_end_time_as_utc(completion_lag_duration): | ||
| metrics.record_completion_lag( | ||
| ended_at=_seconds_ago(42).replace(tzinfo=None), | ||
| status=bts.ContainerExecutionStatus.SUCCEEDED, | ||
| ) | ||
|
|
||
| (seconds,), _ = completion_lag_duration.record.call_args | ||
| assert 42 <= seconds < 43 | ||
|
|
||
|
|
||
| def test_completion_lag_skips_a_missing_end_time(completion_lag_duration): | ||
| metrics.record_completion_lag( | ||
| ended_at=None, status=bts.ContainerExecutionStatus.SUCCEEDED | ||
| ) | ||
|
|
||
| completion_lag_duration.record.assert_not_called() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.