openzipkin.github.io icon indicating copy to clipboard operation
openzipkin.github.io copied to clipboard

architecture.md: Please provide example of span data

Open guettli opened this issue 9 years ago • 4 comments

Thank you very much for the docs. Especially the architecture page helped me a lot.

I have one wish: Please provide an example of what a typical span data contains. Maybe directly as json source.

I guess this will make it easier to understand.

I refer to this page:

https://github.com/openzipkin/openzipkin.github.io/blob/master/pages/architecture.md

Thank you very much.

guettli avatar Jan 05 '17 19:01 guettli

would you say this is similar or a dupe of #11? Would you like to see what part of the architecture contribute to which fields? Ex. pinning https://gist.github.com/adriancole/5ec532ddc68eb7a0d5d0e18714b5821c to components in zipkin architecture and a resulting json?

codefromthecrypt avatar Jan 06 '17 04:01 codefromthecrypt

I think #11 is about the same topic, but on a different layer.

I am a new comer, trying to understand the architecture.

I would like to see data in the docs. It makes sense to show the data in json format.

How the json gets generated, that is a different topic (I guess this is what #11 is about).

For my eyes, it is hard to read the ascii art diagram of the gist. The screenshot in #11 is easier to understand (my personal opinion).

Would you like to see what part of the architecture contribute to which fields?

yes

guettli avatar Jan 06 '17 11:01 guettli

thanks for the feedback, I'll try to put something together in a couple days and ping you on it.

codefromthecrypt avatar Jan 06 '17 15:01 codefromthecrypt

this is the first step, which is to show the overall flow. It is quite a challenge to attempt to show levels of abstraction from architecture into low level details such as json in the same diagram. In fact I don't think this is an architectural concern. However, I will try to help bridge the gap somewhere, focusing on what data is in-band vs out-of-band, similar to presentations.

https://gist.github.com/adriancole/80f198ee56343ba864fe8b2a57d3eff7

codefromthecrypt avatar Jan 11 '17 05:01 codefromthecrypt