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] Notify legacy Synthetics integration being deprecated #150287

Closed
Tracked by #137508
paulb-elastic opened this issue Feb 6, 2023 · 13 comments · Fixed by #150437
Closed
Tracked by #137508

[Synthetics] Notify legacy Synthetics integration being deprecated #150287

paulb-elastic opened this issue Feb 6, 2023 · 13 comments · Fixed by #150437
Assignees
Labels
Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability

Comments

@paulb-elastic
Copy link
Contributor

paulb-elastic commented Feb 6, 2023

As part of deprecating the Synthetics Integration in 8.8 (#137505) we need stronger messaging in 8.7 to make this clear to start moving monitors across.

ACs:

  • If there are any Synthetics Integration monitors configured (browser Zip URL and/or Inline, or any leigthweight monitor types), add a notification banner to the top of Uptime
  • In the edit flow of the existing Integration Policy, add a notification
  • Add details to the main integration Overview
  • The notification should be along the lines of (copy to be checked by @florent-leborgne)

    You have at least one Elastic Synthetics Integration monitor configured. These monitors will stop running and become inaccessible from 8.8. Please migrate them over to either Project Monitors (most useful for Zip URL Integration monitor types) or add them to the Synthetics App (most useful for Inline Synthetics Integration monitor types). See the docs for more information.

  • Add details about the upcoming deprecation to the release note for 8.7
@paulb-elastic paulb-elastic added the Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability label Feb 6, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/uptime (Team:uptime)

@florent-leborgne
Copy link
Contributor

florent-leborgne commented Feb 6, 2023

Hi @paulb-elastic, here's an attempt on the wording for the banner:


Migrate your Elastic Synthetics integration monitors before Elastic 8.8

You have at least one monitor configured using the Elastic Synthetics integration.
 These monitors will stop running and become unavailable from Elastic 8.8. 
To avoid this, migrate them to Project monitors or add them to the new Synthetics app directly available in Observability before the 8.8 update.

Check our Synthetics migration docs for more details.


  • The migration docs linked for now use the name "Uptime app", so just a note to align the names or remember to also replicate the name change from 8.7 in these docs, (or use Uptime here if the renaming doesn't happen).
  • I've for now removed what you had suggested between brackets to shorten the message. I'd instead suggest to make these recommendations or tips clearer in the migration docs.
  • I've not used the word "deprecated" anywhere yet. But we could put it in the title as well to make it even clearer.

Hope this helps, feel free to adjust or ask for more input :)

Edit 1: Updated after @shahzad31's comment below.
Edit 2: Reverted to "stop running" wording after confirmation from Paul

@shahzad31
Copy link
Contributor

@florent-leborgne @paulb-elastic just to clarify one point

These monitors will stop running and become unavailable from Elastic 8.8. Monitors will not stop running. It's just that user will not be able to edit them. For monitors to stop running users will have to delete the integrations they have added.

@florent-leborgne
Copy link
Contributor

florent-leborgne commented Feb 6, 2023

Thanks for the additional context @shahzad31! I've updated the wording suggestion to take this into account. I'd recommend making it clear in the linked docs that removing the old integrations is part of the migration process users should follow.

@afgomez afgomez self-assigned this Feb 6, 2023
@afgomez
Copy link
Contributor

afgomez commented Feb 6, 2023

To confirm, this refers to all monitors created via the synthetics integration, not only the browser ones, correct?

@paulb-elastic
Copy link
Contributor Author

Monitors stpping running

That was the requirement in #137505 but it seems it isn't possible

To confirm, this refers to all monitors created via the synthetics integration, not only the browser ones, correct?

@afgomez correct, any monitor configured via the Synthetics Integration will trigger the warning message (I have updated the description to clarify this, as it wasn't clear, thanks)

@afgomez
Copy link
Contributor

afgomez commented Feb 7, 2023

Thank you @paulb-elastic!

I think it also makes sense to update the integration description itself, explaining that it is deprecated and monitors should be migrated

Screenshot 2023-02-07 at 15 12 10

@paulb-elastic
Copy link
Contributor Author

update the integration description itself

Good idea, I'l add to the description

@paulb-elastic
Copy link
Contributor Author

@florent-leborgne @afgomez we've confirmed that monitors will stop running from 8.8 (albeit we will implement this in Beats now).

As such, please ensure the messaging makes it clear we will be stopping them running in the next version and they will be inaccessible.

(we won't auto delete them, but the UI won't be there to allow them to see the configuration, and they won't run anymore)

@florent-leborgne
Copy link
Contributor

@paulb-elastic I've reverted some of the wording suggestion in my previous comment to reflect your update.
Hope this helps.

afgomez pushed a commit that referenced this issue Feb 8, 2023
…on monitors (#150437)

Closes #150287 

## Summary

Adds or updates deprecation notices regarding the synthetics integration
when the user has monitors created through it.

## Screenshots

In the Uptime UI:

<img width="1280" alt="Screenshot 2023-02-07 at 15 10 37"
src="https://user-images.githubusercontent.com/57448/217268105-c2dcd6ad-556e-4c88-ace2-4f3be6fb9576.png">

When editing an integration:

<img width="1259" alt="Screenshot 2023-02-07 at 15 44 57"
src="https://user-images.githubusercontent.com/57448/217277804-c54cfcd0-b1e6-4b42-9f4a-b08167c8b2a1.png">
@paulb-elastic
Copy link
Contributor Author

It seems the main Integration Overview doesn't have an updated banner yet (have asked @dominiqueclarke, this may need to be changed in the Integration rather than Kibana).

Also the docs link is going to ...synthetics-get-started-project.html#synthetic-monitor-choose-project instead of ...synthetics-migrate-from-integration.html, I've raised #150872 to cover this.

@paulb-elastic
Copy link
Contributor Author

Created elastic/integrations#5258 for the last AC

@dominiqueclarke dominiqueclarke self-assigned this Mar 6, 2023
@dominiqueclarke
Copy link
Contributor

Post FF testing LGTM in 8.7.0-SNAPSHOT

Screen Shot 2023-03-07 at 11 24 06 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants