openzipkin / openzipkin.github.io

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

chore: updates data model to V2 JSON. #152

Closed jcchavezs closed 4 years ago

jcchavezs commented 4 years ago

Ping @anuraaga

anuraaga commented 4 years ago

Thanks for updating this json! I think it's fine to merge this but want to point out it doesn't help so much without updating other pages like the one I linked in chat, since I guess we need to explain this thing. What do you think?

codefromthecrypt commented 4 years ago

my 2p is before whereever this is rendered, cite the zipkin2 post endpoint https://zipkin.io/zipkin-api/#/default/post_spans I think we even have example json in the swagger unless memory fails me.. the swagger describes all the fields as well

jcchavezs commented 4 years ago

Actually this data model is based on a zipkin query which might not be the most common use case for users. Unfortunately I did not have time to change to another example so I limited to migrate the existing content into V2.

One thing we could do is to remove this example trace and screenshot and just keep one span of a http trace (which is the most common use case) or do you think we should keep showing a full trace?

Another thing is what Adrian mentioned which is show the example generated by the swagger file.