diff --git a/CHANGELOG.md b/CHANGELOG.md index 62e82559cc..ee0eba8147 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,22 +14,30 @@ demo](https://github.com/GoogleCloudPlatform/microservices-demo) with express knowledge of the owners. The pre-existing copyrights will remain. Any future significant modifications will be credited to OpenTelemetry Authors. * Added feature flag service protos -([#26](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/26)) +([#26](https://github.com/open-telemetry/opentelemetry-demo/pull/26)) * Added span attributes to frontend service -([#82](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/82)) +([#82](https://github.com/open-telemetry/opentelemetry-demo/pull/82)) * Rewrote shipping service in Rust -([#35](https://github.com/open-telemetry/opentelemetry-demo-webstore/issues/35)) +([#35](https://github.com/open-telemetry/opentelemetry-demo/issues/35)) * Added feature flag service implementation -([#141](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/141)) +([#141](https://github.com/open-telemetry/opentelemetry-demo/pull/141)) * Added additional attributes to productcatalog service -([#143](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/143)) -* Added manual instrumentation to Java ad service -([#150](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/150)) -* Added manual instrumentation to Ruby email service -([#158](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/158)) +([#143](https://github.com/open-telemetry/opentelemetry-demo/pull/143)) +* Added manual instrumentation to ad service +([#150](https://github.com/open-telemetry/opentelemetry-demo/pull/150)) +* Added manual instrumentation to email service +([#158](https://github.com/open-telemetry/opentelemetry-demo/pull/158)) * Added basic metric support and Prometheus storage -([#160](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/160)) +([#160](https://github.com/open-telemetry/opentelemetry-demo/pull/160)) +* Added manual instrumentation to recommendation service +([#163](https://github.com/open-telemetry/opentelemetry-demo/pull/163)) +* Added manual instrumentation to checkout service +([#164](https://github.com/open-telemetry/opentelemetry-demo/pull/164)) * Added Grafana service and enhanced metric experience -([#175](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/175)) +([#175](https://github.com/open-telemetry/opentelemetry-demo/pull/175)) +* Enhanced cart service attributes +([#183](https://github.com/open-telemetry/opentelemetry-demo/pull/183)) * Re-implemented currency service using C++ -([#189](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/189)) +([#189](https://github.com/open-telemetry/opentelemetry-demo/pull/189)) +* Simplified repo name and dropped the '-webstore' suffix in every place +([#225](https://github.com/open-telemetry/opentelemetry-demo/pull/225)) diff --git a/docs/metric_service_features.md b/docs/metric_service_features.md new file mode 100644 index 0000000000..a95cddb870 --- /dev/null +++ b/docs/metric_service_features.md @@ -0,0 +1,118 @@ +# Metric 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) + +TBD + +### [Cart Service](../src/cartservice/README.md) + +TBD + +### [Checkout Service](../src/checkoutservice/README.md) + +- :construction: [Instrumentation + Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) +- :construction: [Manual Metric + Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) +- :construction: [Collector Agent Metric + Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) +- :construction: [Push + Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) +- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) +- :construction: [Multiple Manual Metric + Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) + +### [Currency Service](../src/currencyservice/README.md) + +TBD + +### [Email Service](../src/emailservice/README.md) + +- :construction: [Instrumentation + Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) +- :construction: [Manual Metric + Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) +- :construction: [Collector Agent Metric + Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) +- :construction: [Push + Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) +- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) +- :construction: [Multiple Manual Metric + Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) + +### [Feature Flag Service](../src/featureflagservice/README.md) + +TBD + +### [Frontend Service](../src/frontend/README.md) + +- :construction: [Instrumentation + Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) +- :construction: [Manual Metric + Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) +- :construction: [Collector Agent Metric + Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) +- :construction: [Push + Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) +- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) +- :construction: [Multiple Manual Metric + Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) + +### [Payment Service](../src/paymentservice/README.md) + +- :construction: [Instrumentation + Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) +- :construction: [Manual Metric + Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) +- :construction: [Collector Agent Metric + Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) +- :construction: [Push + Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) +- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) +- :construction: [Multiple Manual Metric + Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) + +### [Product Catalog Service](../src/productcatalogservice/README.md) + +## OpenTelemetry features + +- :construction: [Instrumentation + Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) +- :construction: [Manual Metric + Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) +- :construction: [Collector Agent Metric + Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) +- :construction: [Push + Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) +- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) +- :construction: [Multiple Manual Metric + Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) + +### [Recommendation Service](../src/recommendationservice/README.md) + +TBD + +### [Shipping Service](../src/shippingservice/README.md) + +TBD diff --git a/docs/trace_service_features.md b/docs/trace_service_features.md index c42569a264..9645cfa984 100644 --- a/docs/trace_service_features.md +++ b/docs/trace_service_features.md @@ -23,16 +23,14 @@ ### [Ad Service](../src/adservice/README.md) -tba +TBD ### [Cart Service](../src/cartservice/README.md) -tba +TBD ### [Checkout Service](../src/checkoutservice/README.md) -### Traces - - :100: [Instrumentation Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) - :construction: [Manual Span @@ -47,7 +45,7 @@ tba ### [Currency Service](../src/currencyservice/README.md) -tba +TBD ### [Email Service](../src/emailservice/README.md) @@ -65,7 +63,7 @@ tba ### [Feature Flag Service](../src/featureflagservice/README.md) -tba +TBD ### [Frontend Service](../src/frontend/README.md) @@ -111,8 +109,8 @@ tba ### [Recommendation Service](../src/recommendationservice/README.md) -tba +TBD ### [Shipping Service](../src/shippingservice/README.md) -tba +TBD diff --git a/src/checkoutservice/README.md b/src/checkoutservice/README.md index 056760d26c..922d3eb436 100644 --- a/src/checkoutservice/README.md +++ b/src/checkoutservice/README.md @@ -5,24 +5,3 @@ Run the following command to restore dependencies to `vendor/` directory: ```sh dep ensure --vendor-only ``` - -## OpenTelemetry features - -### Emoji Legend - -- Completed: :100: -- Not Present (Yet): :construction: - -### Metrics - -- :construction: [Instrumentation - Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) -- :construction: [Manual Metric - Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) -- :construction: [Collector Agent Metric - Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) -- :construction: [Push - Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) -- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) -- :construction: [Multiple Manual Metric - Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) diff --git a/src/emailservice/README.md b/src/emailservice/README.md index 0d20545998..32ac929aad 100644 --- a/src/emailservice/README.md +++ b/src/emailservice/README.md @@ -21,24 +21,3 @@ You may run this service locally with `bundle exec ruby email_server.rb`. ## Building docker image From `src/emailservice`, run `docker build .` - -## OpenTelemetry features - -### Emoji Legend - -- Completed: :100: -- Not Present (Yet): :construction: - -### Metrics - -- :construction: [Instrumentation - Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) -- :construction: [Manual Metric - Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) -- :construction: [Collector Agent Metric - Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) -- :construction: [Push - Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) -- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) -- :construction: [Multiple Manual Metric - Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) diff --git a/src/frontend/README.md b/src/frontend/README.md index 7e36f8363f..0d8744ce81 100644 --- a/src/frontend/README.md +++ b/src/frontend/README.md @@ -7,27 +7,6 @@ The application uses Server Side Rendering (SSR) to generate HTML consumed by the clients, which could be web browsers, web crawlers, mobile clients or something else. -## OpenTelemetry features - -### Emoji Legend - -- Completed: :100: -- Not Present (Yet): :construction: - -### Metrics - -- :construction: [Instrumentation - Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) -- :construction: [Manual Metric - Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) -- :construction: [Collector Agent Metric - Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) -- :construction: [Push - Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) -- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) -- :construction: [Multiple Manual Metric - Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) - ## OpenTelemetry instrumentation ### Initialization diff --git a/src/paymentservice/README.md b/src/paymentservice/README.md index 0e16dd7886..bbb628c38e 100644 --- a/src/paymentservice/README.md +++ b/src/paymentservice/README.md @@ -1,22 +1 @@ # Read Me - -## OpenTelemetry features - -### Emoji Legend - -- Completed: :100: -- Not Present (Yet): :construction: - -### Metrics - -- :construction: [Instrumentation - Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) -- :construction: [Manual Metric - Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) -- :construction: [Collector Agent Metric - Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) -- :construction: [Push - Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) -- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) -- :construction: [Multiple Manual Metric - Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments) diff --git a/src/productcatalogservice/README.md b/src/productcatalogservice/README.md index 2530d06fff..199b0ccfe7 100644 --- a/src/productcatalogservice/README.md +++ b/src/productcatalogservice/README.md @@ -6,24 +6,3 @@ When this service is run the output should be similar to the following {"message":"successfully parsed product catalog json","severity":"info","timestamp":"2022-06-02T23:54:10.191283363Z"} {"message":"starting grpc server at :3550","severity":"info","timestamp":"2022-06-02T23:54:10.191849078Z"} ``` - -## OpenTelemetry features - -### Emoji Legend - -- Completed: :100: -- Not Present (Yet): :construction: - -### Metrics - -- :construction: [Instrumentation - Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/) -- :construction: [Manual Metric - Creation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#manual-instrumentation) -- :construction: [Collector Agent Metric - Transformation](https://opentelemetry.io/docs/collector/deployment/#agent) -- :construction: [Push - Metrics](https://opentelemetry.io/docs/reference/specification/metrics/sdk/#push-metric-exporter) -- :construction: [SLO Metrics](https://github.com/openslo/openslo#slo) -- :construction: [Multiple Manual Metric - Instruments](https://opentelemetry.io/docs/reference/specification/metrics/api/#synchronous-and-asynchronous-instruments)