Skip to content

Commit

Permalink
nit updates (#427)
Browse files Browse the repository at this point in the history
  • Loading branch information
@cartersocha
cartersocha authored Oct 11, 2022
1 parent 70dfd8d commit 1fdc027
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 39 deletions.
46 changes: 23 additions & 23 deletions docs/manual_span_attributes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This document contains the list of manual Span Attributes used throughout the de

## AdService

| Name | Type | Description |
|-----------------------------|---------|---------------------------------------|
| `app.ads.category` | string | Category for returned ad |
| `app.ads.contextKeys` | string | Context keys used to find related ads |
| `app.ads.contextKeys.count` | number | Count of unique context keys used |
| `app.ads.count` | number | Count of ads returned to user |
| Name | Type | Description |
|-----------------------------|--------|---------------------------------------|
| `app.ads.category` | string | Category for returned ad |
| `app.ads.contextKeys` | string | Context keys used to find related ads |
| `app.ads.contextKeys.count` | number | Count of unique context keys used |
| `app.ads.count` | number | Count of ads returned to user |

## CartService

Expand Down Expand Up @@ -50,10 +50,10 @@ This document contains the list of manual Span Attributes used throughout the de

## FeatureFlagService

| Name | Type | Description |
|-------------------------------|---------|--------------------------|
| `app.featureflag.name` | string | Name of the feature flag |
| `app.featureflag.description` | string | Admin description |
| Name | Type | Description |
|-------------------------------|--------|--------------------------|
| `app.featureflag.name` | string | Name of the feature flag |
| `app.featureflag.description` | string | Admin description |
| `app.featureflag.enabled` | boolean | The feature flag status | |

## Frontend
Expand All @@ -76,18 +76,18 @@ This document contains the list of manual Span Attributes used throughout the de

## LoadGenerator

| Name | Type | Description |
|-----------|------|-------------|
| None yet | | |
| Name | Type | Description |
|----------|------|-------------|
| None yet | | |

## PaymentService

| Name | Type | Description |
|--------------------------|----------|------------------------------------------------------|
| `app.payment.amount` | number | Total payment amount |
| `app.payment.card_type` | string | Type of card used for payment |
| `app.payment.card_valid` | boolean | Was the card used valid |
| `app.payment.charged` | boolean | Was the charge successful (false with loadgenerator) |
| Name | Type | Description |
|--------------------------|---------|------------------------------------------------------|
| `app.payment.amount` | number | Total payment amount |
| `app.payment.card_type` | string | Type of card used for payment |
| `app.payment.card_valid` | boolean | Was the card used valid |
| `app.payment.charged` | boolean | Was the charge successful (false with loadgenerator) |

## ProductCatalogService

Expand All @@ -100,10 +100,10 @@ This document contains the list of manual Span Attributes used throughout the de

## QuoteService

| Name | Type | Description |
|-----------------------------|--------|----------------------|
| `app.quote.items.count` | number | Total items to ship |
| `app.quote.cost.total` | number | Total shipping quote |
| Name | Type | Description |
|-------------------------|--------|----------------------|
| `app.quote.items.count` | number | Total items to ship |
| `app.quote.cost.total` | number | Total shipping quote |

## RecommendationService

Expand Down
2 changes: 1 addition & 1 deletion docs/metric_service_features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Emoji Legend
| Ad | Java | :100: | :construction: | :construction: | :construction: | :construction: | :construction: |
| Cart | .NET | :100: | :construction: | :construction: | :construction: | :construction: | :construction: |
| Checkout | Go | :100: | :construction: | :construction: | :construction: | :construction: | :construction: |
| Currency | C++ | :construction: | :construction: | :construction: | :construction: | :construction: | :construction: |
| Currency | C++ | :no_bell: | :construction: | :construction: | :construction: | :construction: | :construction: |
| Email | Ruby | :construction: | :construction: | :construction: | :construction: | :construction: | :construction: |
| Feature Flag | Erlang / Elixir | :construction: | :construction: | :construction: | :construction: | :construction: | :construction: |
| Frontend | JavaScript | :construction: | :construction: | :construction: | :construction: | :construction: | :construction: |
Expand Down
30 changes: 15 additions & 15 deletions docs/service_table.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

View [Service Graph](../README.md#architecture) to visualize request flows.

| 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](services/checkoutservice.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](services/emailservice.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) | JavaScript | 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](services/paymentservice.md) | JavaScript | Charges the given credit card info (mock) with the given amount and returns a transaction ID. |
| [productcatalogservice](services/productcatalogservice.md) | Go | Provides the list of products from a JSON file and ability to search products and get individual products. |
| [quoteservice](services/quoteservice.md) | PHP | Calculates the shipping costs, based on the number of items to be shipped. |
| [recommendationservice](services/recommendationservice.md) | Python | Recommends other products based on what's given in the cart. |
| [shippingservice](services/shippingservice.md) | Rust | Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock). |
| 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](services/checkoutservice.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](services/emailservice.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) | JavaScript | 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](services/paymentservice.md) | JavaScript | Charges the given credit card info (mock) with the given amount and returns a transaction ID. |
| [productcatalogservice](services/productcatalogservice.md) | Go | Provides the list of products from a JSON file and ability to search products and get individual products. |
| [quoteservice](services/quoteservice.md) | PHP | Calculates the shipping costs, based on the number of items to be shipped. |
| [recommendationservice](services/recommendationservice.md) | Python | Recommends other products based on what's given in the cart. |
| [shippingservice](services/shippingservice.md) | Rust | Gives shipping cost estimates based on the shopping cart. Ships items to the given address (mock). |

0 comments on commit 1fdc027

Please sign in to comment.