Uploaded image for project: 'SAFe Program'
  1. SAFe Program
  2. SP-2505

Taranta has a log viewer

Change Owns to Parent OfsSet start and due date...
    XporterXMLWordPrintable

Details

    • Obs Mgt & Controls
    • Hide
      • The UI user will be able to quickly figure out what happens within a device, provided appropriate logging messages are written by the code controlling the device.
      • The user avoids opening a terminal, typing a command to display the log, and remembering how to do it.
      • The ability to customize the viewer brings flexibility: the user becomes more productive in using the UI and carrying out his/her task.
      Show
      The UI user will be able to quickly figure out what happens within a device, provided appropriate logging messages are written by the code controlling the device. The user avoids opening a terminal, typing a command to display the log, and remembering how to do it. The ability to customize the viewer brings flexibility: the user becomes more productive in using the UI and carrying out his/her task.
    • Hide
      • instances of this widget can be dragged and dropped within the dashboard or within box-containers. They can be sized at will.
      • potentially more than 1 instance of that widget can be used in a dashboard (eg one widget for devices {D1,D2,D3} and one for {D4,D5}.
      • configuration options mentioned in the Description can be chosen.
      • the 3 kibana filters mentioned in the description are available.
      Show
      instances of this widget can be dragged and dropped within the dashboard or within box-containers. They can be sized at will. potentially more than 1 instance of that widget can be used in a dashboard (eg one widget for devices {D1,D2,D3} and one for {D4,D5}. configuration options mentioned in the Description can be chosen. the 3 kibana filters mentioned in the description are available.
    • 3
    • 4.4
    • 40
    • 13.333
    • Team_CREAM
    • Sprint 5
    • Show
      New chart release: https://jira.skatelescope.org/browse/REL-206   https://artefact.skao.int/#browse/browse:helm-internal:ska-tango-taranta%2F1.3.3   Live deployment: https://k8s.stfc.skao.int/taranta-namespace/taranta/devices   Documentation: https://developer.skao.int/projects/ska-tango-taranta-suite/en/latest/elastic_log.html  
    • 15.6
    • Stories Completed, NFRS met, Demonstrated, Satisfies Acceptance Criteria, Accepted by FO
    • PI24 - UNCOVERED

    Description

      What we need

      Taranta has a new widget (Log Viewer) that let's the user of a running dashboard to view, filter, search log messages sent by devices. Filtering can be done for example by log level, by device name. Searching can be done by free text (as a ctrl-F done in a browser - but scoped on log messages only, not the entire dashboard).

      When configuring the widget, the dashboard editor user selects the devices whose logs are to be shown. Ideally the default devices will be all the devices used by the dashboard. Configuration is also related to the refresh rate of the widget, application of available filters (that need to be predefined in Kibana), size of the scollable buffer (eg 2000 lines, even though only 100 are shown, in a scrollable panel). Another configuration option is the format of the line (sequence of log fields to be displayed: eg <timestamp in isoformat, device, level, message>).

      As mentioned above filters can be activated that would allow displaying only lines that have been emitted by given sources, at or above given  log levels, within certain datetime ranges

      Given a certain configuration, when the widget is run it interacts with Kibana and collects relevant info. With the specified refresh rate, the widget updates its space with new lines as they are made available by any of the source devices, possibly by scrolling the text so that the most recent lines are always visible. A scrollbar can be used by the user to view previous messages (up to a maximum size of the log buffer). Text is filtered, processed and formatted based on active filters.

      The widget comes with a predefined set of filters (eg. filter based on log levels, on source devices, on datetime ranges) that can be activated by any user.  

      (This description comes after reading the document that CREAM produced at the end of work for SP-2358, and is based on the analysis of Pro's and Con's that Giorgio did in the attached document).

      Attachments

        Issue Links

          Structure

            Activity

              People

                g.brajnik Brajnik, Giorgio
                g.brajnik Brajnik, Giorgio
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Feature Progress

                  Story Point Burn-up: (100.00%)

                  Feature Estimate: 3.0

                  IssuesStory Points
                  To Do00.0
                  In Progress   00.0
                  Complete1335.0
                  Total1335.0

                  Dates

                    Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel