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

added more demo screenshots #456

Merged
merged 4 commits into from
Oct 19, 2022

Conversation

saurabhdes
Copy link
Contributor

@saurabhdes saurabhdes commented Oct 17, 2022

Changes

Added links to few more demo screenshots so newcomers to OpenTelemetry and new users of opentelemetry-demo will know in advance what to expect when they go to the different url's mentioned here after deploying opentelemetry-demo . Specifically:

  • Added Jaeger System Architecture screenshot, which is built dynamically by Jaeger via the traces.
  • Added Prometheus UI screenshot, with one metric as an example.
  • Added Grafana UI screenshot with Prometheus and Jaegar as data sources.
  • Added Feature Flag UI screenshot
  • Added Load Generator UI (Locust UI) screenshot

The links to the screenshot are derived from this PR comment - #456 (comment)

For significant contributions please make sure you have completed the following items:

  • Appropriate CHANGELOG.md updated for non-trivial changes
  • Design discussion issue #

@saurabhdes saurabhdes requested a review from a team October 17, 2022 01:08
@julianocosta89
Copy link
Member

Just quoting @reyang here:
#405 (comment)

Given we don't intend to make modifications on these images, I wonder if they should be kept out of the repo (so we don't need to keep these binaries in the history), and only referenced in the markdown files using some permanent links.
For example, all the images in this doc works fine without having to be part of the repo https://github.com/open-telemetry/opentelemetry-cpp/blob/79a9471f5c6462cf5d013331e91f25455f824cd2/examples/prometheus/README.md.

If you drag and drop the image in a comment, GitHub will generate a link to the file, you can simply use the link in the docs, avoiding adding the binary to the repo.

@saurabhdes
Copy link
Contributor Author

saurabhdes commented Oct 17, 2022

thanks @julianocosta89 . I will add the images in a comment in this PR and use that in this PR. Will update tomorrow.

@saurabhdes
Copy link
Contributor Author

saurabhdes commented Oct 18, 2022

Adding pics in this comment which i will refer to in this PR.

JaegerUISystemArchitecture

PrometheusUI

GrafanaDataSourceIsPrometheus

GrafanaDataSourceIsJaeger

FeatureFlagUI

LoadGeneratorUI

@saurabhdes
Copy link
Contributor Author

@julianocosta89 - As requested i added links to images.

Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome to me!

One minor thing - the Prometheus screenshot seems very wide, maybe better to reduce the width of the window (so that the text looks bigger)?

https://user-images.githubusercontent.com/47896520/196496292-5c8bda8a-3a6a-4043-b892-7e208e0bd415.png

@saurabhdes
Copy link
Contributor Author

Looks awesome to me!

One minor thing - the Prometheus screenshot seems very wide, maybe better to reduce the width of the window (so that the text looks bigger)?

https://user-images.githubusercontent.com/47896520/196496292-5c8bda8a-3a6a-4043-b892-7e208e0bd415.png

Good suggestion @reyang , will update PR

@saurabhdes
Copy link
Contributor Author

@reyang Updated the PR.

Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome to me 👍

@puckpuck puckpuck merged commit 0b6fa3a into open-telemetry:main Oct 19, 2022
jmichalak9 pushed a commit to jmichalak9/opentelemetry-demo that referenced this pull request Mar 22, 2024
* add more demo screenshots

* added links to images

* updated prometheus image PR feedback

Co-authored-by: Pierre Tessier <pierre@pierretessier.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants