Package com.wavefront.api
Interface ProxyV2API
-
@Path("/") public interface ProxyV2APIv2 API for the proxy.- Author:
- vasily@wavefront.com
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AgentConfigurationproxyCheckin(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.voidproxyConfigProcessed(UUID proxyId)Reports confirmation that the proxy has processed and accepted the configuration sent from the back-end.voidproxyError(UUID proxyId, String details)Reports an error that occurred in the proxy.javax.ws.rs.core.ResponseproxyReport(UUID proxyId, String format, String pushData)Report batched data (metrics, histograms, spans, etc) to Wavefront servers.
-
-
-
Method Detail
-
proxyCheckin
@POST @Path("v2/wfproxy/checkin") @Consumes("application/json") @Produces("application/json") AgentConfiguration proxyCheckin(@HeaderParam("X-WF-PROXY-ID") UUID proxyId, @HeaderParam("Authorization") String authorization, @QueryParam("hostname") String hostname, @QueryParam("version") String version, @QueryParam("currentMillis") Long currentMillis, com.fasterxml.jackson.databind.JsonNode agentMetrics, @QueryParam("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("text/plain") @Path("v2/wfproxy/report") javax.ws.rs.core.Response proxyReport(@HeaderParam("X-WF-PROXY-ID") UUID proxyId, @QueryParam("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("v2/wfproxy/config/processed") void proxyConfigProcessed(@HeaderParam("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.
-
-