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.

Sign up for GitHub

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

Jump to bottom

Consider a Mermaid diagram? #27

Closed
reyang opened this issue May 20, 2022 · 2 comments · Fixed by #29 or #404
Closed

Consider a Mermaid diagram? #27

reyang opened this issue May 20, 2022 · 2 comments · Fixed by #29 or #404
Labels
enhancement New feature or request

Comments

@reyang
Copy link
Member

reyang commented May 20, 2022

Currently the "architecture diagram" is a PNG file https://github.com/open-telemetry/opentelemetry-demo-webstore/blob/b28cb38af2f1f1273f92a321d713e0f7706536b6/docs/img/architecture-diagram.png.

I imagine we'll keep improving the architecture, and PNG is hard for change management / comment. I propose that we use mermaid. In OpenTelemetry .NET and C++ I've seen good results open-telemetry/opentelemetry-dotnet#2952.

If folks like the idea, I can take this work.
@reyang reyang added the enhancement New feature or request label May 20, 2022
@cartersocha
Copy link
Contributor

Great suggestion! It took me a second to figure out how they work but perfect for our use case. Let's try & keep the colors by language if possible or just consider what we can do to improve readability from the grey / black default. Not sure how much configuration is possible

@reyang
Copy link
Member Author

reyang commented May 21, 2022 •
edited
Loading

Just trying to give folks some initial feel/taste - I'll add color in the next few days:

graph
  Internet(Internet) -->|HTTP| Frontend(Frontend)
  Load([Load Generator]) -->|HTTP| Frontend

  Frontend --> Ad(Ad Service)
  Frontend --> Cart(Cart Service)
  Frontend --> Catalog(ProductCatalog Service)
  Frontend --> Checkout(Checkout Service)
  Frontend --> Currency(Currency Service)
  Frontend --> Recommendation(Recommendation Service)
  Frontend --> Shipping(Shipping Service)

  Checkout --> Cart --> Cache[(Cache<br/>&#40redis&#41)]
  Checkout --> Catalog
  Checkout --> Currency
  Checkout --> Email(Email Service)
  Checkout --> Payment(Payment Service)
  Checkout --> Shipping

  Recommendation --> Catalog
Loading

@reyang reyang mentioned this issue May 21, 2022
Merged
@cartersocha cartersocha mentioned this issue May 21, 2022
Closed
@julianocosta89 julianocosta89 mentioned this issue Oct 6, 2022
Merged
smith pushed a commit to smith/opentelemetry-demo that referenced this issue Aug 5, 2024
@rogercoll
chore: bump Java agent to 0.4.0 (open-telemetry#27)
99962d4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Replace the PNG diagram with Mermaid
Doc/improve mermaid chart julianocosta89/opentelemetry-demo
2 participants
@reyang @cartersocha