From fbad9055a4fba3760e981e196dc2ce22bdebe3d6 Mon Sep 17 00:00:00 2001 From: David Johansson Date: Mon, 1 Jul 2024 14:08:51 +0200 Subject: [PATCH 01/10] Add documentation for Query Log Analyzer --- modules/ROOT/content-nav.adoc | 5 +- .../download-logs.adoc} | 2 +- .../platform/logging/query-log-analyzer.adoc | 74 +++++++++++++++++++ 3 files changed, 79 insertions(+), 2 deletions(-) rename modules/ROOT/pages/platform/{logging.adoc => logging/download-logs.adoc} (99%) create mode 100644 modules/ROOT/pages/platform/logging/query-log-analyzer.adoc diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 1adb323b6..03c051b1b 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -15,9 +15,12 @@ Generic Start * xref:platform/user-management.adoc[] * xref:platform/apoc.adoc[] -* xref:platform/logging.adoc[Logging] * xref:platform/metrics-integration.adoc[Metrics Integration] +* Logging +** xref:platform/logging/download-logs.adoc[] +** xref:platform/logging/query-log-analyzer.adoc[] + * Neo4j connectors ** xref:platform/connectors/spark.adoc[] ** xref:platform/connectors/kafka.adoc[] diff --git a/modules/ROOT/pages/platform/logging.adoc b/modules/ROOT/pages/platform/logging/download-logs.adoc similarity index 99% rename from modules/ROOT/pages/platform/logging.adoc rename to modules/ROOT/pages/platform/logging/download-logs.adoc index 291229917..a78d14899 100644 --- a/modules/ROOT/pages/platform/logging.adoc +++ b/modules/ROOT/pages/platform/logging/download-logs.adoc @@ -1,5 +1,5 @@ [[aura-query-logs]] -= Logs += Request and download logs Aura allows you to request and download security and query logs. diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc new file mode 100644 index 000000000..df2003986 --- /dev/null +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -0,0 +1,74 @@ +[[aura-monitoring]] += Query log analyzer + +label:AuraDB-Professional[] +label:AuraDB-Enterprise[] + +Query log analyzer is a feature that provides a UI to review the queries executed on an Aura instance. + +To access *Query log analyzer*: + +. Navigate to the https://console.neo4j.io/?product=aura-db[Neo4j Aura Console] in your browser. +. Select the instance you want to access. +. Select the *Logs* tab. +. Select the *Query log analyzer* button. + +Query log analyzer is split up in two parts, a timeline and a table with two tabs: + +* *Query timeline* - Timeline showing metrics for number of queries, failed queries and query latency. +* *Summary* - An aggregated view of query logs, giving a high level overview over the selected time period. +* *Details* - A detailed view showing individual query execution in the selected time period. + +To fetch logs first choose a time range in the Query timeline. +With a time selection done, press the *Fetch logs* button. +You may optionally choose any filters or search text if required, then press *Go*. + +A summary of query executions is returned, showing aggregations per query. +To see the individual query executions, click the right arrow at the end of the line to show details for that query. +The details pane shows individual executions. + +== Chart interactions + +When viewing the query timeline, you can select from the following time intervals: + +* 30 minutes +* Last hour +* Last 2 hours +* Last 6 hours +* Last 24 hours +* Last 3 days +* Last week + + +=== Zoom + +To zoom in to a narrower time interval, select and drag inside any chart to select your desired time interval. +The data will automatically update to match the increased resolution. + +To reset zoom, double-click anywhere inside the chart. + +=== Toggle data series + +To hide or show individual data series, select the corresponding data series in the legend below the chart. + +== Table interactions + +=== Sort table + +By default the table will be sorted on *Count* for *Summary* and *Status* for *Details*. +To sort by a column (such as Max Time ms) click on the column heading. + +=== Modify columns + +The columns in the table can be modified by clicking the button to the right of the column row. +Columns can be [en|dis]abled or the order changed using the grid icon at the top right of the table. + +=== Expand query + +In the table three rows of query text will be shown. +To see the whole query if the query is longer, press the *View more* button under the query text. + +== Limitations + +Query logs are available for a period of 7 days, and each request can be for up to 24 hours of data. + From fa25268ab80e8b22356111c133e981379bc16c3d Mon Sep 17 00:00:00 2001 From: David Johansson Date: Mon, 1 Jul 2024 14:53:25 +0200 Subject: [PATCH 02/10] Comment fixes --- .../pages/platform/logging/query-log-analyzer.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index df2003986..80e98170b 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -17,9 +17,9 @@ Query log analyzer is split up in two parts, a timeline and a table with two tab * *Query timeline* - Timeline showing metrics for number of queries, failed queries and query latency. * *Summary* - An aggregated view of query logs, giving a high level overview over the selected time period. -* *Details* - A detailed view showing individual query execution in the selected time period. +* *Details* - A detailed view showing individual query executions in the selected time period. -To fetch logs first choose a time range in the Query timeline. +To fetch logs, first choose a time range in the Query timeline. With a time selection done, press the *Fetch logs* button. You may optionally choose any filters or search text if required, then press *Go*. @@ -39,11 +39,11 @@ When viewing the query timeline, you can select from the following time interval * Last 3 days * Last week - === Zoom To zoom in to a narrower time interval, select and drag inside any chart to select your desired time interval. -The data will automatically update to match the increased resolution. +The data in the timeline will automatically update to match the increased resolution. +To update the table, a new request would be required with the *Fetch logs* button. To reset zoom, double-click anywhere inside the chart. @@ -61,7 +61,7 @@ To sort by a column (such as Max Time ms) click on the column heading. === Modify columns The columns in the table can be modified by clicking the button to the right of the column row. -Columns can be [en|dis]abled or the order changed using the grid icon at the top right of the table. +Columns can be enabled or disabled, or the order changed using the grid icon at the top right of the table. === Expand query From d9f06090d62c926a9de5a0f7404dd7888d7be798 Mon Sep 17 00:00:00 2001 From: David Johansson Date: Mon, 1 Jul 2024 14:56:04 +0200 Subject: [PATCH 03/10] Consistency changes --- modules/ROOT/pages/platform/logging/query-log-analyzer.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index 80e98170b..6a6276e64 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -41,15 +41,15 @@ When viewing the query timeline, you can select from the following time interval === Zoom -To zoom in to a narrower time interval, select and drag inside any chart to select your desired time interval. +To zoom in to a narrower time interval, select and drag inside the timeline to select your desired time interval. The data in the timeline will automatically update to match the increased resolution. To update the table, a new request would be required with the *Fetch logs* button. -To reset zoom, double-click anywhere inside the chart. +To reset zoom, double-click anywhere inside the timeline. === Toggle data series -To hide or show individual data series, select the corresponding data series in the legend below the chart. +To hide or show individual data series, select the corresponding data series in the legend below the timeline. == Table interactions From 500900ce019a053e3992696bb5235e14dc4b4902 Mon Sep 17 00:00:00 2001 From: David Johansson Date: Mon, 1 Jul 2024 14:57:02 +0200 Subject: [PATCH 04/10] Update modules/ROOT/pages/platform/logging/query-log-analyzer.adoc Co-authored-by: Sebastian Fabian --- modules/ROOT/pages/platform/logging/query-log-analyzer.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index 6a6276e64..45f2ceb9a 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -43,7 +43,7 @@ When viewing the query timeline, you can select from the following time interval To zoom in to a narrower time interval, select and drag inside the timeline to select your desired time interval. The data in the timeline will automatically update to match the increased resolution. -To update the table, a new request would be required with the *Fetch logs* button. +To update the table, click the *Fetch logs* button. To reset zoom, double-click anywhere inside the timeline. From 12c575cd90edea8eed0d87e802526985f81c590e Mon Sep 17 00:00:00 2001 From: David Johansson Date: Mon, 1 Jul 2024 15:01:51 +0200 Subject: [PATCH 05/10] fixup --- modules/ROOT/pages/platform/logging/query-log-analyzer.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index 45f2ceb9a..fcf42e6ea 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -27,7 +27,7 @@ A summary of query executions is returned, showing aggregations per query. To see the individual query executions, click the right arrow at the end of the line to show details for that query. The details pane shows individual executions. -== Chart interactions +== Timeline interactions When viewing the query timeline, you can select from the following time intervals: @@ -39,6 +39,8 @@ When viewing the query timeline, you can select from the following time interval * Last 3 days * Last week +The query timeline can be collapsed by clicking on the header. + === Zoom To zoom in to a narrower time interval, select and drag inside the timeline to select your desired time interval. From 2bef5822d0996598d1da96abe1b6c4e381cbe67b Mon Sep 17 00:00:00 2001 From: David Johansson Date: Tue, 2 Jul 2024 10:57:14 +0200 Subject: [PATCH 06/10] Add section on fetch logs --- .../platform/logging/query-log-analyzer.adoc | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index fcf42e6ea..6719bb224 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -53,6 +53,32 @@ To reset zoom, double-click anywhere inside the timeline. To hide or show individual data series, select the corresponding data series in the legend below the timeline. + +== Fetch logs + +The *Fetch logs* button will open up a dialog where you can add filters and search before fetching the logs. +The Query timeline determines the current time selection, which can be changed by closing the dialog and modifing the timeline. +To fetch the logs after selection of filters and search is done, click the *Go* button. + +=== Filters + +To filter, click the filter button. +This will load the available filters over the selected time period. +Filters are available for the following fields: + +* Status +* User +* Driver +* Application +* Initiation type + +=== Search + +To search, click the search button. +Search can be specified for the *Query text* and the *Error text*. +The fields are case insensitive and allows you to find specific queries or error that are interesting. + + == Table interactions === Sort table From 17c50be503117b8aa5744f1efa713569bceedb7b Mon Sep 17 00:00:00 2001 From: David Johansson Date: Tue, 2 Jul 2024 11:59:26 +0200 Subject: [PATCH 07/10] Add more limitations --- modules/ROOT/pages/platform/logging/query-log-analyzer.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index 6719bb224..da0334987 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -98,5 +98,6 @@ To see the whole query if the query is longer, press the *View more* button unde == Limitations -Query logs are available for a period of 7 days, and each request can be for up to 24 hours of data. +* Query logs are available for a period of 7 days, and each request can be for up to 24 hours of data. +* The Query timeline may show activity from internal meta queries, which are filtered in the table. From 8f7ec1a6050b2cb5941c3736f32d2407efed8368 Mon Sep 17 00:00:00 2001 From: David Johansson Date: Tue, 2 Jul 2024 14:24:14 +0200 Subject: [PATCH 08/10] Clarification --- modules/ROOT/pages/platform/logging/query-log-analyzer.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index da0334987..cdb82deca 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -13,11 +13,11 @@ To access *Query log analyzer*: . Select the *Logs* tab. . Select the *Query log analyzer* button. -Query log analyzer is split up in two parts, a timeline and a table with two tabs: +Query log analyzer is split up in three parts: * *Query timeline* - Timeline showing metrics for number of queries, failed queries and query latency. -* *Summary* - An aggregated view of query logs, giving a high level overview over the selected time period. -* *Details* - A detailed view showing individual query executions in the selected time period. +* *Summary table* - An aggregated view of query logs, giving a high level overview over the selected time period. +* *Details table* - A detailed view showing individual query executions in the selected time period. To fetch logs, first choose a time range in the Query timeline. With a time selection done, press the *Fetch logs* button. From 2854c0e485db46e5326d265fc98b49b0b51dcf0d Mon Sep 17 00:00:00 2001 From: David Johansson Date: Tue, 2 Jul 2024 14:36:18 +0200 Subject: [PATCH 09/10] Update modules/ROOT/pages/platform/logging/query-log-analyzer.adoc Co-authored-by: Sebastian Fabian --- modules/ROOT/pages/platform/logging/query-log-analyzer.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc index cdb82deca..0259dcd9f 100644 --- a/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc +++ b/modules/ROOT/pages/platform/logging/query-log-analyzer.adoc @@ -99,5 +99,5 @@ To see the whole query if the query is longer, press the *View more* button unde == Limitations * Query logs are available for a period of 7 days, and each request can be for up to 24 hours of data. -* The Query timeline may show activity from internal meta queries, which are filtered in the table. +* The query timeline may show activity from internal meta queries, which are filtered in the table. From a8fbf192e6a3f00ca5857e524c361fb40b44f9bc Mon Sep 17 00:00:00 2001 From: David Johansson Date: Tue, 2 Jul 2024 15:30:52 +0200 Subject: [PATCH 10/10] fixup --- modules/ROOT/content-nav.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 007f4595d..4ae22b64f 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -22,7 +22,6 @@ Generic Start ** xref:platform/logging/log-forwarding.adoc[] ** xref:platform/logging/query-log-analyzer.adoc[] - * Neo4j connectors ** xref:platform/connectors/spark.adoc[] ** xref:platform/connectors/kafka.adoc[]