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

Jaeger Deployment doc page needs revision #472

Open
kevinearls opened this Issue Oct 16, 2017 · 5 comments

Comments

Projects
None yet
4 participants
@kevinearls
Member

kevinearls commented Oct 16, 2017

I just went through an exercise of running Jaeger by running Cassandra, the collector, the agent, and the UI in separate docker containers following the instructions here: http://jaeger.readthedocs.io/en/latest/deployment/. Most of the needed information is there, although not in a way that would be clear to a novice, and there are also a few omissions.

Here are my suggestions:

  1. The section order should change to be the same as the order you need to do things in, i.e. first start the storage backend, and then the collector, before starting the agent or ui. If the agent is started before the collector it will produce errors repeatedly at short, regular intervals.

  2. For Cassandra, adding syntax for the docker command might be helpful. Also, I don't think this page points out that you need to clone source to get the create.sh script to create the keyspace.

  3. For the collector, although the doc does say you need the --cassandra.keyspace and --cassandra.servers options, it never gives proper syntax for the command. I used "docker run -it --rm -p14267:14267 -p14268:14268  jaegertracing/jaeger-collector /go/bin/collector-linux --cassandra.keyspace=jaeger_v1_test --cassandra.servers=192.168.0.183"

I also found that if I didn't give the port options when I started the collector the agent couldn't connect to it. I'm not sure whether this was something I was doing, or if this needs to be added to the doc.

  1. Agent. This command requires the --collector.host-port option, which also means it needs the longer form for the docker command (with /go/bin/agent-linux on the command line.) . The long form is specified in the "Discovery System Integration" section, but I found that a bit confusing, as it talks about multiple collectors behind a load balancer, and that's not something that I was doing, or someone who was trying to read the docs for the first time might be doing.

  2. UI. An example docker command would be helpful. I did "docker run -it -p16686:16686 jaegertracing/jaeger-query:latest /go/bin/query-linux --cassandra.keyspace=jaeger_v1_test --cassandra.servers=192.168.0.183"

@jpkrohling

This comment has been minimized.

Member

jpkrohling commented Oct 16, 2017

Possibly related:
#468 (comment)
#466 (comment)

That said, docs are going to be overhauled.

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 16, 2017

Modified the format as storage,collector,agent,UI&Query services
Changes made other than reordering : added link to source repository for
create.sh script, added example to collector and Query&UI Service Added
an example for Agent Service

Closes: jaegertracing#472
Signed-off-by:Deepika Upadhyay <deepikaupadhyay01@gmail.com>
@dexter816

This comment has been minimized.

Contributor

dexter816 commented Oct 16, 2017

I Tried adding the changes that were highlighted , could these helpful

@yurishkuro

This comment has been minimized.

Member

yurishkuro commented Oct 16, 2017

@kevinearls no objections to changing/extending the docs, but I don't think we should be recommending overriding command line switches in Docker commands, they all have equivalent env variables.

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 16, 2017

Modified the format as storage,collector,agent,UI&Query services
Changes made other than reordering : added link to source repository for
create.sh script, added example to collector and Query&UI Service Added
an example for Agent Service

Closes: jaegertracing#472
Signed-off-by: Deepika Upadhyay <deepikaupadhyay01@gmail.com>

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 17, 2017

Modified deployment.md with updates
Fixes:jaegertracing#472
Signed-of-by: Deepika Upadhyay <deepikaupadhyay01@gmail.com>

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 17, 2017

Modified deployment.md with updates
Fixes:jaegertracing#472
Signed-off-by: Deepika Upadhyay <deepikaupadhyay01@gmail.com>
@kevinearls

This comment has been minimized.

Member

kevinearls commented Oct 18, 2017

@yurishkuro I agree, but are those documented anywhere? To get the equivalent environment variables do I just take the options output by --help, change them to all caps, and change periods and dashes to underscores?

@yurishkuro

This comment has been minimized.

Member

yurishkuro commented Oct 18, 2017

Yes

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 21, 2017

reordered storage,collector,agent,UI&Query services subtopics in
docs/deployment.md

Changes made:
- replaced ElasticSearch to Elasticsearch
- updated example commands for better readibilty
- minor updates in docs/deployment.md

Closes: jaegertracing#472
Signed-off-by: Deepika Upadhyay <deepikaupadhyay01@gmail.com>

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 21, 2017

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 21, 2017

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 21, 2017

Updated docs/deployment.md with reordering subtopics
Changes made:

-replaced ElasticSearch to Elasticsearch
-updated example commands for better readibilty
-minor updates in docs/deployment.md

Closes: jaegertracing#472
Signed-off-by: Deepika Upadhyay deepikaupadhyay01@gmail.com

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 22, 2017

Updated docs/deployment.md with reordering subtopics
Changes made:

-replaced ElasticSearch to Elasticsearch
-updated example commands for better readibilty
-minor updates in docs/deployment.md

Closes: jaegertracing#472
Signed-off-by: Deepika Upadhyay deepikaupadhyay01@gmail.com

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 22, 2017

Updated docs/deployment.md with reordering subtopics
Changes made:

-replaced ElasticSearch to Elasticsearch
-updated example commands for better readibilty
-minor updates in docs/deployment.md

Closes: jaegertracing#472
Signed-off-by: Deepika Upadhyay deepikaupadhyay01@gmail.com

dexter816 added a commit to dexter816/jaeger that referenced this issue Oct 22, 2017

Modified the format as storage,collector,agent,UI&Query services
Changes made other than reordering : added link to source repository for
create.sh script, added example to collector and Query&UI Service Added
an example for Agent Service

Closes: jaegertracing#472
Signed-off-by:Deepika Upadhyay <deepikaupadhyay01@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment