Generating events from logs - IX plan
Project information
Product and release | BMC Helix Log Analytics |
|---|---|
Features | Alerts |
Content developer | Swati Malhotra |
Epic / Use cases | Complete use case: Enable users be alerted if a condition is satisfied in logs. User creates an alert and event is generated in BHOM. |
Design documents | |
Personas | Tenant administrator |
Master space | |
Whatfix self-help plan | NA |
Product style sheet |
Use cases
Use case | Persona | Situation | Customer's information need | Delivery medium | Search keywords | Real-world example | Test case | Testing needs R&D help? | Review comments |
|---|---|---|---|---|---|---|---|---|---|
Enable users to create alerts in logs, view the created events in Dashboard, and get a link from Dashboards to the log entry in Log Analytics. | Tenant administrator | Happy Path | Can I be alerted when there is a certain error or entry in my logs? | In a Wiki topic, we begin by telling users about the capability and then introduce the video. | alert, log analytics, log events, resolving events | To get an alert if error status 404 occurs in logs more than 100 times in an hour. | To verify if the content on the page is correct To verify that by following steps in the video, you can create an alert and view it in Dashboards. | Yes | |
How can I create alerts? | Video Objectives:
| ||||||||
What will be the type of event that is generated? | |||||||||
Can I get details of the Log event class? | |||||||||
Where will I see the event? | |||||||||
Will there be an OOTB dashboard panel available for these events? | |||||||||
Can I use these events in Dashboards and AIOps? | |||||||||
If I want to investigate the log, how can I reach the log entry? | |||||||||
What do I do to the created events? | |||||||||
Is it a way to automatically close such events after investigation is done? | |||||||||
Corner case | What if the event is not generated? | Confirm with Dev/QA and this info in the troubleshooting section or see if we can cover it in the video. | |||||||
Troubleshooting |
Wiki structure
In the outline, list the sets of tasks, concepts, and reference information that forms a complete workflow for the use case. Depending on the complexity of the feature, you might have multiple workflows or parent/child workflows. If possible, try to keep topics only three levels deep (L2 - L4). If a topic contains a help context ID, review guidelines on IDD Central before renaming the topic.
Role | L1 - Branch | L2 | L3 | L4 | L5 | Subheadings | Topic type | Rich media | Writer notes | Review comments |
|---|---|---|---|---|---|---|---|---|---|---|
<enhancement subheading> | ||||||||||
Tenant admin | Generating events from logs | |||||||||
Viewing logs in BMC Helix Dashboards | This is the existing subheading in the topic. It should be "To view..." unless this is the one about cross-launching. Your plan is not clear and this title does not expose the goal of the task (define a dashboard and cross-launch link). See subheading guidelines in Titles-and-headings. | |||||||||
To create an alert | Video | SR: I assume this is a new subheading but it's in the L2 column. Does it come before or after the existing one? "To create an alert from a log event"??? If this is the subheading for the video, it should be something like "Learn how to generate alerts for log issues and resolve issues." So that the reader can jump to certain parts to do the procedures, you should also have a video ToC. See Embedding-your-video-in-documentation. Video looks good. 😉️ | ||||||||
Enabling cross-launch link to Log Analytics from Helix Dashboards | Is this a child topic or subheading? If a subheading, it should be "To enable a.... from BMC Helix Dashboards" You can't omit BMC before Helix. If it's a child topic, we need to discuss the structure a little more. |
Estimates
Deliverable | Effort in person hours | Notes |
|---|---|---|
UI, tooltip, or error message text review | 2 | |
Whatfix guided assistance (flow), self-help links, task list, or pop-ups | ||
Video | 40 | |
Tutorial based on OOTB data | ||
Tutorial or video | ||
Wiki topic with graphics or interactive content (log event class) | 8 | |
Troubleshooting guide in collaboration with Support or link to KB article (for corner cases, written by Support) | ||
Total | 50 |