Selenium Observability blog #674
Merged
Conversation
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
|
Deploy preview for jovial-austin-42fe02 ready! Built with commit 7fe4dfe https://deploy-preview-674--jovial-austin-42fe02.netlify.app |
|
|
||
| Selenium 3 uses Hub as the coordinator. It receives new session requests and directs them to the appropriate Node. The Node is the remote end that has browser and operating system capabilities. | ||
|
|
||
| Selenium 4 extends this to provide users with a way to set up a full-blown distributed system. Essentially, [Selenium 4](https://www.selenium.dev/documentation/en/grid/grid_4/components_of_a_grid/) splits the Hub into different components with additional enhancements. But the Node’s role remained the same. To ensure the backward compatibility and simplicity of setting up Grid, standalone and hub-node mode are also available in the new Selenium server. |
There was a problem hiding this comment.
Suggested change
| Selenium 4 extends this to provide users with a way to set up a full-blown distributed system. Essentially, [Selenium 4](https://www.selenium.dev/documentation/en/grid/grid_4/components_of_a_grid/) splits the Hub into different components with additional enhancements. But the Node’s role remained the same. To ensure the backward compatibility and simplicity of setting up Grid, standalone and hub-node mode are also available in the new Selenium server. | |
| Selenium 4 extends this to provide users with a way to set up a full-blown distributed system. Essentially, [Selenium 4](https://www.selenium.dev/documentation/en/grid/grid_4/components_of_a_grid/) splits the Hub into different components with additional enhancements. However, the Node’s role remained the same. To ensure the backward compatibility and simplicity of setting up Grid, standalone and hub-node mode are also available in the new Selenium server. |
There was a problem hiding this comment.
Nit: keep the tense the same throughout the paragraph. Either "split" and "remained" or "splits" and "remains"
shs96c
reviewed
Apr 27, 2021
| categories = ["general"] | ||
| +++ | ||
|
|
||
| Selenium server is now power-packed with [Opentelemetry](https://opentelemetry.io/) to help troubleshoot issues and optimize performance. Thus, making the Selenium server observable! |
There was a problem hiding this comment.
Starting with "why should I care?" is a nice way to hook people into an article. Perhaps something like...
Diagnosing problems when the Selenium server isn't working has never been easy. With Selenium 4, we've added support for [OpenTelemetry](https://opentelemetry.io/) to help you troubleshoot issues and optimize performance. By making the Selenium server observable, we're putting more power into your hands.
… or something similar?
|
|
||
| ### Need for Observability | ||
|
|
||
| Selenium server enables distributed testing. Instead of running the test locally, the tests run on a server that makes “**smart**” decisions to run them on different remote servers. Every such remote server is capable of hosting different types of browsers and browser versions. |
There was a problem hiding this comment.
Nit: the tests still run locally. The browsers run remotely. I'm not sure how much it matters, given that I suspect people seldom differentiate the two.
|
|
||
| Selenium server enables distributed testing. Instead of running the test locally, the tests run on a server that makes “**smart**” decisions to run them on different remote servers. Every such remote server is capable of hosting different types of browsers and browser versions. | ||
|
|
||
| Selenium 3 uses Hub as the coordinator. It receives new session requests and directs them to the appropriate Node. The Node is the remote end that has browser and operating system capabilities. |
There was a problem hiding this comment.
"The Node is the remote end where the browser itself runs"
|
|
||
| Selenium 3 uses Hub as the coordinator. It receives new session requests and directs them to the appropriate Node. The Node is the remote end that has browser and operating system capabilities. | ||
|
|
||
| Selenium 4 extends this to provide users with a way to set up a full-blown distributed system. Essentially, [Selenium 4](https://www.selenium.dev/documentation/en/grid/grid_4/components_of_a_grid/) splits the Hub into different components with additional enhancements. But the Node’s role remained the same. To ensure the backward compatibility and simplicity of setting up Grid, standalone and hub-node mode are also available in the new Selenium server. |
There was a problem hiding this comment.
Nit: keep the tense the same throughout the paragraph. Either "split" and "remained" or "splits" and "remains"
|
|
||
| Now picture running a full-blown distributed Selenium Grid with hundreds of Nodes with different browsers and browser versions. Testing at scale in such an infrastructure will involve large volumes of requests. How can one keep track of these requests? Enter Selenium Observability! | ||
|
|
||
| ### How does Selenium provide observability? |
There was a problem hiding this comment.
Please "title case" as if this were a main heading: "How Does Selenium Provide Observability"
| Run ``` java -jar selenium-server-4.0.0-<selenium-version>.jar info tracing```. | ||
|
|
||
| It provides detailed and updated instructions to set up Jaeger with the Selenium server. | ||
| Visualizing the traces makes it easy to interpret a trace and understand request flow. Now Grid users can effortlessly trace a request, drill down an error or query them to observe what is happening. |
|
|
||
| Refer to [Selenium Observability](https://www.selenium.dev/documentation/en/grid/grid_4/advanced_features/observability/) for details. | ||
|
|
||
| ### Full-stack tracing |
| Refer to [Selenium Observability](https://www.selenium.dev/documentation/en/grid/grid_4/advanced_features/observability/) for details. | ||
|
|
||
| ### Full-stack tracing | ||
| Java client binding supports tracing. Full-stack tracing allows tracing a request from the client to the server and back. Though the client is a single component, the client trace will contain spans that help build the request. It is easier to locate a client-side problem and fix the test if needed. |
| ### Full-stack tracing | ||
| Java client binding supports tracing. Full-stack tracing allows tracing a request from the client to the server and back. Though the client is a single component, the client trace will contain spans that help build the request. It is easier to locate a client-side problem and fix the test if needed. | ||
|
|
||
| We already saw how the server supports tracing and how to leverage it. For the client-side, add the Opentelemetry dependency to your project setup and add the necessary system properties to export the traces to Jaeger. Refer [RemoteWebdriver client](https://www.selenium.dev/documentation/en/remote_webdriver/remote_webdriver_client/#tracing-client-requests) for detailed instructions. |
|
|
||
| We already saw how the server supports tracing and how to leverage it. For the client-side, add the Opentelemetry dependency to your project setup and add the necessary system properties to export the traces to Jaeger. Refer [RemoteWebdriver client](https://www.selenium.dev/documentation/en/remote_webdriver/remote_webdriver_client/#tracing-client-requests) for detailed instructions. | ||
|
|
||
| ### Leveraging traces and event-logs |
There was a problem hiding this comment.
Leveraging Traces and Event Logs
AutomatedTester
approved these changes
Apr 28, 2021
diemol
approved these changes
Apr 28, 2021
selenium-ci
added a commit
that referenced
this pull request
Apr 28, 2021
* Selenium Observability blog * Add title case fo headings. Fix tense in few sentences. Update the opening statement. Co-authored-by: Diego Molina <[email protected]> 13e377f
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to quickly review and merge it
Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.
Description
A blog post on Selenium 4's observability feature and resource
Motivation and Context
Selenium 4 introduces observability in form of tracing and event logs. The blog is about discussing the need for observability and how to leverage it in Selenium.
Types of changes
Checklist