{"action":"created","comment":{"url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/comments/49281241","id":49281241,"diff_hunk":"@@ -9,3 +9,10 @@ The following OpenTracing APIs are currently available in the RFC stage:\n \n Please refer to the README files in the respective projects for examples of usage.\n \n+### Implementation Notes\n+\n+OpenTracing APIs intend to express a similar experience to the user, while still being idiomatic to the language or framework. The following concepts apply to all variants.\n+\n+A **Span** is shared mutable state. It accumulates tags and logs, and can also create children. Finishing a span means capturing its state as a SpanRecord.\n+\n+A **SpanRecord** is an immutable representation of a completed span. It can be reported directly to an OpenTracing system, or encoded into a representation of an alternate system, such as HTrace or Zipkin.","path":"apis.md","position":10,"original_position":10,"commit_id":"32b556bda374009662527c659779c8099bc85396","original_commit_id":"32b556bda374009662527c659779c8099bc85396","user":{"login":"yurishkuro","id":3523016,"avatar_url":"https://avatars.githubusercontent.com/u/3523016?v=3","gravatar_id":"","url":"https://api.github.com/users/yurishkuro","html_url":"https://github.com/yurishkuro","followers_url":"https://api.github.com/users/yurishkuro/followers","following_url":"https://api.github.com/users/yurishkuro/following{/other_user}","gists_url":"https://api.github.com/users/yurishkuro/gists{/gist_id}","starred_url":"https://api.github.com/users/yurishkuro/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yurishkuro/subscriptions","organizations_url":"https://api.github.com/users/yurishkuro/orgs","repos_url":"https://api.github.com/users/yurishkuro/repos","events_url":"https://api.github.com/users/yurishkuro/events{/privacy}","received_events_url":"https://api.github.com/users/yurishkuro/received_events","type":"User","site_admin":false},"body":"> I'm not sure, but seems if it were called Mock or FakeTracer, it would still allow folks to playground, and write test harnesses, but without the warranties.\r\n\r\n@adriancole  Can you elaborate which features you would want to see in such Mock tracer?  And if we have example/zipkin-like converted to a real reference implementation, wouldn't it be sufficient as a playground? I am a bit uneasy about maintaining a full-featured \"fake\" implementation.\r\n\r\n> Other tracers for zipkin exist in the OpenZipkin org, and have coupling there. I think it would make more sense for a new python zipkin tracer to exist as \"zipkin-python\" or similar there.. @abesto thoughts?\r\n\r\nThat's fine with me: `openzipkin/opentracing-zipkin-python`","created_at":"2016-01-10T20:50:57Z","updated_at":"2016-01-10T20:50:57Z","html_url":"https://github.com/opentracing/opentracing.github.io/pull/13#discussion_r49281241","pull_request_url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13","_links":{"self":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/comments/49281241"},"html":{"href":"https://github.com/opentracing/opentracing.github.io/pull/13#discussion_r49281241"},"pull_request":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13"}}},"pull_request":{"url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13","id":55555289,"html_url":"https://github.com/opentracing/opentracing.github.io/pull/13","diff_url":"https://github.com/opentracing/opentracing.github.io/pull/13.diff","patch_url":"https://github.com/opentracing/opentracing.github.io/pull/13.patch","issue_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/13","number":13,"state":"open","locked":false,"title":"Clarifies standard api types for span","user":{"login":"adriancole","id":64215,"avatar_url":"https://avatars.githubusercontent.com/u/64215?v=3","gravatar_id":"","url":"https://api.github.com/users/adriancole","html_url":"https://github.com/adriancole","followers_url":"https://api.github.com/users/adriancole/followers","following_url":"https://api.github.com/users/adriancole/following{/other_user}","gists_url":"https://api.github.com/users/adriancole/gists{/gist_id}","starred_url":"https://api.github.com/users/adriancole/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adriancole/subscriptions","organizations_url":"https://api.github.com/users/adriancole/orgs","repos_url":"https://api.github.com/users/adriancole/repos","events_url":"https://api.github.com/users/adriancole/events{/privacy}","received_events_url":"https://api.github.com/users/adriancole/received_events","type":"User","site_admin":false},"body":"Prior to this change, there was a mutable accumulator called `Span` (similar to HTrace's one), and also a concept of a immutable finished span called `RawSpan`. Since `RawSpan` was the input of `RecordSpan`, and \"raw\" distracts at least me, this changes terminology to say `SpanRecord`. I believe `SpanRecord` more closely relates both the the apis that use it, and also it being the canonical immutable struct.","created_at":"2016-01-10T01:17:47Z","updated_at":"2016-01-10T20:50:57Z","closed_at":null,"merged_at":null,"merge_commit_sha":"8b6d9893fa79761d01205a862e1feeb2de8fefaf","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13/commits","review_comments_url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13/comments","review_comment_url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/comments{/number}","comments_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/13/comments","statuses_url":"https://api.github.com/repos/opentracing/opentracing.github.io/statuses/32b556bda374009662527c659779c8099bc85396","head":{"label":"opentracing:clarify-span-vs-rawspan","ref":"clarify-span-vs-rawspan","sha":"32b556bda374009662527c659779c8099bc85396","user":{"login":"opentracing","id":15482765,"avatar_url":"https://avatars.githubusercontent.com/u/15482765?v=3","gravatar_id":"","url":"https://api.github.com/users/opentracing","html_url":"https://github.com/opentracing","followers_url":"https://api.github.com/users/opentracing/followers","following_url":"https://api.github.com/users/opentracing/following{/other_user}","gists_url":"https://api.github.com/users/opentracing/gists{/gist_id}","starred_url":"https://api.github.com/users/opentracing/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opentracing/subscriptions","organizations_url":"https://api.github.com/users/opentracing/orgs","repos_url":"https://api.github.com/users/opentracing/repos","events_url":"https://api.github.com/users/opentracing/events{/privacy}","received_events_url":"https://api.github.com/users/opentracing/received_events","type":"Organization","site_admin":false},"repo":{"id":48717396,"name":"opentracing.github.io","full_name":"opentracing/opentracing.github.io","owner":{"login":"opentracing","id":15482765,"avatar_url":"https://avatars.githubusercontent.com/u/15482765?v=3","gravatar_id":"","url":"https://api.github.com/users/opentracing","html_url":"https://github.com/opentracing","followers_url":"https://api.github.com/users/opentracing/followers","following_url":"https://api.github.com/users/opentracing/following{/other_user}","gists_url":"https://api.github.com/users/opentracing/gists{/gist_id}","starred_url":"https://api.github.com/users/opentracing/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opentracing/subscriptions","organizations_url":"https://api.github.com/users/opentracing/orgs","repos_url":"https://api.github.com/users/opentracing/repos","events_url":"https://api.github.com/users/opentracing/events{/privacy}","received_events_url":"https://api.github.com/users/opentracing/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/opentracing/opentracing.github.io","description":"Source code for http://opentracing.io","fork":false,"url":"https://api.github.com/repos/opentracing/opentracing.github.io","forks_url":"https://api.github.com/repos/opentracing/opentracing.github.io/forks","keys_url":"https://api.github.com/repos/opentracing/opentracing.github.io/keys{/key_id}","collaborators_url":"https://api.github.com/repos/opentracing/opentracing.github.io/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/opentracing/opentracing.github.io/teams","hooks_url":"https://api.github.com/repos/opentracing/opentracing.github.io/hooks","issue_events_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/events{/number}","events_url":"https://api.github.com/repos/opentracing/opentracing.github.io/events","assignees_url":"https://api.github.com/repos/opentracing/opentracing.github.io/assignees{/user}","branches_url":"https://api.github.com/repos/opentracing/opentracing.github.io/branches{/branch}","tags_url":"https://api.github.com/repos/opentracing/opentracing.github.io/tags","blobs_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/refs{/sha}","trees_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/trees{/sha}","statuses_url":"https://api.github.com/repos/opentracing/opentracing.github.io/statuses/{sha}","languages_url":"https://api.github.com/repos/opentracing/opentracing.github.io/languages","stargazers_url":"https://api.github.com/repos/opentracing/opentracing.github.io/stargazers","contributors_url":"https://api.github.com/repos/opentracing/opentracing.github.io/contributors","subscribers_url":"https://api.github.com/repos/opentracing/opentracing.github.io/subscribers","subscription_url":"https://api.github.com/repos/opentracing/opentracing.github.io/subscription","commits_url":"https://api.github.com/repos/opentracing/opentracing.github.io/commits{/sha}","git_commits_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/commits{/sha}","comments_url":"https://api.github.com/repos/opentracing/opentracing.github.io/comments{/number}","issue_comment_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/comments{/number}","contents_url":"https://api.github.com/repos/opentracing/opentracing.github.io/contents/{+path}","compare_url":"https://api.github.com/repos/opentracing/opentracing.github.io/compare/{base}...{head}","merges_url":"https://api.github.com/repos/opentracing/opentracing.github.io/merges","archive_url":"https://api.github.com/repos/opentracing/opentracing.github.io/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/opentracing/opentracing.github.io/downloads","issues_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues{/number}","pulls_url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls{/number}","milestones_url":"https://api.github.com/repos/opentracing/opentracing.github.io/milestones{/number}","notifications_url":"https://api.github.com/repos/opentracing/opentracing.github.io/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/opentracing/opentracing.github.io/labels{/name}","releases_url":"https://api.github.com/repos/opentracing/opentracing.github.io/releases{/id}","created_at":"2015-12-28T23:37:19Z","updated_at":"2016-01-10T20:42:50Z","pushed_at":"2016-01-10T06:10:49Z","git_url":"git://github.com/opentracing/opentracing.github.io.git","ssh_url":"git@github.com:opentracing/opentracing.github.io.git","clone_url":"https://github.com/opentracing/opentracing.github.io.git","svn_url":"https://github.com/opentracing/opentracing.github.io","homepage":"","size":50,"stargazers_count":0,"watchers_count":0,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":1,"mirror_url":null,"open_issues_count":7,"forks":1,"open_issues":7,"watchers":0,"default_branch":"master"}},"base":{"label":"opentracing:master","ref":"master","sha":"20ad46635d1d26f96aa107131b79b6caf0419cf9","user":{"login":"opentracing","id":15482765,"avatar_url":"https://avatars.githubusercontent.com/u/15482765?v=3","gravatar_id":"","url":"https://api.github.com/users/opentracing","html_url":"https://github.com/opentracing","followers_url":"https://api.github.com/users/opentracing/followers","following_url":"https://api.github.com/users/opentracing/following{/other_user}","gists_url":"https://api.github.com/users/opentracing/gists{/gist_id}","starred_url":"https://api.github.com/users/opentracing/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opentracing/subscriptions","organizations_url":"https://api.github.com/users/opentracing/orgs","repos_url":"https://api.github.com/users/opentracing/repos","events_url":"https://api.github.com/users/opentracing/events{/privacy}","received_events_url":"https://api.github.com/users/opentracing/received_events","type":"Organization","site_admin":false},"repo":{"id":48717396,"name":"opentracing.github.io","full_name":"opentracing/opentracing.github.io","owner":{"login":"opentracing","id":15482765,"avatar_url":"https://avatars.githubusercontent.com/u/15482765?v=3","gravatar_id":"","url":"https://api.github.com/users/opentracing","html_url":"https://github.com/opentracing","followers_url":"https://api.github.com/users/opentracing/followers","following_url":"https://api.github.com/users/opentracing/following{/other_user}","gists_url":"https://api.github.com/users/opentracing/gists{/gist_id}","starred_url":"https://api.github.com/users/opentracing/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/opentracing/subscriptions","organizations_url":"https://api.github.com/users/opentracing/orgs","repos_url":"https://api.github.com/users/opentracing/repos","events_url":"https://api.github.com/users/opentracing/events{/privacy}","received_events_url":"https://api.github.com/users/opentracing/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/opentracing/opentracing.github.io","description":"Source code for http://opentracing.io","fork":false,"url":"https://api.github.com/repos/opentracing/opentracing.github.io","forks_url":"https://api.github.com/repos/opentracing/opentracing.github.io/forks","keys_url":"https://api.github.com/repos/opentracing/opentracing.github.io/keys{/key_id}","collaborators_url":"https://api.github.com/repos/opentracing/opentracing.github.io/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/opentracing/opentracing.github.io/teams","hooks_url":"https://api.github.com/repos/opentracing/opentracing.github.io/hooks","issue_events_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/events{/number}","events_url":"https://api.github.com/repos/opentracing/opentracing.github.io/events","assignees_url":"https://api.github.com/repos/opentracing/opentracing.github.io/assignees{/user}","branches_url":"https://api.github.com/repos/opentracing/opentracing.github.io/branches{/branch}","tags_url":"https://api.github.com/repos/opentracing/opentracing.github.io/tags","blobs_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/refs{/sha}","trees_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/trees{/sha}","statuses_url":"https://api.github.com/repos/opentracing/opentracing.github.io/statuses/{sha}","languages_url":"https://api.github.com/repos/opentracing/opentracing.github.io/languages","stargazers_url":"https://api.github.com/repos/opentracing/opentracing.github.io/stargazers","contributors_url":"https://api.github.com/repos/opentracing/opentracing.github.io/contributors","subscribers_url":"https://api.github.com/repos/opentracing/opentracing.github.io/subscribers","subscription_url":"https://api.github.com/repos/opentracing/opentracing.github.io/subscription","commits_url":"https://api.github.com/repos/opentracing/opentracing.github.io/commits{/sha}","git_commits_url":"https://api.github.com/repos/opentracing/opentracing.github.io/git/commits{/sha}","comments_url":"https://api.github.com/repos/opentracing/opentracing.github.io/comments{/number}","issue_comment_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/comments{/number}","contents_url":"https://api.github.com/repos/opentracing/opentracing.github.io/contents/{+path}","compare_url":"https://api.github.com/repos/opentracing/opentracing.github.io/compare/{base}...{head}","merges_url":"https://api.github.com/repos/opentracing/opentracing.github.io/merges","archive_url":"https://api.github.com/repos/opentracing/opentracing.github.io/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/opentracing/opentracing.github.io/downloads","issues_url":"https://api.github.com/repos/opentracing/opentracing.github.io/issues{/number}","pulls_url":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls{/number}","milestones_url":"https://api.github.com/repos/opentracing/opentracing.github.io/milestones{/number}","notifications_url":"https://api.github.com/repos/opentracing/opentracing.github.io/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/opentracing/opentracing.github.io/labels{/name}","releases_url":"https://api.github.com/repos/opentracing/opentracing.github.io/releases{/id}","created_at":"2015-12-28T23:37:19Z","updated_at":"2016-01-10T20:42:50Z","pushed_at":"2016-01-10T06:10:49Z","git_url":"git://github.com/opentracing/opentracing.github.io.git","ssh_url":"git@github.com:opentracing/opentracing.github.io.git","clone_url":"https://github.com/opentracing/opentracing.github.io.git","svn_url":"https://github.com/opentracing/opentracing.github.io","homepage":"","size":50,"stargazers_count":0,"watchers_count":0,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":1,"mirror_url":null,"open_issues_count":7,"forks":1,"open_issues":7,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13"},"html":{"href":"https://github.com/opentracing/opentracing.github.io/pull/13"},"issue":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/13"},"comments":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/issues/13/comments"},"review_comments":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13/comments"},"review_comment":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/pulls/13/commits"},"statuses":{"href":"https://api.github.com/repos/opentracing/opentracing.github.io/statuses/32b556bda374009662527c659779c8099bc85396"}}}}