Skip to content

Version 2.5.0.0 Release Candidate 2

Pre-release
Pre-release
Compare
Choose a tag to compare
@wsobel wsobel released this 03 May 17:31
· 105 commits to main since this release
eb94b8f
  • Added websockets interface
  • Removed legacy mqtt sink

For websockets you need to connect to the server and then send requests:

{
  "id": "ABC",
  "request": "probe"
}

The id and request are required.

I have added a few other properties to support the response document,format and pretty. format can have a value of xml or json. The default format is xml.

{
  "id": "ABC",
  "request": "probe",
  "format": "json"
}

All the properties except request and id are the same as the properties you get from the swagger interface. Make a request to /swagger from the agent to find all the possible properties.

   http://localhost:5000/swagger

When an interval is given for sample or current, they will publish. A request of cancel will stop a request.

Some examples:

{"id": 1,"request": "probe", "format": "json"}
{"id": 2,"request": "current"}
{"id": 3, "request": "sample", "interval": 1000, "format": "json"}
{"id": 4, "request": "current", "interval": 5000 }
{"id": 3, "request": "cancel"}

There is no additional protocol level header. The results are chunked per the websockets spec as individual messages.