zipkin.server

Class ZipkinQueryApiV2

java.lang.Object

zipkin.server.ZipkinQueryApiV2

@RestController
 @RequestMapping(value="/api/v2")
 @CrossOrigin(value="${zipkin.query.allowed-origins:*}")
 @ConditionalOnProperty(name="zipkin.query.enabled",
                       matchIfMissing=true)
public class ZipkinQueryApiV2
extends Object

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, int limit)
void	notFound()
void	version2StorageNotConfigured()

Methods inherited from class java.lang.Object

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

Method Detail

getDependencies

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

Throws:

IOException

getServiceNames

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

Throws:

IOException

getSpanNames

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

Throws:

IOException

getTraces

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

Throws:

IOException

getTrace

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

Throws:

IOException

version2StorageNotConfigured

@ExceptionHandler(value=zipkin.server.ZipkinQueryApiV2.Version2StorageNotConfigured.class)
 @ResponseStatus(value=NOT_FOUND)
public void version2StorageNotConfigured()

notFound

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