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

Drop "service" suffix, and standardize names #1788

Open
19 of 26 tasks
puckpuck opened this issue Nov 21, 2024 · 5 comments
Open
19 of 26 tasks

Drop "service" suffix, and standardize names #1788

puckpuck opened this issue Nov 21, 2024 · 5 comments
Labels
enhancement New feature or request

Comments

@puckpuck
Copy link
Contributor

puckpuck commented Nov 21, 2024

When running the demo, it is composed of 25+ individual containers/components/microservices. The names of these components are carried over from the demo's original roots, and several additional services and external components were added to support the demo's goal of showcasing OpenTelemetry across various languages and frameworks.

Currently, most services in the demo have a service suffix as part of their image and OpenTelemetry service name. Containers will have a -service suffix. Some services, such as the product catalog service, have a space in their name. The container name will be hyphenated, but the service/pod and OpenTelemetry definitions will have this as a single word.

A well-understood, concise, and consistent naming for all services would significantly improve the usability of the demo for users in observability tooling as well as contributors that support this effort. I propose dropping the service suffix from all services and using a hyphen (-) for spaces in names. The names should be consistent across the docker compose service, container name, OpenTelemetry service name, and Kubernetes deployment name.

The following table describes the current and suggested name for each Demo component:
EDIT: Updated to incorporate feedback from comments

Current Name Suggested Name
accountingservice accounting
adservice ad
cartservice cart
checkoutservice checkout
currencyservice currency
emailservice email
flagd flagd
flagd-ui flagd-ui
frauddetectionservice fraud-detection
frontend frontend
frontendproxy frontend-proxy
frontend-web frontend-web
grafana grafana
imageprovider image-provider
jaeger jaeger
kafka kafka
loadgenerator load-generator
opensearch opensearch
otelcollector otel-collector
paymentservice payment
productcatalogservice product-catalog
prometheus prometheus
quotesservice quote
recommendationsservice recommendation
shippingservice shipping
valkey-cart valkey-cart

I welcome feedback and suggestions on this proposal.

UPDATE:
After discussing in a SIG meeting on December 11, we decided to move forward with this proposal.

This is a tracking list for each demo component so we can ensure the effort is complete:

  • accounting
  • ad
  • cart
  • checkout
  • currency
  • email
  • flagd
  • flagd-ui
  • fraud-detection
  • frontend
  • frontend-proxy
  • frontend-web
  • grafana
  • image-provider
  • jaeger
  • kafka
  • load-generator
  • opensearch
  • otel-collector
  • payment
  • product-catalog
  • prometheus
  • quote
  • recommendation
  • shipping
  • valkey-cart
@puckpuck puckpuck added the enhancement New feature or request label Nov 21, 2024
@julianocosta89
Copy link
Member

Great suggestion!
+1 to that.

I'd just keep the valkey-cart. But fine in going to only valley as well.

@Sozhan308
Copy link
Contributor

Hello @puckpuck and @julianocosta89,

I’m interested in contributing to this topic. Would it be okay if I start with the AdService component?

@puckpuck
Copy link
Contributor Author

Hello @puckpuck and @julianocosta89,

I’m interested in contributing to this topic. Would it be okay if I start with the AdService component?

yes please help where you can here

@pessoa
Copy link

pessoa commented Dec 17, 2024

Is the helm chart being updated to match this work?

@julianocosta89
Copy link
Member

@pessoa not yet.
The Helm chart will only be update with a new release of the demo that should happen after all rename is done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants