You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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
I welcome feedback and suggestions on this proposal. This is something we can also discuss during the next SIG meeting.
The text was updated successfully, but these errors were encountered:
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:
I welcome feedback and suggestions on this proposal. This is something we can also discuss during the next SIG meeting.
The text was updated successfully, but these errors were encountered: