Uploaded image for project: 'Automation for Cloud'
  1. Automation for Cloud
  2. AUTO-194

Improve Automation audit log - add more details to the error notifications

XMLWordPrintable

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Notify users when rule is failing

      We could add more detail in these areas:

      • Lets log the actual value that the compare condition failed against - May need to protect this with a checkbox for security reasons (don't want to store sensitive information in the audit log).
      • Deep link audit log entries for rule failed emails
      • Add audit log entry when rule is auto disabled due to failures -
        When there are 5 (or more) failures for SLA rules, 10 for others, the rule is automatically disabled. When this happens an entry should be added to audit log to avoid confusion.
      • Audit log should link to other audit logs if triggered by another execution -
        For complex flow of rules, we should allow people to navigate through the related (trace id?) executions and trace where the rule is triggered from
        POssibly even have a special view to give an overview of where things have flowed to
      • Log the initiator of the rule in the audit log - For manual and event based triggers. (scheduled are a bit special here)
      • Improve fields not on screen audit log error - Lets include a link to docs page with permission & where is my field helper. This keeps coming up in support all the time. (edit failing with this error)
      • Log manual schedule executions differently to scheduled execution - For the 'Scheduled' trigger we should log a message in the audit log when the rule was triggered manually by hitting the 'Run Schedule' button.
      • Improve permission error around field editing - Maybe just a minor suggestion, if the error indicated in the audit log can be clearer for this case, for example if it states that “The actor of the rule does not have permission to perform the action on the tickets due to permission right”, instead of indicating that “No fields or field values to edit for issues (could be due to some field values not existing in a given project)”
      • Add audit message for ignored/unknown values in issue fields - We need to pass in the auditItemBuilder so the fields can add an error. e.g. trying to set an unknown version, or a rendered value is unknown.
      • Improved error messaging on create action, e.g. better job with field screen error messages and validation, log status code when action fails with no error -
        • This is the error in the audit log: Unknown fields set during create. Field may not be on Create screen for project/type. Fields ignored -
          labels. We could perhaps to do some linking to the right screen and or perform validation in the create/edit/transition issue action if we know the project/issue types.
        • consider adding suggesting a workaround in the Cloud error message when a field isn't on the screen
      • _____
        • Create action occasionally fails with no error message
          Occasionally when creating/transitioning an issue, the JIra Cloud API may fail with a 403 and return an HTML snippet like: 
          <html>
<head>
    <title>Forbidden (403)</title>

          This will get logged as "Error creating issue" with no extra information, since the response isn't in a valid JSON format.

      Fixes

      We should:

      (1) Ensure that the at least the status code gets logged in the AuditLog to provide some guide as to what the the underlying problem might be.
      (2) Somehow workaround / work with Atlassian about the cause of the 403. Raised with Atlassian at https://ecosystem.atlassian.net/servicedesk/customer/portal/14/DEVHELP-2916

      Customers are complaining about the error icon besides the rule name when the execution goes wrong.
      They want to clear the audit logs in order to have this error icon cleaned whenever they like to.

      There are scenarios when the rule is not executed however the audit logs shows success.

      In such cases if rule is not executed, the audit log should report 'no actions performed' or something similar instead of 'success' message.

      If branches find no issues rule should report "no actions performed" -

      If a rule does not perform any actions because branches do not find any related issues, the rule should report no actions performed, rather than success.

      It might be nice for JQL branches to also log the JQL that was executed if no issues were found to help with debugging.

      Audit logs in the "Recent executions" should only should only show rules that ran - By default, we should filter out "No actions performed". Doesn't make much sense to show rules that didn't actually run against the issue

      While you’re here would be good to be clear to the user that we’re showing the last 8 executions (sometimes people think that this is all the executions). So if list size == 8 then show a helper text

      ___________

      Ability to access full audit item - At the moment we truncate lots of items but sometime it is useful to see the complete list of issues.
      There should be an option to load these.

              Unassigned Unassigned
              89403358cf11 Charlie Gavey
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: