Case Summary Template
Description:
1. Creating the problem statement - Include within the Problem statement:
-
- What:
- A brief description of the problem - when x is done, y happens, rather than z
- Who:
- Does it happen to everyone? Or just a single user or subset of users?
- Where:
- Does this happen on all systems/servers? Or just a single system/server?
- What is the difference between this and a system that does work?
- When:
- What is the catalyst for the issue to occur?
- How often does this occur?
- Does this only happen at a certain time of day? Does it happen after a certain amount of time?
- When was the most recent occurrence?
- When is the issue expected to happen again?
- Is this still happening?
- Has this worked before?
2. Steps to reproduce.
-
- Reproduction (use steps as below)
- Step 1
- Step 2
- Step 3
- Document expected behavior
- Why is this expected?
- Does the documentation state this?
- Did it work differently before?
- Document actual observed behavior
- Include fully written out errors here
- Include screenshots of the progression
- Include the command line entries with responses
- Include related scripts
- Can the issue be reproduced at will?
- If the issue cannot be reproduced, why not?
Even stating something when steps are mostly unknown as below provides a lot of useful information:
1) Job is started
2) Wait some time
3) Job fails with error xyz
3. Version(s) of affected/involved component(s)
NOTE: If this is the result of an upgrade, include previous version as well as current version
-
-
Applications Manager full version (if applicable)
-
Java full version (if applicable)
-
DB version
- OS type and kernel version
4. What changes have been made/found on the involved:
-
- Product components
- Environment in which the product/components are running
- OS updates/patches
- Hardware or Virtual HW updates (CPU, Mem, Storage)
- Increase in server load during specific times (spiking)
- Network updates/patches
- Increase in general system load over last few weeks/months
5. Is there a current solution or workaround?
-
- If this is for root cause, what resolved the issue when it happened?
- Is there a way to get around the issue (or another way to get expected results)?
6. Description of the impact to the business (explaining the chosen priority)
-
- What is the impact to business when this problem occurs?
- Is this blocking an upgrade? If so, what is the timeline? What happens if that timeline is not hit?
- Are workarounds acceptable? If so, for how long?
- If there is no impact, and just an inconvenience, please note that
7. What troubleshooting has been done so far
-
- What has been tried? Tried: x, y, z
- What was the result? Result: no change, different error during x, y, z
8. Knowledge search results
-
- What keywords were used in the Broadcom Knowledge search?
- What was returned?
-
- This is important for Broadcom to know how to improve their articles if there is one that was already created that was missed. It’s important to describe this in a way that customers would search in the future. “Agent goes down after 10 minutes” is a viable knowledge search.
9. Analysis Documents (object-exports / job-output / logs / screenshots / command line history, etc.)
NOTE: When a problem is not reproducible then as much information as possible should be provided (complete logs from the time, output files, etc…). If a problem is reproducible, provide the appropriate logs required to analyze the root cause. This is one area that consumes a lot of time prior to being able to carry out a full analysis. If the correct logs are provided upfront, the issue will progress much more quickly.
-
- What documents were gathered?
- What should be looked at?
- What files contain what information?
- What kind of logs on which components were gathered?
10. RunID / timestamp
-
- When files are looked at, what timestamp should be looked at?
- What is the RunID for a task that hit the issue?
11. Expectations with the case - if not clear above, what is expected when looking at this case?
-
- Technical expectations (which of the following fit the situation):
- Is this behavior as designed?
- If this is not as designed, is there a product defect?
- What information is necessary to move forward?
- Question to answer - is there a way to do this?
- Is this a known issue?
- Is there a different way to achieve results?
- Case expectations
- Is there a specific timeline expected?
- Is there specific knowledge needed when troubleshooting?
- Is there a preferred method of communication?
- Is there a preferred timezone and time of day to be contacted?