-
Notifications
You must be signed in to change notification settings - Fork 161
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
Refresh the docs with better language #648
Conversation
Signed-off-by: Yuri Shkuro <github@ysh.us>
✅ Deploy Preview for romantic-neumann-1959d7 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
why: | | ||
As on-the-ground microservice practitioners are quickly realizing, the majority of operational problems that arise when moving to a distributed architecture are ultimately grounded in two areas: **networking** and **observability**. It is simply an orders of magnitude larger problem to network and debug a set of intertwined distributed services versus a single monolithic application. | ||
Distributed tracing observability platforms, such as Jaeger, are essential for modern software applications that are architected as microservices. Jaeger maps the flow of requests and data as they traverse a distributed system. These requests may make calls to multiple services, which may introduce their own delays or errors. Jaeger connects the dots between these disparate components, helping to identify performance bottlenecks, troubleshoot errors, and improve overall application reliability. Jaeger is 100% open source, cloud native, and infinitely scalable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was fun to write with the help of Bard, and using the writing styles of Alan Turing and Leslie Lamport.
@albertteoh could you review? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just added a couple of comments.
- You need [Go toolchain](https://golang.org/doc/install) installed on your machine to run from source | ||
(see [go.mod](https://github.com/jaegertracing/jaeger/blob/master/go.mod) file for required Go version). | ||
- Requires a [running Jaeger backend](#all-in-one) to view the traces. | ||
We recommend running Jaeger and HotROD via `docker compose`. In order to run it from source you need: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order to run it from source you need:
This sentence feels like we're almost conflating docker compose
with running from source, and I think the second sentence should belong under From Source
since it's not relevant in either With Docker Compose
or With Docker
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good call
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description of the changes