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

Adapt messaging examples/tables #1473

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

joaopgrassi
Copy link
Member

Fixes #1465

Changes

The mermaid diagrams and the tables use different terms/names for things, which may cause confusion for end-users. This PR attempts to make them a bit more clear.

Merge requirement checklist

@joaopgrassi joaopgrassi added Skip Changelog Label to skip the changelog check area:messaging labels Oct 14, 2024
@joaopgrassi joaopgrassi requested review from a team as code owners October 14, 2024 10:38
Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

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

This looks great!

We have a few more examples in Kafka and GCP PubSub files and it'd be great to update them too.

@@ -504,6 +504,11 @@ understanding how messaging spans can be integrated into an overall trace flow.
Solid arrows denote parent/child relationships, dotted arrows denote link
relationships.

> [!IMPORTANT]
> The text inside the "Span" box is only for reference and visualization purposes.
> Check the accompaining table to see the actual span name to be reported
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> Check the accompaining table to see the actual span name to be reported
> Check the accompanying table to see the actual span name to be reported

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:messaging Skip Changelog Label to skip the changelog check
Projects
Status: In Discussions
Development

Successfully merging this pull request may close these issues.

Messaging: review messaging examples
4 participants