opensearch-project / dashboards-observability

Visualize and explore your logs, traces and metrics data in OpenSearch Dashboards
https://opensearch.org/docs/latest/observability-plugin/index/
Apache License 2.0
14 stars 50 forks source link

[UX] Log patterns in Observability (WIP) #89

Open kavck opened 2 years ago

kavck commented 2 years ago

https://github.com/opensearch-project/observability/issues/850 - eng RFC

Overview

Log patterns are auto generated patterns from log data that makes it quicker and easier to get actionable insights for ops teams to troubleshoot and draw meaningful insights quickly from large volumes of log data. In the first iteration, we are auto-identifying patterns based on an event’s punctuation profile we call, Punctuation Signatures.

User stories

  1. As a user, I want to view auto-generated log patterns from log data so that I can detect outlier events and speed up troubleshooting.
  2. As a user, I want to sort and filter log patterns so that I can review auto-generated log pattern quickly as I continue troubleshooting my analysis.
  3. As a user, I want to rename log pattern names so that I can utilize meaningful nomenclature to interesting and/or non-interesting log patterns.

Flow structure

View log patterns within Event Explorer

  1. Select a query or create a new one. Then navigate to the ”Pattern“ tab to view auto-generated log patterns.

image

Edit log pattern name within Event Explorer

  1. Select a query or create a new one. Then navigate to the ”Pattern“ tab to view log patterns and select ”Edit name“ to edit log pattern name.

image

Design Walkthrough

View Log Patterns - Workflow

View Log Patterns

Screen by screen mockups

![image](https://user-images.githubusercontent.com/108144351/180568835-e11eeda8-a261-4fa2-87f9-bc1bf1516208.png) ![image](https://user-images.githubusercontent.com/108144351/180568860-bfc31278-bf7a-4ca9-ab26-9f413ade6754.png) ![image](https://user-images.githubusercontent.com/108144351/180568877-e9795eba-a203-4535-a69d-479c4fcaa757.png)

Edit Pattern Name - Workflow

Edit Pattern Name

Screen by screen mockups

![image](https://user-images.githubusercontent.com/108144351/180569920-f4f2d3cf-2ad3-4ee2-a98c-4a23463dab3d.png) ![image](https://user-images.githubusercontent.com/108144351/180569948-92cd0b11-08c9-4303-9f1b-a97b10d20d8a.png) ![image](https://user-images.githubusercontent.com/108144351/180569976-95a56d61-1812-48e5-9d99-2c5e04a03779.png)

Open questions

xinlamzn commented 1 year ago

where are on the document for the log pattern cmd?