Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The tips are grouped by area or topic; therefore, they do not follow any specific order. However, you should start by looking at the Jira specifics and Process section related tips first as it .

Within each area/topic, tips will be presented by descending order of risk; each tip is preceeded by a icon that corresponds to the risk level.  

...

  1.  Review the "Max results per request" setting in the the Miscellaneous administration settings as it controls the pagination on the REST API calls. The default value should be ok.
  2.  export results - custom fields
  3. https://confluence.xpand-it.com/display/XRAY/Export+Execution+Results+-+REST
  4. diamantino vai Diamantino Campos  vai ver o q mandou pra ubs
  5.  Limit API calls (Jira and Xray related ones) using a reverse proxy
    1. Evaluate what REST API calls are being used, discuss their real need with users
      1. Make sure that pagination is being used on the REST API calls
    2. Restrict access to REST API calls
      1. Limit access to well-known hosts/applications

...

  1.   Using unoptimized JQL queries can degrade performance substantially
    1. most times this happens because users don't understand how JQL works first of all; JQL is not like SQL (see Understanding JQL Performance). Thus, filtering issues by project by adding the "project = <xxx>" clause is not the same as specifying the project as argument to the subsequent JQL function.
      1. Example: 
        1. Use

          issue in requirements('OK','CALC')

          ...instead of ...

          project = 'CALC' and issue in requirements('OK')

  2.  Some JQL functions, such as the ones dealing with requirement coverage, may be more intensive than other ones, since Xray may have to, for example, load all the related Test Runs in order to obtain relevant data. The following JQL 
    1. PIOR

      testPlanTests() -

       
    2. requirements(), with dates
    3. testExecutionTests() (diamantino tem duvidas?)  - whenever filtering by tests/requirements

      whenever by tests in a given status; the current workaround is to search using the "TestRunStatus" custom field. 

      Note
      titlePlease note

      When searching for Tests with a certain status inside a Test Plan, we recommend you to use the custom field search instead.


      Xray has created a new way of searching with big improvements when filtering by test status, using the Custom Fields:
      (3)
      issuetype = Test and TestRunStatus = "DEMO-10 - TODO"
      (4)
      issuetype = Test and TestRunStatus = "DEMO-10 - TODO environment:IOS"

    4. requirements() - whenever filtering by by dates
    5. testExecutionTests() (Diamantino Campos diamantino tem duvidas?)  - whenever filtering by tests/requirements in a given status; it will depend on the amount of Tests you have on the it will depend on the amount of Tests you have on the Test Execution
    6. parentRequirements() (Diamantino Campos diamantino tem duvidas?)  - depending on the amount of requirements and sub-requirements you have, it can take a while to complete and require some resources

...

Xray calculated custom fields

  1. Image Removed Xray Image Added  Xray provides some specific custom fields that calculate their values on the fly. This means that you should have that in mind, specially if you're including them in tables/issue listings/gadgets.

      Test Execution Defects

      test set status

      tests count

        1. The most intensive custom fields are the "Test Execution Defects" and the "Test Set Status". The "Tests Count", as it does an aggregation, also is intensive if you use it for multiple issues.


      Reports and Gadgets

      1.  One way of doing reporting is by using gadgets. Gadgets are great to share information between team members and even between different teams; however, if not use carefully, they can degrade JIRA performance if all users have the same report on their dashboard as they will probably generate multiple requests once users access the dashboard. Thus, use carefully most intensive gadgets such as the "Historical Daily Requirement Coverage" and the "Tests Evolution" gadget and others that do aggregations (e.g. "Test Runs Summary" gadget). Gadgets that just "list" entities should not affect performance significatively.
      2.  Limit the target issues for the reports/gadget gadgets CONF, e.g. generate the Overall Requirement Coverage (report/gadget) just for issues that you really need and not all Jira requirements or projects.

      ...

      1.  Review the settings "Max Test Runs for bulk operations", "Max number of requirements per report or gadget results", "Max number of Tests per Test Plan", "Max results per request" in the the Miscellaneous administration settings. The default values should be ok.
      • quais outros settings podem ter mais impacto na performance?
      • estado calcula com base no testset; cuidado ao mudar
      1. settings. The default value should be ok.
      2. Image Added Using the requirement coverage strategy "Use versioned Test Sets for Requirement Coverage" will require additional computational resources on daily usage; therefore, the default "Use versioned Test Executions for Requirement Coverage" strategy is the recommend one. Learn more in Requirements Coverage. If you change this setting, then it can take a while until all statuses are re-calculated depending on your instance dimension.

      Your own custom fields

      1.  Beware with calculated custom fields implemented using some customization app (e.g. Jira Misc Custom Fields, ScriptRunner, etc) as they will be calculated each time they're accessed and they can impact things such as:
        • indexing time
        • REST API calls (e.g. whenever searching issues)
        • on listings (e.g. on Issues search page, Filters Results gadget, Xray tabular sections) if they're included as columns columns .
      2.  Adding a lot of custom fields on Jira will add some overhead on performance; therefore, Atlassian itself recommends a responsible usage of custom fields.

      Workflows on Xray entities

      1.  Don't use complex workflows for Xray entities as it will harden their usage; if the workflows have many steps then it will impact overall Jira performance

      Reindex???

      ?? avaliar questao de tirar searcher ao Test Execution Defects

      ...