From a02ce69a98e7ffe498078324df891affdfacaafe Mon Sep 17 00:00:00 2001 From: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com> Date: Fri, 12 Aug 2022 10:38:17 -0700 Subject: [PATCH] Docs: add minimal docs explaining how to use the LogQL Analyzer (#6900) --- docs/sources/logql/analyzer.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/sources/logql/analyzer.md b/docs/sources/logql/analyzer.md index 9c4a181480..694d5c5dc3 100644 --- a/docs/sources/logql/analyzer.md +++ b/docs/sources/logql/analyzer.md @@ -1,5 +1,7 @@ --- title: LoqQL Analyzer +menuTitle: LoqQL Analyzer +description: The LogQL Analyzer is an inline educational tool for experimenting with writing LogQL queries. weight: 60 --- @@ -8,6 +10,21 @@ weight: 60 # LogQL Analyzer +The LogQL Analyzer is an inline tool for experimenting with writing LogQL queries. + +Chose the log line format with the radio buttons. +A set of example log lines are included for each format. + +Use the provided example log lines, or copy and paste your own log lines into the example log lines box. + +Use the provided example query, or enter your own query. +The [log stream selector](../log_queries/#log-stream-selector) remains fixed for all possible example queries. +Modify the remainder of the log line and click on the **Run query** button +to run the entered query against the example log lines. + +The results output provides details for each example log line. +Clicking on a line in the results pane expands the details, showing why the line is or is not included in the query result set. +