emqx_mgmt_api_trace.hocon 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. emqx_mgmt_api_trace {
  2. list_all.desc:
  3. """List all trace"""
  4. list_all.label:
  5. """List all trace"""
  6. create_new.desc:
  7. """Create new trace"""
  8. create_new.label:
  9. """Create new trace"""
  10. clear_all.desc:
  11. """Clear all traces"""
  12. clear_all.label:
  13. """Clear all traces"""
  14. delete_trace.desc:
  15. """Delete specified trace"""
  16. delete_trace.label:
  17. """Delete specified trace"""
  18. stop_trace.desc:
  19. """Stop trace by name"""
  20. stop_trace.label:
  21. """Stop trace by name"""
  22. download_log_by_name.desc:
  23. """Download trace log by name"""
  24. download_log_by_name.label:
  25. """Download trace log by name"""
  26. trace_zip_file.desc:
  27. """A trace zip file"""
  28. trace_zip_file.label:
  29. """A trace zip file"""
  30. get_trace_file_metadata.desc:
  31. """get trace log file's metadata, such as size, last update time"""
  32. get_trace_file_metadata.label:
  33. """get trace log file's metadata"""
  34. view_trace_log.desc:
  35. """view trace log"""
  36. view_trace_log.label:
  37. """view trace log"""
  38. file_size.desc:
  39. """file size"""
  40. file_size.label:
  41. """file size"""
  42. file_mtime.desc:
  43. """The last time this file is modified."""
  44. file_mtime.label:
  45. """file mtime"""
  46. trace_name.desc:
  47. """Unique name of the trace. Only ascii letters in a-z, A-Z, 0-9 and underscore '_' are allowed."""
  48. trace_name.label:
  49. """Unique name of the trace"""
  50. filter_type.desc:
  51. """Filter type"""
  52. filter_type.label:
  53. """Filter type"""
  54. support_wildcard.desc:
  55. """Specify the topic or topic filter if the trace 'type' is 'topic'."""
  56. support_wildcard.label:
  57. """MQTT Topic"""
  58. mqtt_clientid.desc:
  59. """Specify the MQTT clientid if the trace 'type' is 'clientid'."""
  60. mqtt_clientid.label:
  61. """MQTT clientid"""
  62. client_ip_addess.desc:
  63. """Specify the client's IP address if the trace type is 'ip_address'."""
  64. client_ip_addess.label:
  65. """Client IP Address"""
  66. trace_status.desc:
  67. """trace status"""
  68. trace_status.label:
  69. """trace status"""
  70. time_format.desc:
  71. """rfc3339 timestamp or epoch second"""
  72. time_format.label:
  73. """rfc3339 timestamp or epoch second"""
  74. trace_log_size.desc:
  75. """trace log size"""
  76. trace_log_size.label:
  77. """trace log size"""
  78. node_name.desc:
  79. """Node name"""
  80. node_name.label:
  81. """Node name"""
  82. max_response_bytes.desc:
  83. """Maximum number of bytes to send in response"""
  84. max_response_bytes.label:
  85. """Maximum response bytes"""
  86. current_trace_offset.desc:
  87. """Offset from the current trace position."""
  88. current_trace_offset.label:
  89. """Offset from the current trace position."""
  90. }