Monitor

Update the configuration of StatsD metrics collection and push service.

put/statsd

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/statsd
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Request body

enableboolean

Enable or disable StatsD metrics collection and push service.

serverstring

StatsD server address.

sample_time_intervalstring

The sampling interval for metrics.

flush_time_intervalstring

The push interval for metrics.

tagsobject

The tags for metrics.

Example request

{
  "sample_time_interval": "32s",
  "flush_time_interval": "32s",
  "tags": {}
}

Response

enableboolean

Enable or disable StatsD metrics collection and push service.

serverstring

StatsD server address.

sample_time_intervalstring

The sampling interval for metrics.

flush_time_intervalstring

The push interval for metrics.

tagsobject

The tags for metrics.

Example response

{
  "sample_time_interval": "32s",
  "flush_time_interval": "32s",
  "tags": {}
}

Changes

No recorded changes to this operation across all 1 revision of this API.