Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display Alerts: design an API and reporting for a display to report interesting events/alerts #3364

Closed
dasgarner opened this issue Mar 7, 2024 · 2 comments
Assignees
Labels
feature A new feature
Milestone

Comments

@dasgarner
Copy link
Member

dasgarner commented Mar 7, 2024

Surface alerts through the CMS when interesting events happen on the display, e.g.

  • App start
  • Power cycle
  • Network disconnect/connect
  • TV monitoring (power state and input source)

Each player app would be responsible for sending the things it can from a list of options.

This data should be recorded as a display event, meaning the following changes will need to be made to the data model:

  • start columns should be nullable
  • new columns for:
    • eventTypeId
    • refId
    • detail

Basic reporting should be made available to show these events (to be extended in future with more advanced reporting).

XMDS submitLog should be modified to process a log node with category=event and expect the additional fields when processing that record. The detail column would be the text content of the node. The XML structure should be documented and communicated to the player development teams and in the development docs.

There are notable transactions for which the CMS should also record events:

  • A new fault added to the fault list, and then being cleared (via the refId)
  • All faults cleared

Finally we should have the option of storing display events in MongoDB as well as MySQL, including migrating old data and adapting existing reporting.

@dasgarner dasgarner added the feature A new feature label Mar 7, 2024
@dasgarner dasgarner added this to the 4.1.0-alpha milestone Mar 7, 2024
@dasgarner
Copy link
Member Author

dasgarner commented Mar 14, 2024

We should also have the option of creating an alert from the output of a stored command, where the alert is created based on if the command was successful, failed or always. A "never" option (default) should also be provided.

@dasgarner
Copy link
Member Author

Finally we should have the option of storing display events in MongoDB as well as MySQL, including migrating old data and adapting existing reporting.

This will be handled in alpha2

PeterMis added a commit to xibosignage/xibo-cms that referenced this issue Apr 11, 2024
PeterMis added a commit to xibosignage/xibo-cms that referenced this issue Apr 11, 2024
PeterMis added a commit to xibosignage/xibo-cms that referenced this issue Apr 11, 2024
PeterMis added a commit to xibosignage/xibo-cms that referenced this issue Apr 18, 2024
* Display Alerts : Recording new display events and Reporting.
Fixes xibosignage/xibo#3364
* Display Alerts : Command input
Fixes xibosignage/xibo#3399
* XMDS tests : add test to register a completely new Display.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature
Projects
None yet
Development

No branches or pull requests

2 participants