Notification plugin interface and models #31
Merged
Conversation
This file contains 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
akbhatta
requested review from
lezzago,
nisheedh,
praveensameneni,
saratvemulapalli and
skkosuri-amzn
akbhatta
force-pushed
the
notification_plugin_interface
branch
from
c3befaf to
dfcac8f
Compare
akbhatta
force-pushed
the
notification_plugin_interface
branch
from
dfcac8f to
92b9f68
Compare
akbhatta
requested review from
anirudha,
dbbaughe,
kaituo,
joshuali925 and
zhongnansu
akbhatta
force-pushed
the
notification_plugin_interface
branch
from
92b9f68 to
7e85164
Compare
lezzago
reviewed
Jun 5, 2021
src/main/kotlin/org/opensearch/commons/notifications/model/ChannelMessage.kt
Outdated
Show resolved
Hide resolved
lezzago
approved these changes
Jun 5, 2021
Currently Alerting, ISM and Reporting plugins are expected to make call to Notification plugin to send notification. The plugins can communicate using REST or Transport layer. Transport layer makes call to same node and hence avoids network hop so transport layer communication is preferred. common-utils contains the model (with marshaling/unmarshaling code) for the communication. above mentioned plugins consumes common-utils and uses these models for communication. Note: Plugins runs on different JVM and hence the notification plugins needs to check if the class is same before accessing the values. transport marshaling/unmarshaling ( writeTo(output: StreamOutput) and constructor(input: StreamInput) of models) are used for this purpose. REST APIs in notification plugin uses toXContent and parse marshaling/unmarshaling [Tests] Contains unit test for all model classes Signed-off-by: @akbhatta
akbhatta
force-pushed
the
notification_plugin_interface
branch
from
7e85164 to
4d8fb67
Compare
wuychn
pushed a commit
to ochprince/common-utils
that referenced
this pull request
Mar 16, 2023
Currently Alerting, ISM and Reporting plugins are expected to make call to Notification plugin to send notification. The plugins can communicate using REST or Transport layer. Transport layer makes call to same node and hence avoids network hop so transport layer communication is preferred. common-utils contains the model (with marshaling/unmarshaling code) for the communication. above mentioned plugins consumes common-utils and uses these models for communication. Note: Plugins runs on different JVM and hence the notification plugins needs to check if the class is same before accessing the values. transport marshaling/unmarshaling ( writeTo(output: StreamOutput) and constructor(input: StreamInput) of models) are used for this purpose. REST APIs in notification plugin uses toXContent and parse marshaling/unmarshaling [Tests] Contains unit test for all model classes Signed-off-by: @akbhatta
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.
Description
Notification plugin interface and models
Currently Alerting, ISM and Reporting plugins are expected to make call to Notification plugin to send notification.
The plugins can communicate using REST or Transport layer. Transport layer makes call to same node and hence avoids network hop so transport layer communication is preferred. common-utils contains the model (with marshaling/unmarshaling code) for the communication. above mentioned plugins consumes common-utils and uses these models for communication.
Note: Plugins runs on different JVM and hence the notification plugins needs to check if the class is same before accessing the values. transport marshaling/unmarshaling (
writeTo(output: StreamOutput)andconstructor(input: StreamInput)of models) are used for this purpose. REST APIs in notification plugin usestoXContentandparsemarshaling/unmarshaling[Tests]
Contains unit test for all model classes
Signed-off-by: @akbhatta
Issues Resolved
NA
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.