Skip to content

Commit

Permalink
centralize a tracing doc (open-telemetry#218)
Browse files Browse the repository at this point in the history
* centralize a tracing doc

* lint

* trailing space
  • Loading branch information
cartersocha committed Jul 20, 2022
1 parent a05a228 commit 457c863
Show file tree
Hide file tree
Showing 6 changed files with 123 additions and 80 deletions.
123 changes: 123 additions & 0 deletions docs/trace_service_features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Trace Feature Coverage by Service

## TOC

- [Ad Service](#ad-service)
- [Cart Service](#cart-service)
- [Checkout Service](#checkout-service)
- [Currency Service](#currency-service)
- [Email Service](#email-service)
- [Feature Flag Service](#feature-flag-service)
- [Frontend Service](#frontend-service)
- [Payment Service](#payment-service)
- [Product Catalog Service](#product-catalog-service)
- [Recommendation Service](#recommendation-service)
- [Shipping Service](#shipping-service)

## OpenTelemetry Feature Set by Services

### Emoji Legend

- Completed: :100:
- Not Present (Yet): :construction:

### [Ad Service](../src/adservice/README.md)

tba

### [Cart Service](../src/cartservice/README.md)

tba

### [Checkout Service](../src/checkoutservice/README.md)

### Traces

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :construction: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :construction: [Span Data
Enrichment](https://opentelemetry.io/docs/concepts/glossary/#metadata)
- :construction: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#context)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction: [Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### [Currency Service](../src/currencyservice/README.md)

tba

### [Email Service](../src/emailservice/README.md)

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :100: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/concepts/glossary/#metadata)
- :100: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#context)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction: [Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### [Feature Flag Service](../src/featureflagservice/README.md)

tba

### [Frontend Service](../src/frontend/README.md)

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :construction: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/concepts/glossary/#metadata)
- :100: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#context)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction: [Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### [Payment Service](../src/paymentservice/README.md)

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :100: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/concepts/glossary/#metadata)
- :100: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#context)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction: [Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### [Product Catalog Service](../src/productcatalogservice/README.md)

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :construction: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/concepts/glossary/#metadata)
- :construction: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#context)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction: [Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### [Recommendation Service](../src/recommendationservice/README.md)

tba

### [Shipping Service](../src/shippingservice/README.md)

tba
16 changes: 0 additions & 16 deletions src/checkoutservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,6 @@ dep ensure --vendor-only
- Completed: :100:
- Not Present (Yet): :construction:

### Traces

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :construction: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :construction: [Span Data
Enrichment](https://opentelemetry.io/docs/instrumentation/net/manual/#add-tags-to-an-activity)
- :construction: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://opentelemetry.io/docs/instrumentation/java/manual/#context-propagation)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction:
[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### Metrics

- :construction: [Instrumentation
Expand Down
16 changes: 0 additions & 16 deletions src/emailservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,6 @@ From `src/emailservice`, run `docker build .`
- Completed: :100:
- Not Present (Yet): :construction:

### Traces

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :100: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/instrumentation/net/manual/#add-tags-to-an-activity)
- :100: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://opentelemetry.io/docs/instrumentation/java/manual/#context-propagation)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction:
[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### Metrics

- :construction: [Instrumentation
Expand Down
16 changes: 0 additions & 16 deletions src/frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,6 @@ else.
- Completed: :100:
- Not Present (Yet): :construction:

### Traces

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :construction: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/instrumentation/net/manual/#add-tags-to-an-activity)
- :100: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://opentelemetry.io/docs/instrumentation/java/manual/#context-propagation)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction:
[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### Metrics

- :construction: [Instrumentation
Expand Down
16 changes: 0 additions & 16 deletions src/paymentservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,6 @@
- Completed: :100:
- Not Present (Yet): :construction:

### Traces

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :100: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/instrumentation/net/manual/#add-tags-to-an-activity)
- :100: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://opentelemetry.io/docs/instrumentation/java/manual/#context-propagation)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction:
[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### Metrics

- :construction: [Instrumentation
Expand Down
16 changes: 0 additions & 16 deletions src/productcatalogservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,6 @@ When this service is run the output should be similar to the following
- Completed: :100:
- Not Present (Yet): :construction:

### Traces

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :construction: [Manual Span
Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation)
- :100: [Span Data
Enrichment](https://opentelemetry.io/docs/instrumentation/net/manual/#add-tags-to-an-activity)
- :construction: Interprocess Context Propagation
- :construction: [Intra-service Context
Propagation](https://opentelemetry.io/docs/instrumentation/java/manual/#context-propagation)
- :construction: [Trace
Links](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans)
- :construction:
[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md#overview)

### Metrics

- :construction: [Instrumentation
Expand Down

0 comments on commit 457c863

Please sign in to comment.