emqx/apps/emqx_management
Ilya Averyanov f8e6aab86f Merge branch 'release-57' into 0617-release-57-sync
* release-57:
  chore(auth,http): cache REs for parsing URIs
  fix(auth,http): improve URI handling
  chore: revert ULOG/ELOG
  test: generate dispatch.eterm in dashboard test
  docs: refine change log
  feat: make the dashboard restart quicker
  chore: fix typo
  fix(http authz): handle unknown content types in responses
  chore: change types of mysql and mongodb fields to `template()`
  fix(client mgmt api): allow projecting `client_attrs` from client fields
  fix(emqx_rule_funcs): expose regex_extract function to rule engine
2024-06-17 18:53:39 +03:00
..
etc refactor: close managment http 8081 (#5564) 2021-08-27 13:46:39 +08:00
include fix: rework In-flight / Mqueue API 2024-03-20 15:25:33 +02:00
src Merge branch 'release-57' into 0617-release-57-sync 2024-06-17 18:53:39 +03:00
test Merge branch 'release-57' into 0617-release-57-sync 2024-06-17 18:53:39 +03:00
.gitignore chore(emqx_management): move emqx management to apps 2021-03-02 09:35:47 +08:00
README.md style: fix wording 2023-03-31 09:19:48 +02:00
rebar.config refactor: HTTP connector into emqx_bridge_http app 2023-07-12 14:46:43 +02:00

EMQX Management

EMQX Management offers various interfaces for administrators to interact with the system, either by a remote console attached to a running node, a CLI (i.e. ./emqx ctl), or through its rich CRUD-style REST API (mostly used by EMQX' dashboard). The system enables administrators to modify both cluster and individual node configurations, and provides the ability to view and reset different statistics and metrics.

Functionality

Amongst others it allows to manage

  • Alarms
  • API Keys
  • Banned clients, users or hosts
  • Clients (and sessions) including their topic subscriptions
  • Configurations
  • Manage plugins
  • Fixed subscriptions
  • Topics

Moreover it lets you

  • modify hot and non-hot updatable configuration values,
  • publish messages, as well as bulk messages,
  • create trace files,
  • and last but not least monitor system status.

Implementation Notes

API endpoints are implemented using the minirest framework in combination with HOCON schema and OpenAPI 3.0 specifications.

TODO/FIXME

At its current state there are some reverse dependencies from other applications that do calls directly into emqx_mgmt.

Also, and somewhat related, its bpapi proto modules do calls directly into other applications.