Add readme for spinning up notebooks by shreyagupta30 · Pull Request #53 · jaegertracing/jaeger-analytics-java

shreyagupta30 · 2020-10-26T11:01:00Z

This fixes #51
I have added a readme file that provides instructions on how to spin up the jupyter notebooks for the Data Analytics.

cc: @jpkrohling

Signed-off-by: shreyagupta30 <shreyagupta3011@gmail.com>

fktkrt · 2020-10-26T12:33:25Z

I've wanted to compose a similar guide to this one, but got buried in another projects.
Anyway, please take a look at my PR #54 as it has a docker-compose solution, which can we used for this guide also, if you want to simply the process of setting these up.

If it makes sense, that can be merged, and this PR can be easily changed to use that compose.
What do you think?

yurishkuro

please add links to the main README
are the screenshots really critical/necessary? I feel like they can be safely omitted and text can describe what you want them to show.

shreyagupta30 · 2020-10-27T09:39:55Z

@yurishkuro Thanks for your feedback. I will make the required changes

Signed-off-by: shreyagupta30 <shreyagupta3011@gmail.com>

shreyagupta30 · 2020-11-06T13:59:14Z

Hi @jpkrohling and @yurishkuro, I have made the requested changes in the readme. Kindly review it and let me know if any further changes are required.

jpkrohling · 2020-11-09T15:19:05Z

jupyter/README.md

+1. For Jaeger UI: 
+
+``` bash
+docker run --rm -it -p 16686:16686 --name=jaeger jaegertracing/all-in-one:1.17


Suggested change

docker run --rm -it -p 16686:16686 --name=jaeger jaegertracing/all-in-one:1.17

docker run --rm -it -p 16686:16686 --name=jaeger jaegertracing/all-in-one:1.20

jpkrohling · 2020-11-09T15:22:24Z

jupyter/README.md

+
+*Note : Add `-v ${PWD}:/home/jovyan/work` to Jupyter notebook if you want to open the notebooks from your current directory.*
+
+After succesfully running the docker script, you will be able to see a URL in you terminal with unique token. Paste that URL in your browser to start the jupyter notebook.


Suggested change

After succesfully running the docker script, you will be able to see a URL in you terminal with unique token. Paste that URL in your browser to start the jupyter notebook.

After successfully running the `docker` commands, you will be able to see a URL in you terminal with unique token. Paste that URL in your browser to start the Jupyter notebook.

jpkrohling · 2020-11-09T15:23:08Z

jupyter/README.md

+For the analysis we have to generate some data, so in the HotROD UI click on the blue boxes to order a car that generates nice traces. To verify that the trace reached Jaeger open Jaeger UI and search for traces from the `frontend` service. 
+You'll be able to see the generated traces for the services and operation. 
+
+Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the docker container.


Suggested change

Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the docker container.

Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the container.

jpkrohling · 2020-11-09T15:27:58Z

jupyter/README.md

+For the analysis we have to generate some data, so in the HotROD UI click on the blue boxes to order a car that generates nice traces. To verify that the trace reached Jaeger open Jaeger UI and search for traces from the `frontend` service. 
+You'll be able to see the generated traces for the services and operation. 
+
+Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the docker container.


What does "load the trace there" mean? What are the steps? Which notebook should be opened?

jpkrohling · 2020-11-09T15:28:29Z

jupyter/README.md

+
+Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the docker container.
+
+Before running the analysis we have to load dependencies into the notebook’s classpath. Just click on the dependencies cell to make it active and then on the play icon in the top navigation menu. 


Interesting, I get the errors you were having some time ago:

TraceTraversal<Vertex, Vertex> traversal = graph.traversal(TraceTraversalSource.class) cannot find symbol symbol: class TraceTraversal

Do you remember what was the problem?

Yes, there were some missing dependencies in pom.xml file somewhere but I wasn't able to understand what was the exact problem.

It's a problem in the jaegertracing/jaeger-analytics-java project then? @pavolloffay do you know if there's something missing on our setup?

jpkrohling · 2020-11-09T15:30:15Z

jupyter/README.md

+It should look something like:
+``` java
+String queryHostPort = "jaeger:16686";
+String traceIdStr = "2cb1f0c274c3b4a5"


Where is this then used?

Signed-off-by: shreyagupta30 <shreyagupta3011@gmail.com>

shreyagupta30 · 2020-11-16T07:46:12Z

Hi @jpkrohling, I have made the requested changes and it's ready for review. :)

jpkrohling · 2020-11-16T10:05:09Z

I'm unable to review it today, but will take a look soon.

jpkrohling

Just a couple of minor comments, but it's ready to be merged. @yurishkuro you left a comment earlier on this PR, would you like to take another look?

jpkrohling · 2021-01-22T09:55:02Z

jupyter/README.md

+
+2. For HotROD demo application, run
+``` bash 
+docker run --rm -it -p 8080:8080 --link=jaeger -e JAEGER_ENDPOINT=http://jaeger:14268/api/traces jaegertracing/example-hotrod:1.17


This version should be the same as the all-in-one

jpkrohling · 2021-01-22T09:55:52Z

jupyter/README.md

+
+
+``` bash
+docker run --rm -it -p 8888:8888 -p 4041:4040 -p 9001:9001 --link=jaeger -e JUPYTER_ENABLE_LAB=yes quay.io/jaegertracing/jaeger-analytics-java:latest


-p 4041:4040 -- is it a typo, or should one really be different than the other?

Add readme for spinning up notebooks

c8bfd37

Signed-off-by: shreyagupta30 <shreyagupta3011@gmail.com>

shreyagupta30 force-pushed the readme branch from 91c1ffd to c8bfd37 Compare October 26, 2020 11:01

fktkrt mentioned this pull request Oct 26, 2020

Add basic docker-compose.yaml for Jupyter notebooks #54

Open

yurishkuro reviewed Oct 26, 2020

View reviewed changes

remove the images with descriptive text

9c03568

Signed-off-by: shreyagupta30 <shreyagupta3011@gmail.com>

shreyagupta30 force-pushed the readme branch from eea26c9 to 9c03568 Compare November 6, 2020 13:50

jpkrohling reviewed Nov 9, 2020

View reviewed changes

update the readme

6c92214

Signed-off-by: shreyagupta30 <shreyagupta3011@gmail.com>

shreyagupta30 force-pushed the readme branch from f21ced4 to 6c92214 Compare November 16, 2020 07:45

jpkrohling approved these changes Jan 22, 2021

View reviewed changes

yurishkuro merged commit 4e92b5a into jaegertracing:master Jul 11, 2024

	docker run --rm -it -p 16686:16686 --name=jaeger jaegertracing/all-in-one:1.17
	docker run --rm -it -p 16686:16686 --name=jaeger jaegertracing/all-in-one:1.20


		Note : Add `-v ${PWD}:/home/jovyan/work` to Jupyter notebook if you want to open the notebooks from your current directory.

		After succesfully running the docker script, you will be able to see a URL in you terminal with unique token. Paste that URL in your browser to start the jupyter notebook.

	After succesfully running the docker script, you will be able to see a URL in you terminal with unique token. Paste that URL in your browser to start the jupyter notebook.
	After successfully running the `docker` commands, you will be able to see a URL in you terminal with unique token. Paste that URL in your browser to start the Jupyter notebook.

	Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the docker container.
	Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the container.


		Once we know that the data is stored in Jaeger we can move to Jupyter notebook and load the trace there. Jaeger notebooks are stored in the jupyter directory. This directory can either be opened from the project root directory or from work in case the notebooks from host filesystem are injected into the docker container.

		Before running the analysis we have to load dependencies into the notebook’s classpath. Just click on the dependencies cell to make it active and then on the play icon in the top navigation menu.



		``` bash
		docker run --rm -it -p 8888:8888 -p 4041:4040 -p 9001:9001 --link=jaeger -e JUPYTER_ENABLE_LAB=yes quay.io/jaegertracing/jaeger-analytics-java:latest

Comments

Conversation

shreyagupta30 commented Oct 26, 2020

Uh oh!

fktkrt commented Oct 26, 2020

Uh oh!

yurishkuro left a comment

Choose a reason for hiding this comment

Uh oh!

shreyagupta30 commented Oct 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shreyagupta30 commented Nov 6, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shreyagupta30 commented Nov 16, 2020

Uh oh!

jpkrohling commented Nov 16, 2020

Uh oh!

jpkrohling left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

shreyagupta30 commented Oct 27, 2020 •

edited

Loading