com.wavefront.api

Interface AgentAPI

@Path(value="daemon/")
public interface AgentAPI

API for the Agent.

Author:

Clement Pang (clement@wavefront.com)

Method Summary

Modifier and Type	Method and Description
void	agentConfigProcessed(UUID agentId)
void	agentError(UUID agentId, String details) Reports an error that occured in the agent.
AgentConfiguration	checkin(UUID agentId, String hostname, String token, String version, Long currentMillis, Boolean localAgent, com.fasterxml.jackson.databind.JsonNode agentMetrics, Boolean pushAgent)
AgentConfiguration	getConfig(UUID agentId, String hostname, Long currentMillis, Long bytesLeftForbuffer, Long bytesPerMinuteForBuffer, Long currentQueueSize, String token, String version) Polls for the configuration for the agent.
void	hostAuthenticated(UUID agentId, UUID hostId) Reports that an auth handshake to a host has been completed.
void	hostConnectionEstablished(UUID agentId, UUID hostId) Reports that a connection to a host has been established.
void	hostConnectionFailed(UUID agentId, UUID hostId, String details) Reports that a host has failed to connect.
javax.ws.rs.core.Response	postPushData(UUID agentId, UUID workUnitId, Long currentMillis, String format, String pushData) Post batched data from pushed data (graphitehead, statsd) that was proxied through the collector.
javax.ws.rs.core.Response	postWorkUnitResult(UUID agentId, UUID workUnitId, UUID targetId, ShellOutputDTO shellOutputDTO) Post work unit results from an agent executing a particular work unit on a host machine.

Method Detail

getConfig

@GET
 @Path(value="{agentId}/config")
 @Produces(value="application/json")
AgentConfiguration getConfig(@PathParam(value="agentId")
                                                                                                        UUID agentId,
                                                                                                        @QueryParam(value="hostname")
                                                                                                        String hostname,
                                                                                                        @QueryParam(value="currentMillis")
                                                                                                        Long currentMillis,
                                                                                                        @QueryParam(value="bytesLeftForBuffer")
                                                                                                        Long bytesLeftForbuffer,
                                                                                                        @QueryParam(value="bytesPerMinuteForBuffer")
                                                                                                        Long bytesPerMinuteForBuffer,
                                                                                                        @QueryParam(value="currentQueueSize")
                                                                                                        Long currentQueueSize,
                                                                                                        @QueryParam(value="token")
                                                                                                        String token,
                                                                                                        @QueryParam(value="version")
                                                                                                        String version)

Polls for the configuration for the agent.

Parameters:

agentId - Agent id to poll for configuration.

hostname - Hostname of the agent.

currentMillis - Current millis on the agent (to adjust for timing).

token - Token to auto-register the agent.

version - Version of the agent.

Returns:

Configuration for the agent.

checkin

@POST
 @Path(value="{sshDaemonId}/checkin")
 @Consumes(value="application/json")
 @Produces(value="application/json")
AgentConfiguration checkin(@PathParam(value="sshDaemonId")
                                                                                                                                                 UUID agentId,
                                                                                                                                                 @QueryParam(value="hostname")
                                                                                                                                                 String hostname,
                                                                                                                                                 @QueryParam(value="token")
                                                                                                                                                 String token,
                                                                                                                                                 @QueryParam(value="version")
                                                                                                                                                 String version,
                                                                                                                                                 @QueryParam(value="currentMillis")
                                                                                                                                                 Long currentMillis,
                                                                                                                                                 @QueryParam(value="local")
                                                                                                                                                 Boolean localAgent,
                                                                                                                                                 com.fasterxml.jackson.databind.JsonNode agentMetrics,
                                                                                                                                                 @QueryParam(value="push")
                                                                                                                                                 Boolean pushAgent)

postPushData

@POST
 @Consumes(value="text/plain")
 @Path(value="{agentId}/pushdata/{workUnitId}")
javax.ws.rs.core.Response postPushData(@PathParam(value="agentId")
                                                                                                                            UUID agentId,
                                                                                                                            @PathParam(value="workUnitId")
                                                                                                                            UUID workUnitId,
                                                                                                                            @Deprecated @QueryParam(value="currentMillis")
                                                                                                                            Long currentMillis,
                                                                                                                            @QueryParam(value="format")
                                                                                                                            String format,
                                                                                                                            String pushData)

Post batched data from pushed data (graphitehead, statsd) that was proxied through the collector.

Parameters:

agentId - Agent Id of the agent reporting the result.

workUnitId - Work unit that the agent is reporting.

currentMillis - Current millis on the agent (to adjust for timing).

format - The format of the data

pushData - The batched push data

agentError

@POST
 @Path(value="{agentId}/error")
void agentError(@PathParam(value="agentId")
                                                      UUID agentId,
                                                      @FormParam(value="details")
                                                      String details)

Reports an error that occured in the agent.

Parameters:

agentId - Agent reporting the error.

details - Details of the error.

agentConfigProcessed

@POST
 @Path(value="{agentId}/config/processed")
void agentConfigProcessed(@PathParam(value="agentId")
                                                                           UUID agentId)

postWorkUnitResult

@POST
 @Consumes(value="application/json")
 @Path(value="{agentId}/workunit/{workUnitId}/{hostId}")
javax.ws.rs.core.Response postWorkUnitResult(@PathParam(value="agentId")
                                                                                                                                                 UUID agentId,
                                                                                                                                                 @PathParam(value="workUnitId")
                                                                                                                                                 UUID workUnitId,
                                                                                                                                                 @PathParam(value="hostId")
                                                                                                                                                 UUID targetId,
                                                                                                                                                 ShellOutputDTO shellOutputDTO)

Post work unit results from an agent executing a particular work unit on a host machine.

Parameters:

agentId - Agent Id of the agent reporting the result.

workUnitId - Work unit that the agent is reporting.

targetId - The target that's reporting the result.

shellOutputDTO - The output of running the work unit.

hostConnectionFailed

@POST
 @Path(value="{agentId}/host/{hostId}/fail")
void hostConnectionFailed(@PathParam(value="agentId")
                                                                             UUID agentId,
                                                                             @PathParam(value="hostId")
                                                                             UUID hostId,
                                                                             @FormParam(value="details")
                                                                             String details)

Reports that a host has failed to connect.

Parameters:

agentId - Agent reporting the error.

hostId - Host that is experiencing connection issues.

details - Details of the error.

hostConnectionEstablished

@POST
 @Path(value="{agentId}/host/{hostId}/connect")
void hostConnectionEstablished(@PathParam(value="agentId")
                                                                                     UUID agentId,
                                                                                     @PathParam(value="hostId")
                                                                                     UUID hostId)

Reports that a connection to a host has been established.

Parameters:

agentId - Agent reporting the event.

hostId - Host.

hostAuthenticated

@POST
 @Path(value="{agentId}/host/{hostId}/auth")
void hostAuthenticated(@PathParam(value="agentId")
                                                                          UUID agentId,
                                                                          @PathParam(value="hostId")
                                                                          UUID hostId)

Reports that an auth handshake to a host has been completed.

Parameters:

agentId - Agent reporting the event.

hostId - Host.