Skip to content

Commit de918e5

Browse files
SeBBBeDavidJsson
andauthored
Add page about Query Log Analyzer (#393)
Co-authored-by: David Johansson <david.johansson@neo4j.com> Co-authored-by: David Johansson <david.jsson@gmail.com>
1 parent 2a410e8 commit de918e5

File tree

2 files changed

+104
-0
lines changed

2 files changed

+104
-0
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Generic Start
2020
* Logging
2121
** xref:platform/logging/download-logs.adoc[]
2222
** xref:platform/logging/log-forwarding.adoc[]
23+
// ** xref:platform/logging/query-log-analyzer.adoc[]
2324
2425
* Neo4j connectors
2526
** xref:platform/connectors/spark.adoc[]
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
[[aura-monitoring]]
2+
= Query log analyzer
3+
4+
label:AuraDB-Professional[]
5+
label:AuraDB-Enterprise[]
6+
7+
Query log analyzer is a feature that provides a UI to review the queries executed on an Aura instance.
8+
9+
To access *Query log analyzer*:
10+
11+
. Navigate to the https://console.neo4j.io/?product=aura-db[Neo4j Aura Console] in your browser.
12+
. Select the instance you want to access.
13+
. Select the *Logs* tab.
14+
. Select the *Query log analyzer* button.
15+
16+
Query log analyzer is split up in three parts:
17+
18+
* *Query timeline* - Timeline showing metrics for number of queries, failed queries and query latency.
19+
* *Summary table* - An aggregated view of query logs, giving a high level overview over the selected time period.
20+
* *Details table* - A detailed view showing individual query executions in the selected time period.
21+
22+
To fetch logs, first choose a time range in the Query timeline.
23+
With a time selection done, press the *Fetch logs* button.
24+
You may optionally choose any filters or search text if required, then press *Go*.
25+
26+
A summary of query executions is returned, showing aggregations per query.
27+
To see the individual query executions, click the right arrow at the end of the line to show details for that query.
28+
The details pane shows individual executions.
29+
30+
== Timeline interactions
31+
32+
When viewing the query timeline, you can select from the following time intervals:
33+
34+
* 30 minutes
35+
* Last hour
36+
* Last 2 hours
37+
* Last 6 hours
38+
* Last 24 hours
39+
* Last 3 days
40+
* Last week
41+
42+
The query timeline can be collapsed by clicking on the header.
43+
44+
=== Zoom
45+
46+
To zoom in to a narrower time interval, select and drag inside the timeline to select your desired time interval.
47+
The data in the timeline will automatically update to match the increased resolution.
48+
To update the table, click the *Fetch logs* button.
49+
50+
To reset zoom, double-click anywhere inside the timeline.
51+
52+
=== Toggle data series
53+
54+
To hide or show individual data series, select the corresponding data series in the legend below the timeline.
55+
56+
57+
== Fetch logs
58+
59+
The *Fetch logs* button will open up a dialog where you can add filters and search before fetching the logs.
60+
The Query timeline determines the current time selection, which can be changed by closing the dialog and modifing the timeline.
61+
To fetch the logs after selection of filters and search is done, click the *Go* button.
62+
63+
=== Filters
64+
65+
To filter, click the filter button.
66+
This will load the available filters over the selected time period.
67+
Filters are available for the following fields:
68+
69+
* Status
70+
* User
71+
* Driver
72+
* Application
73+
* Initiation type
74+
75+
=== Search
76+
77+
To search, click the search button.
78+
Search can be specified for the *Query text* and the *Error text*.
79+
The fields are case insensitive and allows you to find specific queries or error that are interesting.
80+
81+
82+
== Table interactions
83+
84+
=== Sort table
85+
86+
By default the table will be sorted on *Count* for *Summary* and *Status* for *Details*.
87+
To sort by a column (such as Max Time ms) click on the column heading.
88+
89+
=== Modify columns
90+
91+
The columns in the table can be modified by clicking the button to the right of the column row.
92+
Columns can be enabled or disabled, or the order changed using the grid icon at the top right of the table.
93+
94+
=== Expand query
95+
96+
In the table three rows of query text will be shown.
97+
To see the whole query if the query is longer, press the *View more* button under the query text.
98+
99+
== Limitations
100+
101+
* Query logs are available for a period of 7 days, and each request can be for up to 24 hours of data.
102+
* The query timeline may show activity from internal meta queries, which are filtered in the table.
103+

0 commit comments

Comments
 (0)