From 8e5650920c799cbdf98af23dad945231b3adf1dd Mon Sep 17 00:00:00 2001 From: Eugene Lee Date: Tue, 15 Mar 2022 11:45:43 -0700 Subject: [PATCH] Add more live tail content Signed-off-by: Eugene Lee --- _observability-plugin/app-analytics.md | 2 ++ _observability-plugin/event-analytics.md | 9 ++++++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/_observability-plugin/app-analytics.md b/_observability-plugin/app-analytics.md index e58f7ba4..bcd0b0fd 100644 --- a/_observability-plugin/app-analytics.md +++ b/_observability-plugin/app-analytics.md @@ -18,8 +18,10 @@ To get started, choose **Observability** in OpenSearch Dashboards, and then choo 1. Enter a name for your application and optionally add a description 1. Do at least one of the following - Use [PPL]({{site.url}}{{site.baseurl}}/observability-plugin/ppl/index) to specify the base query. + You can't change the base query after the application is created. {: .note } + - Select services & entities from the dropdown or the service map. - Select trace groups from the dropdown or the table. 1. Choose **Create**. diff --git a/_observability-plugin/event-analytics.md b/_observability-plugin/event-analytics.md index 0db088ab..0af67330 100644 --- a/_observability-plugin/event-analytics.md +++ b/_observability-plugin/event-analytics.md @@ -30,10 +30,12 @@ For more information about building PPL queries, see [Piped Processing Language] After Dashboards generates a visualization, you must save it if you want to return to it at a later time or if you want to add it to an [operational panel]({{site.url}}{{site.baseurl}}/observability-plugin/operational-panels). -To save a visualization, expand the save dropdown menu next to **Run**, enter a name for your visualization, then choose **Save**. You can reopen any saved visualizations on the event analytics page. +To save a visualization, expand the save dropdown menu next to **Refresh**, enter a name for your visualization, then choose **Save**. You can reopen any saved visualizations on the event analytics page. ## View logs +Users have several ways to view their logs. + ### Trace log correlation Users who regularly track events across applications have the capability to correlate Logs and Traces. To view the correlation, users have to index the traces as per the Open Telemetry standards (similar to trace analytics). Once users add a TraceId field to their logs, they can view the correlated trace information in the event explorer log details. This will allow users to correlate logs and traces that correspond to the same execution context. @@ -42,12 +44,13 @@ Users who regularly track events across applications have the capability to corr ### Surrounding events -When users want to know more about a log event that they are looking at, they can select **View surrounding events** to get a bigger picture of what was happening around the time of interest. +Users who want to know more about a log event that they are looking at can select **View surrounding events** to get a bigger picture of what was happening around the time of interest. ![Surrounding Events]({{site.url}}{{site.baseurl}}/images/surrounding_events.gif) ### Live Tail -When users are watching a live event take place, they no longer have to manually refresh their view. Users can now configure the interval in which content is refreshed saving the hassle of manually refreshing. + +Users watching a live event take place no longer have to manually refresh their view. Users can now configure the interval in which content is refreshed saving the hassle of manually refreshing. Live Tail feature will allow users to stream live logs on OpenSearch Observability Event Analytics based on provided PPL query, as well as provide rich functionality such as applying filters. This feature provides users with a faster debugging experience, and allows them to monitor their logs in real-time without relying on manual refresh. Users also have the convenience of choosing an interval and even switching between intervals on how often the live tail should stream live logs. As this feature mimics the "tail -f" command in command line, it only retrieves the most recent live logs by possibly eliminating a heavy load of live logs. Live Tail also provides users with the total count of live logs received by Opensearch during live streaming, which can be a useful tool in understanding the incoming traffic. ![Live Tail]({{site.url}}{{site.baseurl}}/images/live_tail.gif) \ No newline at end of file