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

[DOCS] Instrument Quarkus Application to send Traces #996

Closed
Calm-Rock opened this issue Nov 28, 2024 · 1 comment
Closed

[DOCS] Instrument Quarkus Application to send Traces #996

Calm-Rock opened this issue Nov 28, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Calm-Rock
Copy link
Member

Calm-Rock commented Nov 28, 2024

Scope of Task

Documentation
We need documentation that explains how to instrument a Quarkus application to send traces to SigNoz using OpenTelemetry. The documentation should cover configuration steps for both SigNoz Cloud and self-hosted SigNoz, with instructions for the following environments:

  • VM (Virtual Machines)
  • Kubernetes
  • Windows

Sample Application
Create a sample application that is already instrumented or tell steps to instrument in the README file.

  • Should include instructions for running the app and instrumenting the app if not already instrumented
  • Should include a docker file

Additional Things

Documentation
Include commands for:

  • Adding the OpenTelemetry extension using Quarkus CLI, Maven, and Gradle.
  • Build and run the application using these tools (if needed)

Where should the doc go ?

  • Create a new .mdx file in this folder
    - Name the file opentelemetry-quarkus.mdx
    - The id in the metadata should be opentelemetry-quarkus

Resources

@Calm-Rock Calm-Rock added the documentation Improvements or additions to documentation label Nov 28, 2024
@Calm-Rock
Copy link
Member Author

PR merged!

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

No branches or pull requests

1 participant