Skip to content
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

[Synthetics] Remove legacy screenshot image codepath #172684

Merged

Conversation

justinkambic
Copy link
Contributor

@justinkambic justinkambic commented Dec 6, 2023

Summary

We have not used full screenshot image data since early alpha versions of Synthetics, and there is no reason to not use screenshot blocks instead as they make far more efficient storage performance.

Removes the route that returns full image data. I may later include changes to remove references to this on the client as well, or do that in a follow-up.

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

@justinkambic justinkambic added bug Fixes for quality problems that affect the customer experience release_note:fix v8.12.0 Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Dec 6, 2023
@justinkambic justinkambic self-assigned this Dec 6, 2023
@justinkambic justinkambic requested a review from a team as a code owner December 6, 2023 14:07
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@justinkambic justinkambic force-pushed the remove-legacy-screenshot-codepath branch 2 times, most recently from 7f82759 to 8b3cece Compare December 6, 2023 21:55
@justinkambic justinkambic force-pushed the remove-legacy-screenshot-codepath branch from 8b3cece to 72342f2 Compare December 7, 2023 21:30
@justinkambic justinkambic force-pushed the remove-legacy-screenshot-codepath branch from aa946c6 to 36f2aef Compare December 8, 2023 14:45
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @justinkambic

@justinkambic justinkambic merged commit 8d3e8cd into elastic:main Dec 8, 2023
37 of 38 checks passed
@justinkambic justinkambic deleted the remove-legacy-screenshot-codepath branch December 8, 2023 17:13
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 8, 2023
## Summary

We have not used full screenshot image data since early alpha versions
of Synthetics, and there is no reason to _not_ use screenshot blocks
instead as they make far more efficient storage performance.

Removes the route that returns full image data. I may later include
changes to remove references to this on the client as well, or do that
in a follow-up.

(cherry picked from commit 8d3e8cd)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.12

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Dec 8, 2023
…#172980)

# Backport

This will backport the following commits from `main` to `8.12`:
- [[Synthetics] Remove legacy screenshot image codepath
(#172684)](#172684)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Justin
Kambic","email":"jk@elastic.co"},"sourceCommit":{"committedDate":"2023-12-08T17:13:45Z","message":"[Synthetics]
Remove legacy screenshot image codepath (#172684)\n\n##
Summary\r\n\r\nWe have not used full screenshot image data since early
alpha versions\r\nof Synthetics, and there is no reason to _not_ use
screenshot blocks\r\ninstead as they make far more efficient storage
performance.\r\n\r\nRemoves the route that returns full image data. I
may later include\r\nchanges to remove references to this on the client
as well, or do that\r\nin a
follow-up.","sha":"8d3e8cd838ad80f8955c986fe830a9e6590a60de","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:fix","v8.12.0","Team:obs-ux-infra_services","Team:uptime","v8.13.0"],"number":172684,"url":"#172684
Remove legacy screenshot image codepath (#172684)\n\n##
Summary\r\n\r\nWe have not used full screenshot image data since early
alpha versions\r\nof Synthetics, and there is no reason to _not_ use
screenshot blocks\r\ninstead as they make far more efficient storage
performance.\r\n\r\nRemoves the route that returns full image data. I
may later include\r\nchanges to remove references to this on the client
as well, or do that\r\nin a
follow-up.","sha":"8d3e8cd838ad80f8955c986fe830a9e6590a60de"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"8.12","label":"v8.12.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","labelRegex":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"#172684
Remove legacy screenshot image codepath (#172684)\n\n##
Summary\r\n\r\nWe have not used full screenshot image data since early
alpha versions\r\nof Synthetics, and there is no reason to _not_ use
screenshot blocks\r\ninstead as they make far more efficient storage
performance.\r\n\r\nRemoves the route that returns full image data. I
may later include\r\nchanges to remove references to this on the client
as well, or do that\r\nin a
follow-up.","sha":"8d3e8cd838ad80f8955c986fe830a9e6590a60de"}}]}]
BACKPORT-->

Co-authored-by: Justin Kambic <jk@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience release_note:fix Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team v8.12.0 v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants