[synthetics] Document the new Synthetics Recorder #1953

colleenmcginnis · 2022-06-27T21:43:59Z

Closes #1907

Overview

This PR adds information on the Synthetics Recorder including:

Mentioning the Synthetics Recorder in the existing Write a synthetic test guide as an option for creating journeys.
Creating a new page with detailed information on the Synthetics Recorder UI.

To do

@colleenmcginnis @paulb-elastic @justinkambic @kyungeunni agree on how info on the Synthetics Recorder fit into the current docs
@colleenmcginnis refine language
@justinkambic @kyungeunni @paulb-elastic (+ others as needed) review
@colleenmcginnis clean up for publication
- address feedback
- lint content

For the reviewer

Is the product name "Script Recorder" or "Synthetics Recorder"?
Can you take a look at this very rough PR and let me know what you think? (There are a few comments in the files with more context.)

add to index

apmmachine · 2022-06-27T21:44:32Z

A documentation preview will be available soon:

mergify · 2022-06-27T21:44:33Z

This pull request does not have a backport label. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
NOTE: backport-skip has been added to this pull request.

kyungeunni

So exciting, Thanks for the great work!! I can see all the important points are covered ✨

docs/en/observability/synthetics-recorder.asciidoc

justinkambic

I've left a few comments in areas where I felt I could add some detail. Happy to follow up discussion on any of the topics.

docs/en/observability/synthetics-create-test.asciidoc

docs/en/observability/synthetics-recorder.asciidoc

colleenmcginnis · 2022-07-06T21:31:34Z

Thanks @kyungeunni @justinkambic! I'm going to dive back into this now. 🏊

docs/en/observability/synthetics-recorder.asciidoc

kyungeunni · 2022-07-14T15:50:11Z

docs/en/observability/synthetics-recorder.asciidoc

+* Click **Export** to save a JavaScript file containing all steps.
+
+// suite --> project?
+You can also check **Export as a suite** and either copy and paste or **Export**


This change is merged to main branch but not released yet, I'm planning to release another version next week. Would you want me to capture a screenshot with updated wording? (project instead suite)

Sure! That would be helpful.

Here you go. I tried to create the journey as same as yours but it is slightly different.

kyungeunni · 2022-07-19T10:41:01Z

docs/en/observability/synthetics-create-test.asciidoc

+Use the Synthetics Recorder to generate code for one or more steps by interacting with a web page directly.
+
+// Some high-level details on what it does
+The recorder launches a special https://www.chromium.org/Home/[Chromium browser] that will listen to each interaction you have with the web page and record them internally.


Not sure about the special wording here, AFAIK it's a normal Chromium browser that is used by Playwright.

Suggested change

The recorder launches a special https://www.chromium.org/Home/[Chromium browser] that will listen to each interaction you have with the web page and record them internally.

The recorder launches a https://www.chromium.org/Home/[Chromium browser] that will listen to each interaction you have with the web page and record them internally using Playwright.

My thought WRT to "special" is that it's instrumented by Playwright, but that this semantic depth might be a bit beyond what our users know or care about the internal workings of the recorder. But yes, the actual Chromium bin is just like any other you'd find someone using.

kyungeunni · 2022-07-19T10:43:56Z

docs/en/observability/synthetics-create-test.asciidoc

+
+// Some high-level details on what it does
+The recorder launches a special https://www.chromium.org/Home/[Chromium browser] that will listen to each interaction you have with the web page and record them internally.
+When you're done interacting with the page, the recorder converts the recorded actions into usable JavaScript code.


Very minor point, feel free to ignore it :)
Should we mention that the js file is only executable by Synthetics agent?

Suggested change

When you're done interacting with the page, the recorder converts the recorded actions into usable JavaScript code.

When you're done interacting with the page, the recorder converts the recorded actions into usable JavaScript code that can be executed by Synthetics agent.

Suggested change

When you're done interacting with the page, the recorder converts the recorded actions into usable JavaScript code.

When you're done interacting with the page, the recorder converts the recorded actions into JavaScript code for use with Elastic Synthetics.

Maybe even something like this, dropping usable altogether and highlighting that the code is only intended for use with Synthetics?

EDIT - we seem to cover this point in the very next sentence, so it's probably not needed here.

justinkambic

LGTM

docs/en/observability/synthetics-recorder.asciidoc

paulb-elastic · 2022-07-25T17:40:11Z

docs/en/observability/synthetics-recorder.asciidoc

+From there you can use the code by:
+
+* Copy and pasting code containing all steps into a new or existing <<synthetic-monitor-choose-project, synthetics project>> or an <<synthetics-inline-journey, inline monitor>>.
+* Click **Export** to save a JavaScript file containing all steps.


We don't really say much more about why this would be used, or exists as an option (file can be dragged onto add monitor). Probably ok as we're updating this primary flow, but might be worth adding a note something for it?

paulb-elastic

Thanks for getting this written up, LGTM

* initial structure, connection to instructional content add to index * first full draft * clean up text * update docs/en/observability/synthetics-recorder.asciidoc * address latest feedback * add heading ids * add beta note * add image (cherry picked from commit cdcffaf)

* initial structure, connection to instructional content add to index * first full draft * clean up text * update docs/en/observability/synthetics-recorder.asciidoc * address latest feedback * add heading ids * add beta note * add image (cherry picked from commit cdcffaf) Co-authored-by: Colleen McGinnis <[email protected]>

initial structure, connection to instructional content

af4ceda

add to index

colleenmcginnis requested review from kyungeunni, justinkambic and paulb-elastic June 27, 2022 21:44

mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jun 27, 2022

colleenmcginnis added the backport-8.9 Automated backport with mergify label Jun 27, 2022

mergify bot removed the backport-skip Skip notification from the automated backport with mergify label Jun 27, 2022

colleenmcginnis self-assigned this Jun 27, 2022

kyungeunni reviewed Jun 28, 2022

View reviewed changes

docs/en/observability/synthetics-recorder.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/synthetics-recorder.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/synthetics-recorder.asciidoc Outdated Show resolved Hide resolved

justinkambic reviewed Jul 5, 2022

View reviewed changes

first full draft

f1463b1

colleenmcginnis requested review from kyungeunni and justinkambic July 7, 2022 22:11

colleenmcginnis changed the title ~~[draft] [synthetics] Document the new Synthetics Recorder~~ [synthetics] Document the new Synthetics Recorder Jul 12, 2022

clean up text

2cc13d4

colleenmcginnis marked this pull request as ready for review July 12, 2022 15:06

colleenmcginnis requested a review from a team as a code owner July 12, 2022 15:06

kyungeunni reviewed Jul 14, 2022

View reviewed changes

update docs/en/observability/synthetics-recorder.asciidoc

add07df

kyungeunni approved these changes Jul 19, 2022

View reviewed changes

justinkambic approved these changes Jul 19, 2022

View reviewed changes

colleenmcginnis added 2 commits July 19, 2022 12:48

address latest feedback

46b0456

add heading ids

ec1ecd1

colleenmcginnis commented Jul 25, 2022

View reviewed changes

docs/en/observability/synthetics-recorder.asciidoc Show resolved Hide resolved

add beta note

7b9cf37

paulb-elastic reviewed Jul 25, 2022

View reviewed changes

add image

0b001fe

paulb-elastic approved these changes Jul 26, 2022

View reviewed changes

colleenmcginnis merged commit cdcffaf into elastic:main Jul 26, 2022

colleenmcginnis deleted the issue-1907 branch July 26, 2022 14:16

mergify bot mentioned this pull request Jul 26, 2022

[8.3] [synthetics] Document the new Synthetics Recorder (backport #1953) #2029

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[synthetics] Document the new Synthetics Recorder #1953

[synthetics] Document the new Synthetics Recorder #1953

colleenmcginnis commented Jun 27, 2022 •

edited

Loading

apmmachine commented Jun 27, 2022 •

edited

Loading

mergify bot commented Jun 27, 2022

kyungeunni left a comment

justinkambic left a comment

colleenmcginnis commented Jul 6, 2022

kyungeunni Jul 14, 2022

colleenmcginnis Jul 18, 2022

kyungeunni Jul 19, 2022

kyungeunni Jul 19, 2022

justinkambic Jul 19, 2022

kyungeunni Jul 19, 2022

justinkambic Jul 19, 2022 •

edited

Loading

justinkambic left a comment

paulb-elastic Jul 25, 2022

paulb-elastic left a comment

	The recorder launches a special https://www.chromium.org/Home/[Chromium browser] that will listen to each interaction you have with the web page and record them internally.
	The recorder launches a https://www.chromium.org/Home/[Chromium browser] that will listen to each interaction you have with the web page and record them internally using Playwright.

	When you're done interacting with the page, the recorder converts the recorded actions into usable JavaScript code.
	When you're done interacting with the page, the recorder converts the recorded actions into usable JavaScript code that can be executed by Synthetics agent.

[synthetics] Document the new Synthetics Recorder #1953

[synthetics] Document the new Synthetics Recorder #1953

Conversation

colleenmcginnis commented Jun 27, 2022 • edited Loading

Overview

To do

For the reviewer

apmmachine commented Jun 27, 2022 • edited Loading

mergify bot commented Jun 27, 2022

kyungeunni left a comment

Choose a reason for hiding this comment

justinkambic left a comment

Choose a reason for hiding this comment

colleenmcginnis commented Jul 6, 2022

kyungeunni Jul 14, 2022

Choose a reason for hiding this comment

colleenmcginnis Jul 18, 2022

Choose a reason for hiding this comment

kyungeunni Jul 19, 2022

Choose a reason for hiding this comment

kyungeunni Jul 19, 2022

Choose a reason for hiding this comment

justinkambic Jul 19, 2022

Choose a reason for hiding this comment

kyungeunni Jul 19, 2022

Choose a reason for hiding this comment

justinkambic Jul 19, 2022 • edited Loading

Choose a reason for hiding this comment

justinkambic left a comment

Choose a reason for hiding this comment

paulb-elastic Jul 25, 2022

Choose a reason for hiding this comment

paulb-elastic left a comment

Choose a reason for hiding this comment

colleenmcginnis commented Jun 27, 2022 •

edited

Loading

apmmachine commented Jun 27, 2022 •

edited

Loading

justinkambic Jul 19, 2022 •

edited

Loading