Package com.wavefront.agent.api
Interface ForceQueueEnabledProxyAPI
-
- All Superinterfaces:
com.wavefront.api.ProxyV2API,com.wavefront.api.SourceTagAPI,WavefrontV2API
- All Known Implementing Classes:
QueuedAgentService
public interface ForceQueueEnabledProxyAPI extends WavefrontV2API
Wrapper around WavefrontV2API that supports forced writing of tasks to the backing queue.- Author:
- Andrew Kao ([email protected]), [email protected]
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javax.ws.rs.core.ResponseappendTag(String id, String tagValue, boolean forceToQueue)Add a single tag to a source.javax.ws.rs.core.ResponseproxyReport(UUID proxyId, String format, String pushData, boolean forceToQueue)Report batched data (metrics, histograms, spans, etc) to Wavefront servers.javax.ws.rs.core.ResponseremoveDescription(String id, boolean forceToQueue)Remove description from a source.javax.ws.rs.core.ResponseremoveTag(String id, String tagValue, boolean forceToQueue)Remove a single tag from a source.javax.ws.rs.core.ResponsesetDescription(String id, String desc, boolean forceToQueue)Set description for a source.javax.ws.rs.core.ResponsesetTags(String id, List<String> tagsValuesToSet, boolean forceToQueue)Sets tags for a host, overriding existing tags.
-
-
-
Method Detail
-
proxyReport
javax.ws.rs.core.Response proxyReport(@HeaderParam("X-WF-PROXY-ID") UUID proxyId, @QueryParam("format") String format, String pushData, boolean forceToQueue)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)forceToQueue- Whether to bypass posting data to the API and write to queue instead.
-
appendTag
javax.ws.rs.core.Response appendTag(String id, String tagValue, boolean forceToQueue)
Add a single tag to a source.- Parameters:
id- source ID.tagValue- tag value to add.forceToQueue- Whether to bypass posting data to the API and write to queue instead.
-
removeTag
javax.ws.rs.core.Response removeTag(String id, String tagValue, boolean forceToQueue)
Remove a single tag from a source.- Parameters:
id- source ID.tagValue- tag to remove.forceToQueue- Whether to bypass posting data to the API and write to queue instead.
-
setTags
javax.ws.rs.core.Response setTags(String id, List<String> tagsValuesToSet, boolean forceToQueue)
Sets tags for a host, overriding existing tags.- Parameters:
id- source ID.tagsValuesToSet- tags to set.forceToQueue- Whether to bypass posting data to the API and write to queue instead.
-
setDescription
javax.ws.rs.core.Response setDescription(String id, String desc, boolean forceToQueue)
Set description for a source.- Parameters:
id- source ID.desc- description.forceToQueue- Whether to bypass posting data to the API and write to queue instead.
-
removeDescription
javax.ws.rs.core.Response removeDescription(String id, boolean forceToQueue)
Remove description from a source.- Parameters:
id- source ID.forceToQueue- Whether to bypass posting data to the API and write to queue instead.
-
-