Skip to content

Commit

Permalink
Docs - Table layout for manual span attributes (#277)
Browse files Browse the repository at this point in the history
  • Loading branch information
puckpuck authored Aug 11, 2022
1 parent 42315f6 commit 1a4698f
Showing 1 changed file with 72 additions and 48 deletions.
120 changes: 72 additions & 48 deletions docs/manual_span_attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,84 +4,108 @@ This document contains the list of manual Span Attributes used throughout the de

## AdService

* `app.ads.category`
* `app.ads.contextKeys`
* `app.ads.contextKeys.count`
* `app.ads.count`
| 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

* `app.product.id`
* `app.product.quantity`
* `app.user.id`
| Name | Type | Description |
|------------------------|--------|--------------------------|
| `app.product.id` | string | Product Id for cart item |
| `app.product.quantity` | string | Quantity for cart item |
| `app.user.id` | string | User Id |

## CheckoutService

* `app.cart.items.count`
* `app.order.id`
* `app.order.shipping.cost`
* `app.order.total.cost`
* `app.order.tracking.id`
* `app.order.items.count`
* `app.user.currency`
* `app.user.id`
| Name | Type | Description |
|---------------------------|--------|---------------------------------|
| `app.cart.items.count` | number | Number of unique items in cart |
| `app.order.id` | string | Order Id |
| `app.order.shipping.cost` | number | Order shipping cost |
| `app.order.total.cost` | number | Order total cost |
| `app.order.tracking.id` | string | Order shipping tracking Id |
| `app.order.items.count` | number | Number of unique items in order |
| `app.user.currency` | string | User currency |
| `app.user.id` | string | User Id |

## CurrencyService

* `app.currency.conversion.from`
* `app.currency.conversion.to`
| Name | Type | Description |
|--------------------------------|--------|-------------------------------|
| `app.currency.conversion.from` | string | Currency code to convert from |
| `app.currency.conversion.to` | string | Currency code to convert to |

## EmailService

* `app.email.sent`
* `app.order.id`
* `app.shipping.cost.currency`
* `app.shipping.cost.total`
* `app.shipping.tracking.id`
| Name | Type | Description |
|------------------------------|--------|-----------------------------------|
| `app.email.sent` | string | Email used for order confirmation |
| `app.order.id` | string | Order Id |
| `app.shipping.cost.currency` | string | Order currency |
| `app.shipping.cost.total` | string | Order cost total |
| `app.shipping.tracking.id` | string | Order shipping tracking Id |

## FeatureFlagService

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

## Frontend

* `app.cart.size`
* `app.cart.items.count`
* `app.cart.shipping.cost`
* `app.cart.total.price`
* `app.currency`
* `app.currency.new`
* `app.order.total`
* `app.product.id`
* `app.product.quantity`
* `app.products.count`
* `app.request.id`
* `app.session.id`
* `app.user.id`
| Name | Type | Description |
|--------------------------|--------|-------------------------------|
| `app.cart.size` | number | Total number of items in cart |
| `app.cart.items.count` | number | Count of unique items in cart |
| `app.cart.shipping.cost` | number | Cart shipping cost |
| `app.cart.total.price` | number | Cart total price |
| `app.currency` | string | User currency |
| `app.currency.new` | string | New currency to set |
| `app.order.total` | number | Order total cost |
| `app.product.id` | string | Product Id |
| `app.product.quantity` | number | Product quantity |
| `app.products.count` | number | Total products displayed |
| `app.request.id` | string | Request Id |
| `app.session.id` | string | Session Id |
| `app.user.id` | string | User Id |

## LoadGenerator

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

## PaymentService

* `app.payment.cost`
* `app.payment.currency`
| Name | Type | Description |
|------------------------|--------|--------------------|
| `app.payment.cost` | number | Total payment cost |
| `app.payment.currency` | string | Payment currency |

## ProductCatalogService

* `app.product.id`
* `app.product.name`
* `app.products.count`
| Name | Type | Description |
|----------------------|--------|---------------------------------------|
| `app.product.id` | string | Product Id |
| `app.product.name` | string | Product name |
| `app.products.count` | number | Number of products returned in search |

## RecommendationService

* `app.filtered_products.count`
* `app.products.count`
* `app.products_recommended.count`
| Name | Type | Description |
|----------------------------------|--------|-----------------------------------------|
| `app.filtered_products.count` | number | Number of filtered products returned |
| `app.products.count` | number | Total number of products |
| `app.products_recommended.count` | number | Number of recommended products returned |

## ShippingService

* `app.shipipng.cost.total`
* `app.shipping.items.count`
* `app.shipping.tracking.id`
| Name | Type | Description |
|----------------------------|--------|----------------------|
| `app.shipping.cost.total` | number | Total shipping cost |
| `app.shipping.items.count` | number | Total items to ship |
| `app.shipping.tracing.id` | string | Shipping tracking Id |

0 comments on commit 1a4698f

Please sign in to comment.