Skip to content

Latest commit

 

History

History
137 lines (105 loc) · 8.5 KB

README.md

File metadata and controls

137 lines (105 loc) · 8.5 KB
Raw

Webstore Demo

Under Construction

This repo is a work in progress

Screenshots from the Online Boutique

Home Page Checkout Screen
Screenshot of store homepage Screenshot of checkout screen

Screenshots from Jaeger

Jaeger UI Trace View
Screenshot of Jaeger UI Screenshot of Trace View

Architecture

Online Boutique is composed of 10 microservices written in different languages that talk to each other over gRPC. Plus one Load Generator which uses Locust to fake user traffic. See the Development Principles doc for more information.

graph TD

adservice(Ad Service<br/>&#40Java&#41):::java
cache[(Cache<br/>&#40redis&#41)]
cartservice(Cart Service<br/>&#40.NET&#41):::dotnet
checkoutservice(Checkout Service<br/>&#40Go&#41):::golang
currencyservice(Currency Service<br/>&#40Node.js&#41):::nodejs
emailservice(Email Service<br/>&#40Python&#41):::python
frontend(Frontend<br/>&#40Go&#41):::golang
loadgenerator([Load Generator<br/>&#40Python&#41]):::python
paymentservice(Payment Service<br/>&#40Node.js&#41):::nodejs
productcatalogservice(ProductCatalog Service<br/>&#40Go&#41):::golang
recommendationservice(Recommendation Service<br/>&#40Python&#41):::python
shippingservice(Shipping Service<br/>&#40Go&#41):::golang

Internet -->|HTTP| frontend
loadgenerator -->|HTTP| frontend

checkoutservice --> cartservice --> cache
checkoutservice --> productcatalogservice
checkoutservice --> currencyservice
checkoutservice --> emailservice
checkoutservice --> paymentservice
checkoutservice --> shippingservice

frontend --> adservice
frontend --> cartservice
frontend --> productcatalogservice
frontend --> checkoutservice
frontend --> currencyservice
frontend --> recommendationservice --> productcatalogservice
frontend --> shippingservice
Loading

Find Protocol Buffers Descriptions at the ./pb directory.

Service Language Description
frontend Go Exposes an HTTP server to serve the website. Does not require signup/login and generates session IDs for all users automatically.
cartservice C# Stores the items in the user's shopping cart in Redis and retrieves it.
productcatalogservice Go Provides the list of products from a JSON file and ability to search products and get individual products.
currencyservice Node.js Converts one money amount to another currency. Uses real values fetched from European Central Bank. It's the highest QPS service.
paymentservice Node.js Charges the given credit card info (mock) with the given amount and returns a transaction ID.
shippingservice Go Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock)
emailservice Python Sends users an order confirmation email (mock).
checkoutservice Go Retrieves user cart, prepares order and orchestrates the payment, shipping and the email notification.
recommendationservice Python Recommends other products based on what's given in the cart.
adservice Java Provides text ads based on given context words.
loadgenerator Python/Locust Continuously sends requests imitating realistic user shopping flows to the frontend.

Features

  • Kubernetes:
    The app is designed to run on Kubernetes (both locally , as well as on the cloud).
  • Docker:
    This forked sample can also be executed only with Docker.
  • gRPC:
    Microservices use a high volume of gRPC calls to communicate to each other.
  • OpenTelemetry Traces:
    All services are instrumented using OpenTelemetry available instrumentation libraries.
  • OpenTelemetry Collector: All services are instrumented and sending the generated traces to the OpenTelemetry Collector via gRPC. The received traces are then exported to the logs and to Jaeger.
  • Jager:
    All generated traces are being sent to Jaeger.
  • Synthetic Load Generation:
    The application demo comes with a background job that creates realistic usage patterns on the website using Locust load generator.

Local Development

TBD

Demos featuring Online Boutique

TBD

Contributing

See CONTRIBUTING.md

We meet weekly Monday's at 8:15 PT. The meeting is subject to change depending on contributors' availability. Check the OpenTelemetry community calendar for specific dates and Zoom meeting links.

Meeting notes are available as a public Google doc. For edit access, get in touch on Slack.

Maintainers (@open-telemetry/demo-webstore-maintainers):

Approvers (@open-telemetry/demo-webstore-approvers):

Thanks to all the people who have contributed

contributors