Data Model

Note this page is out-of-date. Please view the Zipkin Api doc which elaborates the fields in the model until this page is updated.

In order to illustrate the tracing data that Zipkin displays, let’s relate it to the equivalent information in the Zipkin data model. By comparing these, we see that

  • inbound and outbound requests are in different spans
  • spans that include cs can log an sa annotation of where they are going
    • This helps when the destination protocol isn’t Zipkin instrumented, such as MySQL.

First, we see one trace as shown in the Zipkin trace viewer:

Zipkin Screenshot

And the same trace in the data model of Zipkin:

  1.   
  2.   [
  3.     {
  4.       "traceId": "bd7a977555f6b982",
  5.       "name": "get",
  6.       "id": "bd7a977555f6b982",
  7.       "timestamp": 1458702548467000,
  8.       "duration": 386000,
  9.       "annotations": [
  10.         {
  11.           "endpoint": {
  12.             "serviceName": "zipkin-query",
  13.             "ipv4": "192.168.1.2",
  14.             "port": 9411
  15.           },
  16.           "timestamp": 1458702548467000,
  17.           "value": "sr"
  18.         },
  19.         {
  20.           "endpoint": {
  21.             "serviceName": "zipkin-query",
  22.             "ipv4": "192.168.1.2",
  23.             "port": 9411
  24.           },
  25.           "timestamp": 1458702548853000,
  26.           "value": "ss"
  27.         }
  28.       ],
  29.       "binaryAnnotations": []
  30.     },
  31.     {
  32.       "traceId": "bd7a977555f6b982",
  33.       "name": "get-traces",
  34.       "id": "ebf33e1a81dc6f71",
  35.       "parentId": "bd7a977555f6b982",
  36.       "timestamp": 1458702548478000,
  37.       "duration": 354374,
  38.       "annotations": [],
  39.       "binaryAnnotations": [
  40.         {
  41.           "key": "lc",
  42.           "value": "JDBCSpanStore",
  43.           "endpoint": {
  44.             "serviceName": "zipkin-query",
  45.             "ipv4": "192.168.1.2",
  46.             "port": 9411
  47.           }
  48.         },
  49.         {
  50.           "key": "request",
  51.           "value": "QueryRequest{serviceName=zipkin-query, spanName=null, annotations=[], binaryAnnotations={}, minDuration=null, maxDuration=null, endTs=1458702548478, lookback=86400000, limit=1}",
  52.           "endpoint": {
  53.             "serviceName": "zipkin-query",
  54.             "ipv4": "192.168.1.2",
  55.             "port": 9411
  56.           }
  57.         }
  58.       ]
  59.     },
  60.     {
  61.       "traceId": "bd7a977555f6b982",
  62.       "name": "query",
  63.       "id": "be2d01e33cc78d97",
  64.       "parentId": "ebf33e1a81dc6f71",
  65.       "timestamp": 1458702548786000,
  66.       "duration": 13000,
  67.       "annotations": [
  68.         {
  69.           "endpoint": {
  70.             "serviceName": "zipkin-query",
  71.             "ipv4": "192.168.1.2",
  72.             "port": 9411
  73.           },
  74.           "timestamp": 1458702548786000,
  75.           "value": "cs"
  76.         },
  77.         {
  78.           "endpoint": {
  79.             "serviceName": "zipkin-query",
  80.             "ipv4": "192.168.1.2",
  81.             "port": 9411
  82.           },
  83.           "timestamp": 1458702548799000,
  84.           "value": "cr"
  85.         }
  86.       ],
  87.       "binaryAnnotations": [
  88.         {
  89.           "key": "jdbc.query",
  90.           "value": "select distinct `zipkin_spans`.`trace_id` from `zipkin_spans` join `zipkin_annotations` on (`zipkin_spans`.`trace_id` = `zipkin_annotations`.`trace_id` and `zipkin_spans`.`id` = `zipkin_annotations`.`span_id`) where (`zipkin_annotations`.`endpoint_service_name` = ? and `zipkin_spans`.`start_ts` between ? and ?) order by `zipkin_spans`.`start_ts` desc limit ?",
  91.           "endpoint": {
  92.             "serviceName": "zipkin-query",
  93.             "ipv4": "192.168.1.2",
  94.             "port": 9411
  95.           }
  96.         },
  97.         {
  98.           "key": "sa",
  99.           "value": true,
  100.           "endpoint": {
  101.             "serviceName": "spanstore-jdbc",
  102.             "ipv4": "127.0.0.1",
  103.             "port": 3306
  104.           }
  105.         }
  106.       ]
  107.     },
  108.     {
  109.       "traceId": "bd7a977555f6b982",
  110.       "name": "query",
  111.       "id": "13038c5fee5a2f2e",
  112.       "parentId": "ebf33e1a81dc6f71",
  113.       "timestamp": 1458702548817000,
  114.       "duration": 1000,
  115.       "annotations": [
  116.         {
  117.           "endpoint": {
  118.             "serviceName": "zipkin-query",
  119.             "ipv4": "192.168.1.2",
  120.             "port": 9411
  121.           },
  122.           "timestamp": 1458702548817000,
  123.           "value": "cs"
  124.         },
  125.         {
  126.           "endpoint": {
  127.             "serviceName": "zipkin-query",
  128.             "ipv4": "192.168.1.2",
  129.             "port": 9411
  130.           },
  131.           "timestamp": 1458702548818000,
  132.           "value": "cr"
  133.         }
  134.       ],
  135.       "binaryAnnotations": [
  136.         {
  137.           "key": "jdbc.query",
  138.           "value": "select `zipkin_spans`.`trace_id`, `zipkin_spans`.`id`, `zipkin_spans`.`name`, `zipkin_spans`.`parent_id`, `zipkin_spans`.`debug`, `zipkin_spans`.`start_ts`, `zipkin_spans`.`duration` from `zipkin_spans` where `zipkin_spans`.`trace_id` in (?)",
  139.           "endpoint": {
  140.             "serviceName": "zipkin-query",
  141.             "ipv4": "192.168.1.2",
  142.             "port": 9411
  143.           }
  144.         },
  145.         {
  146.           "key": "sa",
  147.           "value": true,
  148.           "endpoint": {
  149.             "serviceName": "spanstore-jdbc",
  150.             "ipv4": "127.0.0.1",
  151.             "port": 3306
  152.           }
  153.         }
  154.       ]
  155.     },
  156.     {
  157.       "traceId": "bd7a977555f6b982",
  158.       "name": "query",
  159.       "id": "37ee55f3d3a94336",
  160.       "parentId": "ebf33e1a81dc6f71",
  161.       "timestamp": 1458702548827000,
  162.       "duration": 2000,
  163.       "annotations": [
  164.         {
  165.           "endpoint": {
  166.             "serviceName": "zipkin-query",
  167.             "ipv4": "192.168.1.2",
  168.             "port": 9411
  169.           },
  170.           "timestamp": 1458702548827000,
  171.           "value": "cs"
  172.         },
  173.         {
  174.           "endpoint": {
  175.             "serviceName": "zipkin-query",
  176.             "ipv4": "192.168.1.2",
  177.             "port": 9411
  178.           },
  179.           "timestamp": 1458702548829000,
  180.           "value": "cr"
  181.         }
  182.       ],
  183.       "binaryAnnotations": [
  184.         {
  185.           "key": "jdbc.query",
  186.           "value": "select `zipkin_annotations`.`trace_id`, `zipkin_annotations`.`span_id`, `zipkin_annotations`.`a_key`, `zipkin_annotations`.`a_value`, `zipkin_annotations`.`a_type`, `zipkin_annotations`.`a_timestamp`, `zipkin_annotations`.`endpoint_ipv4`, `zipkin_annotations`.`endpoint_port`, `zipkin_annotations`.`endpoint_service_name` from `zipkin_annotations` where `zipkin_annotations`.`trace_id` in (?) order by `zipkin_annotations`.`a_timestamp` asc, `zipkin_annotations`.`a_key` asc",
  187.           "endpoint": {
  188.             "serviceName": "zipkin-query",
  189.             "ipv4": "192.168.1.2",
  190.             "port": 9411
  191.           }
  192.         },
  193.         {
  194.           "key": "sa",
  195.           "value": true,
  196.           "endpoint": {
  197.             "serviceName": "spanstore-jdbc",
  198.             "ipv4": "127.0.0.1",
  199.             "port": 3306
  200.           }
  201.         }
  202.       ]
  203.     }
  204.   ]  
  205.