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

[demo] rename demo services #6438

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

puckpuck
Copy link
Contributor

@puckpuck puckpuck commented Feb 28, 2025

When we did the demo services rename as part of this issue in the demo repo, not all references were updated in docs. This PR updates all remaining references that need to be changed.

Preview: https://deploy-preview-6438--opentelemetry.netlify.app/docs/demo/

@puckpuck puckpuck requested a review from a team as a code owner February 28, 2025 03:11
@opentelemetrybot opentelemetrybot requested a review from a team February 28, 2025 03:11
Copy link
Member

@julianocosta89 julianocosta89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -5,7 +5,7 @@ aliases: [manual_span_attributes, ../manual-span-attributes]

This page lists the manual Span Attributes used throughout the demo:

## AdService
## Ad Service
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: "Service" could be removed from the headings on this page for consistency because some components, like the Load generator, are without it. This way, we wouldn't need to differentiate components that are considered services from those that aren't.

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful demo docs cleanup, thank you @puckpuck! 💛

Aliases record the history of how pages used to be named, and so must not be updated. Please revert the changes to aliases fields in all pages.

@@ -57,11 +57,11 @@ problems in distributed applications.
A PHP service should be added to the main application as an 'admin service'. A
Database should be added to enable CRUD functionality on the Product Catalog.

The 'shippingservice' should be reimplemented in Rust.
The 'shipping' service should be reimplemented in Rust.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The 'shipping' service should be reimplemented in Rust.
The shipping service should be reimplemented in Rust.

@@ -57,11 +57,11 @@ problems in distributed applications.
A PHP service should be added to the main application as an 'admin service'. A
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A PHP service should be added to the main application as an 'admin service'. A
A PHP service should be added to the main application as an admin service. A


The 'currencyservice' should be reimplemented in C++.
The 'currency' service should be reimplemented in C++.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The 'currency' service should be reimplemented in C++.
The currency service should be reimplemented in C++.


The 'emailservice' should be reimplemented in Ruby.
The 'email' service should be reimplemented in Ruby.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The 'email' service should be reimplemented in Ruby.
The email service should be reimplemented in Ruby.

@@ -70,11 +70,11 @@ work, and viewing the details allows us to get a better idea of what's going on.
We can see in our waterfall view that the `app.cache_hit` attribute is set to
`false`, and that the `app.products.count` value is extremely high.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`false`, and that the `app.products.count` value is extremely high.
false, and that the `app.products.count` value is extremely high.

requests tend to be faster when the cache is hit. Now search for
`app.cache_hit=false` and compare the latency. You should notice some changes in
the visualization at the top of the trace list.
Returning to the search UI, filter to `recommendation` in the Service dropdown,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Returning to the search UI, filter to `recommendation` in the Service dropdown,
Returning to the search UI, select "recommendation" in the Service dropdown,

@@ -1,7 +1,7 @@
---
title: Accounting Service
linkTitle: Accounting
aliases: [accountingservice]
aliases: [accounting]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aliases are "forever". This must not be renamed:

Suggested change
aliases: [accounting]
aliases: [accountingservice]

Please revert the changes to aliases fields in this and other pages.

corresponding `quoteservice` _server_ span. The tracing instrumentation is
implemented in the client middleware making use of the available
`reqwest-middleware`, `reqwest-tracing` and `tracing-opentelemetry` libraries:
A child _client_ span is also produced for the outgoing HTTP call to `quote` via
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A child _client_ span is also produced for the outgoing HTTP call to `quote` via
A child _client_ span is also produced for the outgoing HTTP call to quote service via

implemented in the client middleware making use of the available
`reqwest-middleware`, `reqwest-tracing` and `tracing-opentelemetry` libraries:
A child _client_ span is also produced for the outgoing HTTP call to `quote` via
the `reqwest` client. This span pairs up with the corresponding `quote` _server_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the `reqwest` client. This span pairs up with the corresponding `quote` _server_
the `reqwest` client. This span pairs up with the corresponding quote service _server_

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

Successfully merging this pull request may close these issues.

4 participants