Explain time series metric, trace log correlation, trim down live tail
Signed-off-by: Eugene Lee <eugenesk@amazon.com>
This commit is contained in:
parent
8e5650920c
commit
44228e903c
|
@ -31,18 +31,13 @@ You can't change the base query after the application is created.
|
||||||
1. Choose the **Log Events** tab
|
1. Choose the **Log Events** tab
|
||||||
1. Use [PPL]({{site.url}}{{site.baseurl}}/observability-plugin/ppl/index) to build upon your base query
|
1. Use [PPL]({{site.url}}{{site.baseurl}}/observability-plugin/ppl/index) to build upon your base query
|
||||||
1. Move to the **Visualizations** tab to see your visualizations
|
1. Move to the **Visualizations** tab to see your visualizations
|
||||||
1. Expand the **Save** dropdown menu, enter a nem for your visualization, then choose **Save**.
|
1. Expand the **Save** dropdown menu, enter a name for your visualization, then choose **Save**.
|
||||||
|
|
||||||
To see your visualizations, move to the **Panel** tab.
|
To see your visualizations, move to the **Panel** tab.
|
||||||
|
|
||||||
### Configure availability
|
### Configure availability
|
||||||
|
|
||||||
In order to configure availability, you must add availability levels to a line type time series metric. Users can use the power of the PPL language to define arbitrary conditions on their logs to create a time series metric.
|
Availability is the status of your application determined by availability levels set on a [time series metric]({{site.url}}{{site.baseurl}}/observability-plugin/app-analytics/#time-series-metric).
|
||||||
|
|
||||||
##### Example
|
|
||||||
```
|
|
||||||
source = <index_name> | ... | ... | stats ... by span(<timestamp_field>, 1h)
|
|
||||||
```
|
|
||||||
|
|
||||||
To create an availability level you must configure the following
|
To create an availability level you must configure the following
|
||||||
- color: The color of the availability badge on the home page.
|
- color: The color of the availability badge on the home page.
|
||||||
|
@ -53,3 +48,16 @@ To create an availability level you must configure the following
|
||||||
![Configuring availability]({{site.url}}{{site.baseurl}}/images/app_availability_level.gif)
|
![Configuring availability]({{site.url}}{{site.baseurl}}/images/app_availability_level.gif)
|
||||||
|
|
||||||
By default, Application analytics shows results from the last 24 hours of your data. To see data from a different timeframe, use the date and time selector.
|
By default, Application analytics shows results from the last 24 hours of your data. To see data from a different timeframe, use the date and time selector.
|
||||||
|
|
||||||
|
#### Time series metric
|
||||||
|
|
||||||
|
A time series metric is any visualization that has a query that spans over a timestamp and is a line chart. Users can use the power of the PPL language to define arbitrary conditions on their logs to create a visualization over time.
|
||||||
|
|
||||||
|
##### Example
|
||||||
|
```
|
||||||
|
source = <index_name> | ... | ... | stats ... by span(<timestamp_field>, 1h)
|
||||||
|
```
|
||||||
|
|
||||||
|
Users can then choose **Line** in visualization configurations to create a time series metric.
|
||||||
|
|
||||||
|
![Changing visualization to line chart]({{site.url}}{{site.baseurl}}/images/visualization-line-type.gif)
|
|
@ -38,7 +38,7 @@ Users have several ways to view their logs.
|
||||||
|
|
||||||
### Trace log correlation
|
### 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.
|
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 trace information that corresponds to the same execution context as the log.
|
||||||
|
|
||||||
![Trace Log Correlation]({{site.url}}{{site.baseurl}}/images/trace_log_correlation.gif)
|
![Trace Log Correlation]({{site.url}}{{site.baseurl}}/images/trace_log_correlation.gif)
|
||||||
|
|
||||||
|
@ -50,7 +50,6 @@ Users who want to know more about a log event that they are looking at can selec
|
||||||
|
|
||||||
### Live Tail
|
### Live Tail
|
||||||
|
|
||||||
|
Users watching a live event take place can now configure the interval in which content is refreshed saving the hassle of manually refreshing. This provides users with a faster debugging experience, and allows them to monitor their logs in real-time. Users also have the convenience of choosing the interval at which live tail should update. 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.
|
||||||
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)
|
![Live Tail]({{site.url}}{{site.baseurl}}/images/live_tail.gif)
|
Binary file not shown.
After Width: | Height: | Size: 2.4 MiB |
Loading…
Reference in New Issue