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

architecture.md: Please provide example of span data #68

Open
guettli opened this issue Jan 5, 2017 · 4 comments
Open

architecture.md: Please provide example of span data #68

guettli opened this issue Jan 5, 2017 · 4 comments

Comments

@guettli
Copy link
Contributor

guettli commented Jan 5, 2017

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.

@codefromthecrypt
Copy link
Member

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?

@guettli
Copy link
Contributor Author

guettli commented Jan 6, 2017

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

@codefromthecrypt
Copy link
Member

codefromthecrypt commented Jan 6, 2017 via email

@codefromthecrypt
Copy link
Member

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 pushed a commit that referenced this issue Jan 11, 2017
While the architecture doc shouldn't focus too much on wire formatting,
it can clarify who's ultimately responsible for data quality, and use
examples in json or headers to illustrate that.

See #68
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants