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

Update OpenTracing docs based on further review comments in original PR #530

Merged
merged 1 commit into from
Jan 16, 2019
Merged

Update OpenTracing docs based on further review comments in original PR #530

merged 1 commit into from
Jan 16, 2019

Conversation

objectiser
Copy link
Contributor

@objectiser objectiser commented Jan 16, 2019

Related to #521

@cescoffier
Copy link
Member

Sorry, I merged the original PR to be sure to get it in the release, let me go through that one more deeply.

@objectiser
Copy link
Contributor Author

@gsmet Hopefully this addresses your comments from #521 - let me know if there is anything else.

@gsmet
Copy link
Member

gsmet commented Jan 16, 2019

@cescoffier I did a proper review and tested the guide so I think we are good. This PR is the result of my review.

Copy link
Member

@cescoffier cescoffier left a comment

Choose a reason for hiding this comment

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

just 2 comments.

@@ -10,7 +10,7 @@ To complete this guide, you need:
* less than 15 minutes
* an IDE
* JDK 1.8+ installed with `JAVA_HOME` configured appropriately
* Apache Maven 3.5+
* Apache Maven 3.5.3+
Copy link
Member

Choose a reason for hiding this comment

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

Can you also add Docker as it seems required.

Copy link
Member

Choose a reason for hiding this comment

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

Done.


NOTE: Currently the tracer can only be configured to report spans directly to the collector via HTTP, using the `JAEGER_ENDPOINT` property. Support for using the Jaeger agent, via UDP, will be available in a future version.

Once both the application and tracing system are started, you can make a request to the provided endpoint:

```
$ curl http://localhost:8080/app/hello
Copy link
Member

Choose a reason for hiding this comment

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

Did you try without the application class and so remove the app prefix.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No - just used the classes as generated by shamrock maven plugin.

Copy link
Member

Choose a reason for hiding this comment

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

No problem, it's a "new" feature.

Copy link
Member

Choose a reason for hiding this comment

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

@objectiser to be more clear, if you remove the ShamrockApplication class in the quickstart, it should expose your endpoint with the app/ prefix so you should do that and update the URL here in the guide.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@gsmet I understand the change - however the quickstart docs (for example scheduler) are written to use the maven plugin to generate the project - and then refer to the quickstart repo as the completed example - so shouldn't the example in the repo be what the maven plugin generates?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah sorry, misunderstood - will manually do the change and retest.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cescoffier @gsmet Removed the ShamrockApplication class and tried curl http://localhost:8080/hello but got Not Found html page.

Copy link
Member

Choose a reason for hiding this comment

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

Another reason to add a page listing all routes on Mode == Mode.DEV

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would it be better to merge this as is, and then update all quickstarts in one go, when #510 is merged?

Copy link
Member

Choose a reason for hiding this comment

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

@objectiser agreed.

@cescoffier
Copy link
Member

@gsmet yes, saw that! Thanks!

I've found 2 minor issues.

@gsmet
Copy link
Member

gsmet commented Jan 16, 2019

I rebased, incorporated the Docker requirement in your commit and force-pushed. Will merge now.

@gsmet gsmet merged commit cb5d230 into quarkusio:master Jan 16, 2019
@objectiser objectiser deleted the otdocs2 branch January 16, 2019 12:59
@cescoffier cescoffier added this to the 0.6.0 milestone Jan 16, 2019
@cescoffier cescoffier added the kind/enhancement New feature or request label Jan 16, 2019
maxandersen added a commit to maxandersen/quarkus that referenced this pull request Nov 5, 2022
* fix: fail early if using --native with .jsh
Fixes quarkusio#510

* fix: jbang --interactive test.jsh no longer fails on empty on file.
Fixes quarkusio#465

* fix: --native x.jsh prints warning instead of hard error.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants