zipkin.server

Class ZipkinQueryApiV1

java.lang.Object

zipkin.server.ZipkinQueryApiV1

@RestController
 @RequestMapping(value="/api/v1")
 @CrossOrigin(value="${zipkin.query.allowed-origins:*}")
public class ZipkinQueryApiV1
extends Object

Implements the json api used by the Zipkin UI See com.twitter.zipkin.query.ZipkinQueryController

Constructor Summary

Constructors

Constructor and Description
ZipkinQueryApiV1(StorageComponent storage)

Method Summary

Modifier and Type	Method and Description
byte[]	getDependencies(long endTs, Long lookback)
org.springframework.http.ResponseEntity<List<String>>	getServiceNames()
org.springframework.http.ResponseEntity<List<String>>	getSpanNames(String serviceName)
String	getTrace(String traceIdHex, org.springframework.web.context.request.WebRequest request)
String	getTraces(String serviceName, String spanName, String annotationQuery, Long minDuration, Long maxDuration, Long endTs, Long lookback, Integer limit)
void	notFound()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZipkinQueryApiV1

@Autowired
public ZipkinQueryApiV1(StorageComponent storage)

Method Detail

getDependencies

@RequestMapping(value="/dependencies",
                method=GET,
                produces="application/json")
public byte[] getDependencies(@RequestParam(value="endTs",required=true)
                                                                                                                                              long endTs,
                                                                                                                                              @RequestParam(value="lookback",required=false)
                                                                                                                                              Long lookback)

getServiceNames

@RequestMapping(value="/services",
                method=GET)
public org.springframework.http.ResponseEntity<List<String>> getServiceNames()

getSpanNames

@RequestMapping(value="/spans",
                method=GET)
public org.springframework.http.ResponseEntity<List<String>> getSpanNames(@RequestParam(value="serviceName",required=true)
                                                                                                                                      String serviceName)

getTraces

@RequestMapping(value="/traces",
                method=GET,
                produces="application/json")
public String getTraces(@RequestParam(value="serviceName",required=false)
                                                                                                                                  String serviceName,
                                                                                                                                  @RequestParam(value="spanName",defaultValue="all")
                                                                                                                                  String spanName,
                                                                                                                                  @RequestParam(value="annotationQuery",required=false)
                                                                                                                                  String annotationQuery,
                                                                                                                                  @RequestParam(value="minDuration",required=false)
                                                                                                                                  Long minDuration,
                                                                                                                                  @RequestParam(value="maxDuration",required=false)
                                                                                                                                  Long maxDuration,
                                                                                                                                  @RequestParam(value="endTs",required=false)
                                                                                                                                  Long endTs,
                                                                                                                                  @RequestParam(value="lookback",required=false)
                                                                                                                                  Long lookback,
                                                                                                                                  @RequestParam(value="limit",required=false)
                                                                                                                                  Integer limit)

getTrace

@RequestMapping(value="/trace/{traceIdHex}",
                method=GET,
                produces="application/json")
public String getTrace(@PathVariable
                                                                                                                                             String traceIdHex,
                                                                                                                                             org.springframework.web.context.request.WebRequest request)

notFound

@ExceptionHandler(value=zipkin.server.ZipkinQueryApiV1.TraceNotFoundException.class)
 @ResponseStatus(value=NOT_FOUND)
public void notFound()