com.wavefront.api

Interface ProxyV2API

@Path(value="/v2/")
public interface ProxyV2API

v2 API for the proxy.

Author:

vasily@wavefront.com

Method Summary

Modifier and Type	Method and Description
AgentConfiguration	proxyCheckin(UUID proxyId, String authorization, String hostname, String version, Long currentMillis, com.fasterxml.jackson.databind.JsonNode agentMetrics, Boolean ephemeral) Register the proxy and transmit proxy metrics to Wavefront servers.
void	proxyConfigProcessed(UUID proxyId) Reports confirmation that the proxy has processed and accepted the configuration sent from the back-end.
void	proxyError(UUID proxyId, String details) Reports an error that occurred in the proxy.
javax.ws.rs.core.Response	proxyReport(UUID proxyId, String format, String pushData) Report batched data (metrics, histograms, spans, etc) to Wavefront servers.

Method Detail

proxyCheckin

@POST
 @Path(value="proxy/checkin")
 @Consumes(value="application/json")
 @Produces(value="application/json")
AgentConfiguration proxyCheckin(@HeaderParam(value="X-WF-PROXY-ID")
                                                                                                                                              UUID proxyId,
                                                                                                                                              @HeaderParam(value="Authorization")
                                                                                                                                              String authorization,
                                                                                                                                              @QueryParam(value="hostname")
                                                                                                                                              String hostname,
                                                                                                                                              @QueryParam(value="version")
                                                                                                                                              String version,
                                                                                                                                              @QueryParam(value="currentMillis")
                                                                                                                                              Long currentMillis,
                                                                                                                                              com.fasterxml.jackson.databind.JsonNode agentMetrics,
                                                                                                                                              @QueryParam(value="ephemeral")
                                                                                                                                              Boolean ephemeral)

Register the proxy and transmit proxy metrics to Wavefront servers.

Parameters:

proxyId - ID of the proxy.

authorization - Authorization token.

hostname - Host name of the proxy.

version - Build version of the proxy.

currentMillis - Current time at the proxy (used to calculate clock drift).

agentMetrics - Proxy metrics.

ephemeral - If true, proxy is removed from the UI after 24 hours of inactivity.

Returns:

Proxy configuration.

proxyReport

@POST
 @Consumes(value="text/plain")
 @Path(value="proxy/report")
javax.ws.rs.core.Response proxyReport(@HeaderParam(value="X-WF-PROXY-ID")
                                                                                                        UUID proxyId,
                                                                                                        @QueryParam(value="format")
                                                                                                        String format,
                                                                                                        String pushData)

Report batched data (metrics, histograms, spans, etc) to Wavefront servers.

Parameters:

proxyId - Proxy Id reporting the result.

format - The format of the data (wavefront, histogram, trace, spanLogs)

pushData - Push data batch (newline-delimited)

proxyConfigProcessed

@POST
 @Path(value="proxy/config/processed")
void proxyConfigProcessed(@HeaderParam(value="X-WF-PROXY-ID")
                                                                       UUID proxyId)

Reports confirmation that the proxy has processed and accepted the configuration sent from the back-end.

Parameters:

proxyId - ID of the proxy.

proxyError

@POST
 @Path(value="proxy/error")
void proxyError(@HeaderParam(value="X-WF-PROXY-ID")
                                                  UUID proxyId,
                                                  @FormParam(value="details")
                                                  String details)

Reports an error that occurred in the proxy.

Parameters:

proxyId - ID of the proxy reporting the error.

details - Details of the error.