emqx_exhook_api.hocon 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. emqx_exhook_api {
  2. add_server.desc:
  3. """Add a server"""
  4. add_server.label:
  5. """Add a server"""
  6. delete_server.desc:
  7. """Delete the server"""
  8. delete_server.label:
  9. """Delete the server"""
  10. get_detail.desc:
  11. """Get the detail information of Exhook server"""
  12. get_detail.label:
  13. """Get server details"""
  14. get_hooks.desc:
  15. """Get the hooks information of server"""
  16. get_hooks.label:
  17. """Get server hooks information"""
  18. hook_metrics.desc:
  19. """Metrics information of this hook in the current node"""
  20. hook_metrics.label:
  21. """Hook metrics"""
  22. hook_name.desc:
  23. """The hook's name"""
  24. hook_name.label:
  25. """Hook name"""
  26. hook_params.desc:
  27. """The parameters used when the hook is registered"""
  28. hook_params.label:
  29. """Hook parameters"""
  30. list_all_servers.desc:
  31. """List all servers"""
  32. list_all_servers.label:
  33. """List servers"""
  34. metric_failed.desc:
  35. """The number of times the hook execution failed"""
  36. metric_failed.label:
  37. """Failed executions count"""
  38. metric_max_rate.desc:
  39. """Maximum call rate of hooks"""
  40. metric_max_rate.label:
  41. """Max hook call rate"""
  42. metric_rate.desc:
  43. """The call rate of hooks"""
  44. metric_rate.label:
  45. """Hook call rate"""
  46. metric_succeed.desc:
  47. """The number of times the hooks execution successful"""
  48. metric_succeed.label:
  49. """Successful executions count"""
  50. metrics.desc:
  51. """Metrics information"""
  52. metrics.label:
  53. """Metrics information"""
  54. move_api.desc:
  55. """Move the server.
  56. NOTE: The position should be "front | rear | before:{name} | after:{name}"""
  57. move_api.label:
  58. """Change order of execution for registered Exhook server"""
  59. move_position.desc:
  60. """The target position to be moved"""
  61. move_position.label:
  62. """Target position"""
  63. node.desc:
  64. """Node name"""
  65. node.label:
  66. """Node name"""
  67. node_hook_metrics.desc:
  68. """Metrics information of this hook in all nodes"""
  69. node_hook_metrics.label:
  70. """Node-wise hook metrics"""
  71. node_metrics.desc:
  72. """Metrics information of this server in all nodes"""
  73. node_metrics.label:
  74. """Node-wise server metrics"""
  75. node_status.desc:
  76. """status of this server in all nodes"""
  77. node_status.label:
  78. """Node-wise server status"""
  79. server_metrics.desc:
  80. """Metrics information of this server in the current node"""
  81. server_metrics.label:
  82. """Server metrics"""
  83. server_name.desc:
  84. """The Exhook server name"""
  85. server_name.label:
  86. """Server name"""
  87. status.desc:
  88. """The status of Exhook server.<br/>
  89. connected: connection succeeded<br/>
  90. connecting: connection failed, reconnecting<br/>
  91. disconnected: failed to connect and didn't reconnect<br/>
  92. disabled: this server is disabled<br/>
  93. error: failed to view the status of this server"""
  94. status.label:
  95. """Server status"""
  96. update_server.desc:
  97. """Update the server"""
  98. update_server.label:
  99. """Update the server"""
  100. }