watcher-stats.asciidoc 962 B

1234567891011121314151617181920212223242526272829303132
  1. --
  2. :api: watcher-stats
  3. :request: WatcherStatsRequest
  4. :response: WatcherStatsResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Watcher Stats API
  8. [id="{upid}-{api}-request"]
  9. ==== Execution
  10. {ref}/watcher-api-stats.html[Watcher Stats] returns the current {watcher} metrics.
  11. Submit the following request to get the stats:
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. [id="{upid}-{api}-response"]
  17. ==== Response
  18. The returned `AcknowledgeResponse` contains a value on whether or not the request
  19. was received:
  20. ["source","java",subs="attributes,callouts,macros"]
  21. --------------------------------------------------
  22. include-tagged::{doc-tests-file}[{api}-response]
  23. --------------------------------------------------
  24. <1> A boolean value of `true` if successfully received, `false` otherwise.
  25. include::../execution.asciidoc[]