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

ISPN-14484 Document server tracing and client propagation #10770

Merged
merged 2 commits into from May 19, 2023

Conversation

fax4ever
Copy link
Contributor

@fax4ever fax4ever commented Apr 3, 2023

@fax4ever fax4ever requested a review from domiborges April 3, 2023 15:34
@fax4ever fax4ever added the Documentation Pull request containing only documentation changes label Apr 18, 2023
Copy link
Member

@domiborges domiborges left a comment

Choose a reason for hiding this comment

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

Hi @fax4ever few questions for you.
You've done an amazing job. The docs look great!
I have few changes locally that I'd like to push + some more information depending on your answers. Can you please take a look at my comments?

----
<1> Globally enables the tracing.
<2> The OTLP (OpenTelemetry protocol) exporter is the recommended format to export tracing data.
<3> Specify here service name. The default name is `Infinispan Server`.
Copy link
Member

Choose a reason for hiding this comment

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

@fax4ever what exactly is the default? Infinispan Server?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dvagnero yes it is

= Hot Rod client tracing propagation
The HotRod client fully supports the OpenTelemetry tracing propagation from the client to the Infinispan server.

It means that if the OpenTelemetry tracing is configured both on client VM and on the {brandname} server,
Copy link
Member

Choose a reason for hiding this comment

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

How do you configure tracing on client VM? Should we include the step?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It depends on the client technology, not by us. For instance a Quarkus OpenTelemetry extension or a SpringBoot OpenTelemetry module can be added for instance.


For our case.

* Pass the following system properties to {brandname} Server at startup:
Copy link
Member

Choose a reason for hiding this comment

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

When the user wants to update the configuration, do they need to stop the server?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes at the moment the configuration is taken at server startup time... more improvements will come

@fax4ever fax4ever merged commit 3eae4a0 into infinispan:main May 19, 2023
3 of 4 checks passed
@fax4ever
Copy link
Contributor Author

Great job @dvagnero. Merged it!

@fax4ever fax4ever deleted the ISPN-14484 branch May 19, 2023 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Pull request containing only documentation changes
Projects
None yet
2 participants