tarantool / tarantool / 12077912174

87%

push

github

config: add alerts namespaces

This patch adds public API to raise alerts.

Closes #10873
Closes TNTP-226

@TarantoolBot document
Title: Public alerts API

Users can now raise their own alerts (similar to the alerts raised by
the `config` module).

New available methods:
- `config:new_alerts_namespace(alerts_namespace_name)` - creates a new
  alerts namespaces and returns it. `alerts_namespace_name` must be a
  string and can not contain a colon (":").
- `alerts_namespace:add(alert)` - raises new alert of type warning.
  `alert` must be a table. `alert.message` is logged and the alert will
  be shown in `box.info.config.alerts`.
- `alerts_namespace:set(key, alert)` - raises new alert of type warning,
  or replaces an existing, raised with the same 'key' in the namespace.
  `alert` must be a table. `alert.message` is logged and the alert will
  be shown in `box.info.config.alerts`. `key` must be a string and can
  not contain a colon (":").
- `alerts_namespace:unset(key)` - discards the alert with the
  corresponding 'key' in the namespace. `key` must be a
  string and can not contain a colon (":"). If an alert with the
  corresponding key does not exist in the namespace, does nothing.
- `alerts_namespace:clear()` - discards all alerts from the namespace,
  removing them from `box.info.config.alerts`.

Alerts namespaces with the same name will point to the same alerts
namespace. During configuration update all alerts from namespaces are
removed from `box.info.config.alerts`.

The `alert.type` is forced to be `"warn"`, anything except `"warn"` or
`nil` is considered an error.

Any keys in `alert` which start with an underscore will be ignored.

Example usage:

```lua
local config = require('config')

-- Create a new alerts namespace 'my_alerts'.
local alerts = config:new_alerts_namespace('my_alerts')

-- Raise a new alert.
alerts:add({
    message = 'Test alert',
    my_field = 'my_value',
})

-- Raise a new alert with a key.
alerts:set("my_alert", {
  ... (continued)

69506 of 123342 branches covered (56.35%)

102432 of 117291 relevant lines covered (87.33%)

2868578.39 hits per line