Skip to content

Commit

Permalink
Service table and graph cleanup (open-telemetry#266)
Browse files Browse the repository at this point in the history
  • Loading branch information
@puckpuck
puckpuck authored Aug 5, 2022
1 parent 128f78f commit 05f531d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
30 changes: 16 additions & 14 deletions docs/service_table.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# Service Roles

| Service | Language | Description |
|-----------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| [frontend](../src/frontend/README.md) | Go | Exposes an HTTP server to serve the website. Does not require signup/login and generates session IDs for all users automatically. |
| [cartservice](../src/cartservice/README.md) | DotNet | Stores the items in the user's shopping cart in Redis and retrieves it. |
| [productcatalogservice](../src/productcatalogservice/README.md) | Go | Provides the list of products from a JSON file and ability to search products and get individual products. |
| [currencyservice](../src/currencyservice/README.md) | C++ | Converts one money amount to another currency. Uses real values fetched from European Central Bank. It's the highest QPS service. |
| [paymentservice](../src/paymentservice/README.md) | JavaScript | Charges the given credit card info (mock) with the given amount and returns a transaction ID. |
| [shippingservice](../src/shippingservice/README.md) | Rust | Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock) |
| [emailservice](../src/emailservice/README.md) | Ruby | Sends users an order confirmation email (mock). |
| [checkoutservice](../src/checkoutservice/README.md) | Go | Retrieves user cart, prepares order and orchestrates the payment, shipping and the email notification. |
| [recommendationservice](../src/recommendationservice/README.md) | Python | Recommends other products based on what's given in the cart. |
| [adservice](../src/adservice/README.md) | Java | Provides text ads based on given context words. |
| [featureflagservice](../src/featureflagservice/README.md) | Erlang/Elixir | CRUD feature flag service to demonstrate various scenarios like fault injection & how to emit telemetry from a feature flag reliant service. |
| [loadgenerator](../src/loadgenerator/README.md) | Python/Locust | Continuously sends requests imitating realistic user shopping flows to the frontend. |
View [Service Graph](./v1Graph.md) to visualize request flow.

| Service | Language | Description |
|-----------------------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| [adservice](../src/adservice/README.md) | Java | Provides text ads based on given context words. |
| [cartservice](../src/cartservice/README.md) | DotNet | Stores the items in the user's shopping cart in Redis and retrieves it. |
| [checkoutservice](../src/checkoutservice/README.md) | Go | Retrieves user cart, prepares order and orchestrates the payment, shipping and the email notification. |
| [currencyservice](../src/currencyservice/README.md) | C++ | Converts one money amount to another currency. Uses real values fetched from European Central Bank. It's the highest QPS service. |
| [emailservice](../src/emailservice/README.md) | Ruby | Sends users an order confirmation email (mock). |
| [featureflagservice](../src/featureflagservice/README.md) | Erlang/Elixir | CRUD feature flag service to demonstrate various scenarios like fault injection & how to emit telemetry from a feature flag reliant service. |
| [frontend](../src/frontend/README.md) | Go | Exposes an HTTP server to serve the website. Does not require signup/login and generates session IDs for all users automatically. |
| [loadgenerator](../src/loadgenerator/README.md) | Python/Locust | Continuously sends requests imitating realistic user shopping flows to the frontend. |
| [paymentservice](../src/paymentservice/README.md) | JavaScript | Charges the given credit card info (mock) with the given amount and returns a transaction ID. |
| [productcatalogservice](../src/productcatalogservice/README.md) | Go | Provides the list of products from a JSON file and ability to search products and get individual products. |
| [recommendationservice](../src/recommendationservice/README.md) | Python | Recommends other products based on what's given in the cart. |
| [shippingservice](../src/shippingservice/README.md) | Rust | Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock). |
5 changes: 3 additions & 2 deletions docs/v1Graph.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Desired Service Map

This diagram illustrates the desired relationships between services for the v1 work.
See service roles [here](./service_table.md).

```mermaid
graph TD
Expand Down Expand Up @@ -31,7 +32,6 @@ checkoutservice --> currencyservice
checkoutservice --> emailservice
checkoutservice --> paymentservice
checkoutservice --> shippingservice
checkoutservice --> |evalFlag| featureflagfeservice
frontend --> adservice
frontend --> cartservice
Expand All @@ -40,11 +40,12 @@ frontend --> checkoutservice
frontend --> currencyservice
frontend --> recommendationservice --> productcatalogservice
frontend --> shippingservice
frontend --> |evalFlag| featureflagfeservice
productcatalogservice --> |evalFlag| featureflagfeservice
productcatalogservice --> productstore
shippingservice --> |evalFlag| featureflagfeservice
featureflagbeservice(Flag Server):::erlang
featureflagfeservice(Flag UI/API):::erlang
featureflagstore[(Flag Store<br/>&#40Blob/DB&#41)]
Expand Down

0 comments on commit 05f531d

Please sign in to comment.