Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up changelog, metric docs #224

Merged
merged 3 commits into from
Jul 22, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,19 @@ significant modifications will be credited to OpenTelemetry Authors.
([#141](https://github.com/open-telemetry/opentelemetry-demo-webstore/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
* Added manual instrumentation to ad service
([#150](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/150))
* Added manual instrumentation to Ruby email service
cartersocha marked this conversation as resolved.
Show resolved Hide resolved
([#158](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/158))
* Added basic metric support and Prometheus storage
([#160](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/160))
* Added manual instrumentation to recommendation service
([#163](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/163))
* Added manual instrumentation to checkout service
([#164](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/164))
* Added Grafana service and enhanced metric experience
([#175](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/175))
* Enhanced cart service attributes
([#183](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/183))
* Re-implemented currency service using C++
([#189](https://github.com/open-telemetry/opentelemetry-demo-webstore/pull/189))
118 changes: 118 additions & 0 deletions docs/metric_service_features.md
Original file line number Diff line number Diff line change
@@ -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)

tba
cartersocha marked this conversation as resolved.
Show resolved Hide resolved

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

tba

### [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)

tba

### [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)

tba

### [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)

tba

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

tba
2 changes: 0 additions & 2 deletions docs/trace_service_features.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ tba

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

### Traces

- :100: [Instrumentation
Libraries](https://opentelemetry.io/docs/concepts/instrumenting-library/)
- :construction: [Manual Span
Expand Down
21 changes: 0 additions & 21 deletions src/checkoutservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
21 changes: 0 additions & 21 deletions src/emailservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
21 changes: 0 additions & 21 deletions src/frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 0 additions & 21 deletions src/paymentservice/README.md
Original file line number Diff line number Diff line change
@@ -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)
21 changes: 0 additions & 21 deletions src/productcatalogservice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)