Add event categories #297
Add event categories #297
Conversation
|
I believe it would be good to give each of these categories a dedicated color as well, to be used in our event graphs all over the protocol repo. For example here: https://github.com/eiffel-community/eiffel/blob/master/usage-examples/pipeline-monitoring.md#event-graph |
m-linner-ericsson
force-pushed
the
add_event_categories
branch
from
da1a13e
to
e3a8a36
Compare
|
@e-backmark-ericsson Any opinions on the colors suggested? |
|
Do we think that we should recommend/propose these categories to be used as the event "family" in the routing key syntax described here: https://eiffel-community.github.io/eiffel-sepia/rabbitmq-message-broker.html ? If so, I believe we should make sure this categorization is as stable as possible over time and thereby spend some conscious thoughts on this PR before accepting it, as some routing/federation implementations might depend on those families. If not, it could be ok to let this PR through without too deep discussions. |
tox.ini
Outdated
| @@ -28,7 +28,7 @@ basepython = python3 | |||
|
|
|||
| [testenv:black] | |||
| deps = | |||
| black==21.12b0 | |||
| black==22.3.0 | |||
Agree with you both @e-backmark-ericsson and @magnusbaeck but do you have any opinions on which path to take? Is there any value of not using it for the routing key? |
|
If we have a well-defined categorization I think it would be strange to not use it in the routing key now that we have a family field there. I'm not a fan of that field, but since it's there we might as well make the best of it. Maybe the proposed categorization is as good as it's going to get? |
tox.ini
Outdated
| @@ -28,7 +28,8 @@ basepython = python3 | |||
|
|
|||
| [testenv:black] | |||
| deps = | |||
| black==22.6.0 | |||
| black==22.6.0 | |||
|
|
|||
There was a problem hiding this comment.
No big deal, but you're adding a blank line and changing the indentation of line 31.
There was a problem hiding this comment.
I'm ok with approving this as is now, with the addition that it should be brought up on the Eiffel Summit in a couple of weeks. There we should collect any thoughts from that audience on if further adjustments need to be done to it before recommending it to be used as the family field in the routing key through the Sepia architecture docs.
|
Let's merge this, but please note that there's a conflict to resolve first. Also, perhaps align the tox.ini to what's currently on master while you're at it? |
m-linner-ericsson
dismissed stale reviews from e-backmark-ericsson and t-persson
via
ac29d08
|
@e-backmark-ericsson @t-persson @magnusbaeck need your approvals again due to the updates I made |
Applicable Issues
Solves AP from TC see action list from 10 of March
Description of the Change
Groups events into categories that can be used reasoning about them or to color them when drawing them in our examples
Alternate Designs
Selection of colors and groups should be discussed in this PR
Benefits
We have defined colors for our examples and it makes it easier for people reasoning about them.
Possible Drawbacks
None that I can think of
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: Mattias Linnér mattias.linner@ericsson.com