-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Comments
Great suggestion! I'd just keep the |
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 |
Is the helm chart being updated to match this work? |
@pessoa not yet. |
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
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:
The text was updated successfully, but these errors were encountered: