From 6a7cbeae6c581e943f1c8fb3251a7532febb231c Mon Sep 17 00:00:00 2001 From: Sven Grossmann Date: Fri, 20 Jan 2023 10:16:50 +0100 Subject: [PATCH] Logs: Adjust documentation for new log details (#61311) * update doc * fix capitalisation and formatting of headings Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> * fix capitalisation and formatting Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> --- docs/sources/datasources/loki/_index.md | 2 +- docs/sources/explore/logs-integration.md | 14 ++++++-------- .../visualizations/logs/index.md | 4 ++-- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/sources/datasources/loki/_index.md b/docs/sources/datasources/loki/_index.md index d116b740ea9..5b3ec3a3932 100644 --- a/docs/sources/datasources/loki/_index.md +++ b/docs/sources/datasources/loki/_index.md @@ -75,7 +75,7 @@ Select **Show example log message** to display a text area where you can enter a The new field with the link shown in log details: -{{< figure src="/static/img/docs/explore/detected-fields-link-7-4.png" max-width="800px" caption="Detected fields link in Explore" >}} +{{< figure src="/static/img/docs/explore/data-link-9-4.png" max-width="800px" caption="Data link in Explore" >}} ### Provision the data source diff --git a/docs/sources/explore/logs-integration.md b/docs/sources/explore/logs-integration.md index 5e5b90d8656..323bbc312cc 100644 --- a/docs/sources/explore/logs-integration.md +++ b/docs/sources/explore/logs-integration.md @@ -112,18 +112,16 @@ To automatically fix incorrectly escaped sequences that Explore has detected: Explore replaces these sequences. When it does so, the option will change from "Escape newlines" to "Remove escaping". Evaluate the changes as the parsing may not be accurate based on the input received. You can revert the replacements by clicking "Remove escaping". -#### Derived fields links +#### Data links -By using Derived fields, you can turn any part of a log message into an internal or external link. The created link is visible as a button next to the Detected field in the Log details view. -{{< figure src="/static/img/docs/explore/detected-fields-link-7-4.png" max-width="800px" caption="Detected fields link in Explore" >}} +By using data links, you can turn any part of a log message into an internal or external link. The created link is visible as a button in the **Links** section inside the **Log details** view. +{{< figure src="/static/img/docs/explore/data-link-9-4.png" max-width="800px" caption="Data link in Explore" >}} -#### Toggle detected fields +#### Toggle field visibility -> **Note:** Available in Grafana 7.2 and later versions. +Expand a log line and click the eye icon to show or hide fields. -If your logs are structured in `json` or `logfmt`, then you can show or hide detected fields. Expand a log line and then click the eye icon to show or hide fields. - -{{< figure src="/static/img/docs/explore/parsed-fields-7-2.gif" max-width="800px" caption="Toggling detected fields in Explore" >}} +{{< figure src="/static/img/docs/explore/toggle-fields-9-4.gif" max-width="800px" caption="Toggling detected fields in Explore" >}} ### Loki-specific features diff --git a/docs/sources/panels-visualizations/visualizations/logs/index.md b/docs/sources/panels-visualizations/visualizations/logs/index.md index 6a8a28a2ad3..bc9ad69d9d2 100644 --- a/docs/sources/panels-visualizations/visualizations/logs/index.md +++ b/docs/sources/panels-visualizations/visualizations/logs/index.md @@ -32,9 +32,9 @@ For logs where a **level** label is specified, we use the value of the label to Each log row has an extendable area with its labels and detected fields, for more robust interaction. Each field or label has a stats icon to display ad-hoc statistics in relation to all displayed logs. -### Derived fields links +### Data links -By using Derived fields, you can turn any part of a log message into an internal or external link. The created link is visible as a button next to the Detected field in the Log details view. +By using data links, you can turn any part of a log message into an internal or external link. The created link is visible as a button in the **Links** section inside the **Log details** view. ### Display options