search

openzipkin / openzipkin.github.io

content for https://zipkin.io
https://zipkin.io
Apache License 2.0
39 stars 64 forks source link

Adds diagram showing trace instrumentation's role in architecture #71

Closed codefromthecrypt closed 7 years ago

codefromthecrypt commented 7 years ago

Adds a sequence diagram that shows instrumentation do things in band and out-of-band

See #68

codefromthecrypt commented 7 years ago

@guettli does this help?

guettli commented 7 years ago

Looks much less boring than a sequence diagram .... on the other hand I like it boring. I like it boring since it is often a good, since most obvious, way.

codefromthecrypt commented 7 years ago

@guettli PTAL I hope this is more what you were looking for (also changed PR description)

codefromthecrypt commented 7 years ago

did some rewording based on ideas from @shakuzen

Here's an example sequence of http tracing where user code calls the resource /foo. This results in a single span, sent asynchronously to Zipkin after user code receives the http response.

then clarifying below the diagram why

Trace instrumentation report spans asynchronously to prevent delays or failures relating to the tracing system from delaying or breaking user code.

Not sure if this is too much info for this section, but maybe it is ok? I chose "user code" instead of application as I didn't want folks to misunderstand application as something not in the same process. If the choice makes things worse, let me know

codefromthecrypt commented 7 years ago

as we can edit at anytime (in fact anyone can raise a PR), merged as I think this was good progress

codefromthecrypt commented 7 years ago

@adriancole https://github.com/adriancole This sequence diagram is easy to understand. Looks good, thank you. BTW, how did you "paint" it? What tool did you use?

I used monodraw which I'm just now getting familiar with. it is pretty good and a bit better than what I used before. There's no built-in sequence diagram, I just drew lines and boxes and moved them around etc.

Thanks for the feedback!

guettli commented 7 years ago

@adriancole off topic: I want to learn zipkin, I have question here at StackO: http://stackoverflow.com/questions/41508180/zipkin-for-profiling-traditional-progamm-one-process-one-thread if you have three minutes ...