emqx_bridge_schema.hocon 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. emqx_bridge_schema {
  2. bridges_mqtt.desc:
  3. """MQTT bridges to/from another MQTT broker"""
  4. bridges_mqtt.label:
  5. """MQTT Bridge"""
  6. bridges_webhook.desc:
  7. """WebHook to an HTTP server."""
  8. bridges_webhook.label:
  9. """WebHook"""
  10. desc_bridges.desc:
  11. """Configuration for MQTT bridges."""
  12. desc_bridges.label:
  13. """MQTT Bridge Configuration"""
  14. desc_enable.desc:
  15. """Enable or disable this bridge"""
  16. desc_enable.label:
  17. """Enable Or Disable Bridge"""
  18. desc_metrics.desc:
  19. """Bridge metrics."""
  20. desc_metrics.label:
  21. """Bridge Metrics"""
  22. desc_node_metrics.desc:
  23. """Node metrics."""
  24. desc_node_metrics.label:
  25. """Node Metrics"""
  26. desc_node_name.desc:
  27. """The node name."""
  28. desc_node_name.label:
  29. """Node Name"""
  30. desc_node_status.desc:
  31. """Node status."""
  32. desc_node_status.label:
  33. """Node Status"""
  34. desc_status.desc:
  35. """The status of the bridge<br/>
  36. - <code>connecting</code>: the initial state before any health probes were made.<br/>
  37. - <code>connected</code>: when the bridge passes the health probes.<br/>
  38. - <code>disconnected</code>: when the bridge can not pass health probes.<br/>
  39. - <code>stopped</code>: when the bridge resource is requested to be stopped.<br/>
  40. - <code>inconsistent</code>: When not all the nodes are at the same status."""
  41. desc_status.label:
  42. """Bridge Status"""
  43. desc_status_reason.desc:
  44. """This is the reason given in case a bridge is failing to connect."""
  45. desc_status_reason.label:
  46. """Failure reason"""
  47. metric_dropped.desc:
  48. """Count of messages dropped."""
  49. metric_dropped.label:
  50. """Dropped"""
  51. metric_dropped_other.desc:
  52. """Count of messages dropped due to other reasons."""
  53. metric_dropped_other.label:
  54. """Dropped Other"""
  55. metric_dropped_queue_full.desc:
  56. """Count of messages dropped due to the queue is full."""
  57. metric_dropped_queue_full.label:
  58. """Dropped Queue Full"""
  59. metric_dropped_resource_not_found.desc:
  60. """Count of messages dropped due to the resource is not found."""
  61. metric_dropped_resource_not_found.label:
  62. """Dropped Resource NotFound"""
  63. metric_dropped_resource_stopped.desc:
  64. """Count of messages dropped due to the resource is stopped."""
  65. metric_dropped_resource_stopped.label:
  66. """Dropped Resource Stopped"""
  67. metric_inflight.desc:
  68. """Count of messages that were sent asynchronously but ACKs are not yet received."""
  69. metric_inflight.label:
  70. """Sent Inflight"""
  71. metric_matched.desc:
  72. """Count of this bridge is matched and queried."""
  73. metric_matched.label:
  74. """Matched"""
  75. metric_queuing.desc:
  76. """Count of messages that are currently queuing."""
  77. metric_queuing.label:
  78. """Queued"""
  79. metric_rate.desc:
  80. """The rate of matched, times/second"""
  81. metric_rate.label:
  82. """Rate"""
  83. metric_rate_last5m.desc:
  84. """The average rate of matched in the last 5 minutes, times/second"""
  85. metric_rate_last5m.label:
  86. """Last 5 Minutes Rate"""
  87. metric_rate_max.desc:
  88. """The max rate of matched, times/second"""
  89. metric_rate_max.label:
  90. """Max Rate Of Matched"""
  91. metric_received.desc:
  92. """Count of messages that is received from the remote system."""
  93. metric_received.label:
  94. """Received"""
  95. metric_retried.desc:
  96. """Times of retried."""
  97. metric_retried.label:
  98. """Retried"""
  99. metric_sent_failed.desc:
  100. """Count of messages that sent failed."""
  101. metric_sent_failed.label:
  102. """Sent Failed"""
  103. metric_sent_success.desc:
  104. """Count of messages that sent successfully."""
  105. metric_sent_success.label:
  106. """Sent Success"""
  107. }