Adds description of the on_event callback to custom application roles #5232
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
grafin
reviewed
Jul 8, 2025
| @@ -81,6 +110,13 @@ As a result, a role module should return an object that has corresponding functi | |||
| apply = function() -- ... -- end, | |||
| stop = function() -- ... -- end, | |||
| dependencies = { -- ... -- }, | |||
| on_event = function(config, key, value) | |||
There was a problem hiding this comment.
Better to indent the function contents:
on_event = function(config, key, value)
local log = require('log')
log.info('roles_cfg.my_role.foo: ' .. config.foo)
log.info('on_event is triggered by ' .. key)
log.info('is_ro: ' .. value.is_ro)
end,
grafin
reviewed
Jul 8, 2025
doc/platform/app/app_roles.rst
Outdated
| For example, a logging role can be created to add logging functionality on top of the built-in one. | ||
|
|
||
| Since version :doc:`3.4.0 </release/3.4.0>`, you can define an ``on_event`` callback for custom roles. The ``on_event`` callback is called | ||
| every time a ``box.status`` system event is broadcasted, or after the ``apply`` action of the configuration update is finished. |
There was a problem hiding this comment.
IMO "the apply action of " this is not needed here. apply step is a part of the current inner implementation, and should not be important for the users.
grafin
approved these changes
Jul 8, 2025
xuniq
reviewed
Jul 8, 2025
xuniq
approved these changes
Jul 9, 2025
Added general info about custom roles as an intro to the section' Fixes #4666
AArdeev
force-pushed
the
AArdeev/gh-4666-on-event-callback-for-roles
branch
from
d4cba2f to
ad4dcfa
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
on_eventcallback for roles #4666Deployment: https://docs.d.tarantool.io/ru/doc/gh-4666-on-event-callback-for-roles/platform/app/app_roles/#creating-a-custom-role