Difference between revisions of "Reporting Bugs"

From Lustre Wiki
Jump to navigation Jump to search
(initial page creation as part of accelerated wiki migration)
 
(link to Jira instead of Bugzilla)
 
Line 1: Line 1:
{| class='wikitable'
+
<small>''(Updated: May 2021)''</small>
|-
 
!Note: This page originated on the old Lustre wiki. It was identified as likely having value and was migrated to the new wiki. It is in the process of being reviewed/updated and may currently have content that is out of date.
 
|}
 
 
 
<small>''(Updated: Dec 2009)''</small>
 
 
__TOC__
 
__TOC__
[https://bugzilla.lustre.org Bugzilla] for Lustre™ is an issue tracker as well as a bug tracker. It is a one-stop repository for:
+
[https://jira.whamcloud.com Jira] for Lustre™ is an issue tracker as well as a bug tracker. It is a one-stop repository for:
 
* Bugs
 
* Bugs
 
* Enhancement requests
 
* Enhancement requests
* Patch submission
+
* Tracking patch submission
* Patch review and dependency tracking
+
* Issue dependency tracking
  
A bug-tracking system is less-error prone and superior to email in dozens of ways. For this reason we ask that all the above issues be handled exclusively through Bugzilla.
+
A bug-tracking system is less-error prone and superior to email in dozens of ways. For this reason we ask that all the above issues be handled exclusively through Jira.
  
All of the important links described below are accessible from the Bugzilla main page or the toolbar at the bottom of each Bugzilla page.
+
All of the important links described below are accessible from the Jira main page or the toolbar at the bottom of each Bugzilla page.
  
 
== Opening an Account ==
 
== Opening an Account ==
To use Bugzilla, you will need to open an account. On the Main page, click on "Open a new Bugzilla account"After you enter a valid email address, an email will be sent to you confirming the creation of your account.
+
To use Jira, you will need to open an account. On the Main page are instructions for creating a new account.  This is, unfortunately, no longer a totally automated process due to spam and malicious users.
  
 
== Searching for Bugs ==
 
== Searching for Bugs ==
  
You can search for bugs in Bugzilla in two ways:  
+
You can search for bugs in Jira in two ways:  
  
* Enter the bug number or search on a keyword.
+
* Enter the issue number (e.g. [https://jira.whamcloud.com/browse/LU-12000 LU-12000]) or [https://jira.whamcloud.com/issues/?jql= search on a keyword].
* Search on a specific field or specify detailed or complex criteria. For more information about advanced searches see the [https://bugzilla.lustre.org/docs/html/using.html ''Bugzilla User's Guide'']
+
* Search for specific text or specify detailed or complex criteria with the [https://jira.whamcloud.com/issues/?jql= Advanced Search] option.
  
 
== Filing a Bug ==
 
== Filing a Bug ==
Line 31: Line 26:
 
1. Before opening a new bug report, do a quick search to avoid filing a duplicate bug.
 
1. Before opening a new bug report, do a quick search to avoid filing a duplicate bug.
  
2. To enter a new bug report, click on "New" or "Enter a new bug report".  
+
2. To enter a new bug report, click on "Create" in the top menu.  
  
3. In the bug report form, fill in as many fields as you can. If your version of Lustre isn't listed, include it in a note in the bug summary so that we can add it to the list. Please choose the correct component.
+
3. In the bug report form, fill in as many fields as you can. If your version of Lustre isn't listed, include it in a note in the bug Environment.
  
4. Include a descriptive summary. At a minimum, include the following:
+
4. Include a useful Summary line and a more complete Description. At a minimum, include the following:
  
 
* Describe the problem that you're solving, the feature that you're adding, or the enhancement that you're requesting.
 
* Describe the problem that you're solving, the feature that you're adding, or the enhancement that you're requesting.
 
* If you are reporting a bug, describe precisely the behavior that you're seeing and the behavior that you think is correct.
 
* If you are reporting a bug, describe precisely the behavior that you're seeing and the behavior that you think is correct.
* Provide a minimal a test case. For example, if 'tar' is crashing, try to narrow the issue down to a specific ''syscall''. If you have tried to narrow it down without success, tell us what you tried.
+
* Provide a minimal a test case. For example, if 'tar' is crashing, try to narrow the issue down to a specific ''syscall'' with e.g. ''strace''. If you have tried to narrow it down without success, tell us what you tried.
* If you are submitting a patch, see [[Submitting Patches]] for a detailed procedure.
+
* If you are submitting a patch, see [[Submitting Changes]] for a detailed procedure.
  
== Including Diagnostics Information in a Bug Report==
 
A Lustre diagnostics tool is available for downloading at: http://downloads.lustre.org/public/tools/lustre-diagnostics/.
 
You can run this tool to capture diagnostics output to include in the reported bug. To run this tool, enter one of these commands:
 
* lustre-diagnostics -t <bugzilla bug #>
 
* lustre-diagnostics.
 
Output is sent directly to the terminal. Use normal file redirection to send the output to a file, and then manually attach the file to the bug you are submitting.
 
 
== Priority Bugs ==
 
== Priority Bugs ==
If you have a support contract for Lustre with Oracle, you will see a group membership tick box. Use this box to indicate that the bug is important for your project.
+
If you have a support contract for Lustre, contact your support provider directly.
  
'''''Note:''''' S1 (Critical) bugs can be filed only for corruption events or by customers with support contracts who are experiencing a production outage event.
+
'''''Note:''''' Severity 1 bugs can be filed only for corruption events or by customers with support contracts who are experiencing a production outage event.

Latest revision as of 12:48, 11 May 2021

(Updated: May 2021)

Jira for Lustre™ is an issue tracker as well as a bug tracker. It is a one-stop repository for:

  • Bugs
  • Enhancement requests
  • Tracking patch submission
  • Issue dependency tracking

A bug-tracking system is less-error prone and superior to email in dozens of ways. For this reason we ask that all the above issues be handled exclusively through Jira.

All of the important links described below are accessible from the Jira main page or the toolbar at the bottom of each Bugzilla page.

Opening an Account

To use Jira, you will need to open an account. On the Main page are instructions for creating a new account. This is, unfortunately, no longer a totally automated process due to spam and malicious users.

Searching for Bugs

You can search for bugs in Jira in two ways:

Filing a Bug

To file a bug, complete these steps:

1. Before opening a new bug report, do a quick search to avoid filing a duplicate bug.

2. To enter a new bug report, click on "Create" in the top menu.

3. In the bug report form, fill in as many fields as you can. If your version of Lustre isn't listed, include it in a note in the bug Environment.

4. Include a useful Summary line and a more complete Description. At a minimum, include the following:

  • Describe the problem that you're solving, the feature that you're adding, or the enhancement that you're requesting.
  • If you are reporting a bug, describe precisely the behavior that you're seeing and the behavior that you think is correct.
  • Provide a minimal a test case. For example, if 'tar' is crashing, try to narrow the issue down to a specific syscall with e.g. strace. If you have tried to narrow it down without success, tell us what you tried.
  • If you are submitting a patch, see Submitting Changes for a detailed procedure.

Priority Bugs

If you have a support contract for Lustre, contact your support provider directly.

Note: Severity 1 bugs can be filed only for corruption events or by customers with support contracts who are experiencing a production outage event.