Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7510 from newrelic/NRAI-postmortem
new 'NRAI postmortems' doc
- Loading branch information
Showing
9 changed files
with
185 additions
and
2 deletions.
There are no files selected for viewing
181 changes: 181 additions & 0 deletions
181
...-applied-intelligence/applied-intelligence/postmortems-applied-intelligence.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,181 @@ | ||
--- | ||
title: "Create postmortems with applied intelligence" | ||
metaDescription: "New Relic postmortems help you build quick and accurate postmortems by collecting events, metrics, and metadata automatically." | ||
--- | ||
|
||
import postmortem1 from 'images/postmortem-1.png' | ||
|
||
import postmortem2 from 'images/postmortem-2.png' | ||
|
||
import postmortem3 from 'images/postmortem-3.png' | ||
|
||
import postmortem4 from 'images/postmortem-4.png' | ||
|
||
import postmortem5 from 'images/postmortem-5.png' | ||
|
||
import postmortem6 from 'images/postmortem-6.png' | ||
|
||
import postmortem7 from 'images/postmortem-7.png' | ||
|
||
<Callout title="Public preview"> | ||
This feature is still in development, but we encourage you to try it out. | ||
</Callout> | ||
|
||
With applied intelligence's postmortems feature, events, metrics, and metadata are automatically collected to create a template you can use to run an incident postmortem for your team. | ||
|
||
## What is a postmortem? [#postmortem] | ||
|
||
As you probably know, a postmortem is a retrospective process that teams use to analyze what worked and what didn't when responding to and resolving an incident. | ||
|
||
In the New Relic platform, the postmortem feature is a tool you can use to prepare a successful retrospective process for your team. | ||
|
||
The postmortem includes: | ||
|
||
* the record of an incident, including descriptions | ||
* a timeline of the incident | ||
* the incident's impact | ||
* the incident's root causes | ||
* mitigation measures taken by your team | ||
* follow-up action items to prevent the incident from recurring in the future | ||
|
||
For a peek at how to build a postmortem with applied intelligence, watch this short video (3:03 minutes): | ||
|
||
<Video | ||
type="wistia" | ||
id="b0jcdks8eb" | ||
/> | ||
|
||
## Why use our postmortem tool? [#why-postmortem] | ||
|
||
Applied intelligence postmortems automatically collect data related to an incident, freeing up your team to focus on analysis and action items for improved responses to future incidents. | ||
|
||
Ready to get started? Make sure you have a [New Relic account](https://newrelic.com/signup). It's free, forever! | ||
|
||
## Create a postmortem [#create-postmortem] | ||
|
||
When an issue is closed, you can create a postmortem. | ||
|
||
To find your issues, go to [one.newrelic.com](https://one.newrelic.com) > **Alerts & AI** > **Analyze**, and click **Issues & activity**. | ||
|
||
Issues are groups of incidents related to the same underlying problem. When a new incident is created, incident intelligence opens an issue and evaluates other open issues for possible correlation. | ||
|
||
Follow these steps to create a postmortem. | ||
|
||
### Step 1: Enter postmortem page [#postmortem-page] | ||
|
||
From the issue feed, select an open issue for your postmortem. | ||
|
||
To see your closed issues, in the search field, click the filter button, then select the **Closed** issue state. | ||
|
||
On the issue detail page, click **Close**, and then click **Create postmortem**. | ||
|
||
### Step 2: Review, edit, and comment on timeline [#edit-event-timeline] | ||
|
||
A postmortem collects the events and metadata throughout the lifespan of an issue and automatically creates an event timeline. | ||
|
||
<img | ||
title="The postmortem timeline" | ||
alt="A screenshot of the postmortem timeline showing how events are grouped by time and date." | ||
src={postmortem1} | ||
/> | ||
|
||
<figcaption> | ||
Specific events can be collapsed or expanded to make it easier to focus on what's important to you. | ||
</figcaption> | ||
|
||
Each event type is labeled with a different color to help distinguish them. Tags help provide useful additional context. | ||
|
||
The event types include anomaly incidents, incidents, deployments, and user activity. | ||
|
||
Each event in an issue is framed in an event card. You can review the timeline of events, delete an event card, or add a user event. | ||
|
||
### Step 3: (Optional) Add a user event [#add-user-event] | ||
|
||
<Callout variant="tip"> | ||
To add a note as a user event on the timeline, move your mouse below any card, you will see an "Insert card" option. | ||
</Callout> | ||
|
||
Click on "Insert card", enter contexts, and save. | ||
|
||
<img | ||
title="postmortem-2.png" | ||
alt="Screenshot of New Relic Postmortem Timeline Insert User Card" | ||
src={postmortem2} | ||
/> | ||
|
||
### Step 4: (Optional) Insert recommended charts for an event [#insert-charts-for-event] | ||
|
||
For any event, you can insert recommended charts to add context and show data metrics and trends. | ||
|
||
<img | ||
title="Postmortem recommended charts" | ||
alt="A screenshot of recommended charts for a specific postmortem event." | ||
src={postmortem3} | ||
/> | ||
|
||
Within an event card, click the **Insert charts** button. Choose from a collection of recommended charts related to your event. | ||
|
||
<Callout variant="important"> | ||
Charts are retained the same way underlying metrics and events are [retained for your account](/docs/data-apis/manage-data/manage-data-retention/). To update your chart retention, change your data retention settings. This affects your billing. | ||
</Callout> | ||
|
||
### Step 5: (Optional) Comment on an event [#comment-event] | ||
|
||
For any event on the timeline, you can add comments. | ||
|
||
<img | ||
title="Postmortem comments" | ||
alt="A screenshot of the postmortem comments field." | ||
src={postmortem4} | ||
/> | ||
|
||
<figcaption> | ||
Use comments to collaborate with your colleagues or remind yourself of useful context later. | ||
</figcaption> | ||
|
||
### Step 6: Review an event's metadata [#review-metadata] | ||
|
||
Postmortem metadata includes associated issues and entities. These are automatically added to the postmortem. You can delete any associated entity that isn't relevant to you. | ||
|
||
The time frame of the incident is also included as metadata. | ||
|
||
<img | ||
title="Postmortem metadata" | ||
alt="A screenshot of the postmortem page showing associated issues and entities, as well as the time frame." | ||
src={postmortem5} | ||
/> | ||
|
||
At the top of the postmortem page, select the severity level of the incident. The severity is shown on the postmortem list page. | ||
|
||
You can adjust the start and end time to reflect the actual time period of the incident, if it's different than what's captured automatically. | ||
|
||
### Step 7: Fill out context sections [#context-sections] | ||
|
||
<img | ||
title="Postmortem context fields" | ||
alt="A screenshot of the postmortem reporting free text fields" | ||
src={postmortem6} | ||
/> | ||
|
||
For a postmortem, the title and **What happened** summary sections are required fields. | ||
|
||
The metadata sections and events timeline give you essential context about what entities are affected, when, and how. | ||
|
||
Optionally, you can fill out the **Root cause** and **Recovery actions** sections to create a more detailed retrospective record. | ||
|
||
## View your postmortems [#view-postmortems] | ||
|
||
Once you've created one or more postmortems, you can return to them later. Follow these steps for a list of your postmortems. | ||
|
||
1. Go to [one.newrelic.com](https://one.newrelic.com) > **Alerts & AI** > **Analyze**, and click **Issues & activity**. | ||
2. Click the **Postmortems** tab. | ||
|
||
<img | ||
title="Postmortem list page" | ||
alt="A screenshot of the postmortem list page" | ||
src={postmortem7} | ||
/> | ||
|
||
3. Select an individual postmortem to look at the detailed postmortem record. | ||
|
||
If you decide you no longer need a postmortem, on the detailed postmortem record, click **Delete postmortem**. |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters