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

Enable use of transaction IDs to aid in tracing of commands through the system

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

Details

    • Obs Mgt & Controls
    • Hide

      In the SKA distributed services/devices architecture, tracing will enable the monitoring of system wide performance and aid in identifying/debugging any performance bottlenecks. Logs, metrics, and traces are three important enablers of the observability quality attribute of a distributed system. While metrics and traces are abstractions of logs, traces are used in diagnosis/debugging with a request-centric approach, and metrics are used in the system-centric approach - see https://www.oreilly.com/library/view/distributed-systems-observability/9781492033431/ch04.html

      (Courtesy of Paul Swart)
       

      Show
      In the SKA distributed services/devices architecture, tracing will enable the monitoring of system wide performance and aid in identifying/debugging any performance bottlenecks. Logs, metrics, and traces are three important enablers of the observability quality attribute of a distributed system. While metrics and traces are abstractions of logs, traces are used in diagnosis/debugging with a request-centric approach, and metrics are used in the system-centric approach - see  https://www.oreilly.com/library/view/distributed-systems-observability/9781492033431/ch04.html (Courtesy of Paul Swart)  
    • Hide
      • Python library that provides "transaction" blocks, generating a transaction ID if not provided.
      • A start and end log message including the transaction ID tag should be generated on entering / exiting the block, ideally including call details (function, parameters, raised exception...)
      • This feature will be used for piloting the new Cross Team review so teams should plan adequate time for these reviews
      • Stretch: Ideally log messages within (or called from) the transaction block should be tagged with the transaction ID as well (thread-local variable?)
      Show
      Python library that provides "transaction" blocks, generating a transaction ID if not provided. A start and end log message including the transaction ID tag should be generated on entering / exiting the block, ideally including call details (function, parameters, raised exception...) This feature will be used for piloting the new Cross Team review so teams should plan adequate time for these reviews Stretch: Ideally log messages within (or called from) the transaction block should be tagged with the transaction ID as well (thread-local variable?)
    • 3
    • 3
    • 9.333
    • Team_KAROO
    • Sprint 3
    • Hide

      Given the benefits (tracing will enable the monitoring of system wide performance and aid in identifying/debugging any performance bottlenecks), outcomes are: a) productivity in development enabled by increased observability and b) performance. This is envisaged for both OMC and DP trains.

      Show
      Given the benefits (tracing will enable the monitoring of system wide performance and aid in identifying/debugging any performance bottlenecks), outcomes are: a) productivity in development enabled by increased observability and b) performance. This is envisaged for both OMC and DP trains.
    • 8.4
    • Stories Completed, Integrated, Solution Intent Updated, BDD Testing Passes (no errors), Outcomes Reviewed, Demonstrated, Satisfies Acceptance Criteria, Accepted by FO

    Description

      ADR-7 considers the addition of a transaction ID to commands so that they can be traced through the system. In that it was decided to:

      • Extend the SKA Unique Identifiers by the addition of a new type ("transaction" = "tr")
      • Ensure that logs using the transaction ID are generated by the provision of a utility as part of the logging library.

      Attachments

        Issue Links

          Child Of

          Capability - SAFe program capability SS-46 End-to-end tracing of observations and failures

          • Should have - Items labelled as "Should have" are important but not necessary for delivery in the current delivery timebox. While "Should have" items can be as important as "Must have", they are often not as time-critical or there may be another way to satisfy the requirement so that it can be held back until a future delivery timebox.
          • Discarded
          is required by

          Enabler - An Enabler supports the activities needed to extend the Architectural Runway to provide future business functionality. These include exploration, architecture, infrastructure, and compliance. SP-1162 Workflow library prototype (implementation and examples)

          • Not Assigned - Priority is not assigned yet.
          • Done

          Feature - A Feature is a service that fulfills a stakeholder need. Each feature includes a benefit hypothesis and acceptance criteria, and is sized or split as necessary to be delivered by a single Agile Release Train (ART) in a Program Increment (PI). SP-1180 Implement transaction IDs in the SDP prototype

          • Not Assigned - Priority is not assigned yet.
          • Done

          Feature - A Feature is a service that fulfills a stakeholder need. Each feature includes a benefit hypothesis and acceptance criteria, and is sized or split as necessary to be delivered by a single Agile Release Train (ART) in a Program Increment (PI). SP-1294 Implement transaction IDs in TMC prototype

          • Not Assigned - Priority is not assigned yet.
          • Done

          Feature - A Feature is a service that fulfills a stakeholder need. Each feature includes a benefit hypothesis and acceptance criteria, and is sized or split as necessary to be delivered by a single Agile Release Train (ART) in a Program Increment (PI). SP-1295 Implement transaction IDs in CSP prototype

          • Not Assigned - Priority is not assigned yet.
          • Done

          Feature - A Feature is a service that fulfills a stakeholder need. Each feature includes a benefit hypothesis and acceptance criteria, and is sized or split as necessary to be delivered by a single Agile Release Train (ART) in a Program Increment (PI). SP-1293 Implement transaction IDs in OET prototype

          • Not Assigned - Priority is not assigned yet.
          • Discarded
          relates to

          Spike - A time limited investigation to get some knowledge SP-426 Example of tracing TANGO command events throughout the system

          • Not Assigned - Priority is not assigned yet.
          • Done

          Enabler - An Enabler supports the activities needed to extend the Architectural Runway to provide future business functionality. These include exploration, architecture, infrastructure, and compliance. SP-1346 Technical Debt: Improve skuid Python package for clients

          • Not Assigned - Priority is not assigned yet.
          • Done
          supporting

          Architectural Decision - Software Architectural Decision ADR-7 Add transaction/coordination ID to configure requests and logs

          • decided
          triggers

          Enabler - An Enabler supports the activities needed to extend the Architectural Runway to provide future business functionality. These include exploration, architecture, infrastructure, and compliance. SP-1347 Transaction ID tags to logs within transaction blocks

          • Could have - Items labelled as "Could have" are desirable but not necessary and could improve the user experience or customer satisfaction for a little development cost. These will typically be included if time and resources permit.
          • Discarded
          mentioned in

          Page Loading...

          Page Loading...

          Page Loading...

          Page Loading...

          Page Loading...

          Page Loading...

          Page Loading...

          Page Loading...

          Page Loading...

          Page Loading...

          mentioned on

          GitLab Commit - Merge branch 'SAR-146-add-a-test-for-transaction-id' into 'master'

          GitLab Merge request - SAR-147 Add transaction ID endpoint

          GitLab Merge request - SAR-149 Update library to log transactions

          Structure

            Activity

              People

                a.bridger Bridger, Alan
                a.bridger Bridger, Alan
                Votes:
                0 Vote for this issue
                Watchers:
                7 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
                  Complete713.0
                  Total713.0

                  Dates

                    Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel