Skip to content

Commit 651b73e

Browse files
DOCSP-16444 doc for query log download UI (#164)
* DOCSP-16444 doc for query log download UI DOCSP-16444 doc for query log download UI * DOCSP-16444 updates for review feedback * Apply suggestions from code review Co-authored-by: Melissa Mahoney <[email protected]> * DOCSP-16444 fix file name Co-authored-by: Melissa Mahoney <[email protected]>
1 parent f097f29 commit 651b73e

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
level: 4
2+
ref: download-query-logs-step1
3+
source:
4+
file: steps-data-lake-deploy-source.yaml
5+
ref: data-lake-log-in
6+
---
7+
level: 4
8+
ref: download-query-logs-step2
9+
source:
10+
file: steps-data-lake-deploy-source.yaml
11+
ref: data-lake-left-nav
12+
---
13+
title: "Click :icon-mms:`ellipsis` for your {+dl+} and select
14+
:guilabel:`Download Logs` from the dropdown."
15+
level: 4
16+
ref: download-query-logs-step3
17+
---
18+
title: "Select the :guilabel:`Time Period` for which you want to
19+
download logs from the dropdown."
20+
level: 4
21+
ref: download-query-logs-step4
22+
content: |
23+
Choose one of the following time periods:
24+
25+
- :guilabel:`Last 4 Hours`
26+
- :guilabel:`Last 8 Hours`
27+
- :guilabel:`Last 12 Hours`
28+
- :guilabel:`Last 24 Hours`
29+
- :guilabel:`Custom Date`
30+
---
31+
title: "Click :guilabel:`Download Logs` and follow your browser
32+
prompts to download the file."
33+
level: 4
34+
ref: download-query-logs-step5
35+
content: |
36+
The downloaded log filename is in the following format:
37+
38+
.. code-block:: shell
39+
:copyable: false
40+
41+
<data-lake-name>_<start-date>_<end-date>_queries.log.gz
42+
...

source/query/download-query-logs.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _query-logs:
2+
3+
===================
4+
Download Query Logs
5+
===================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
You can download logs of your {+dl+} queries from the |service| user
16+
interface. You can view the logs to determine information such as:
17+
18+
- The number and type of executed queries.
19+
- The number of scanned documents.
20+
21+
The log is in JSON format and available as a ``.gz`` file. {+adl+}
22+
retains the logs for up to 30 days. By default, the logs are generated
23+
in |utc| format. You can modify the time zone in the :guilabel:`User
24+
Preferences` page to generate and download the logs in your time zone.
25+
You can generate logs for:
26+
27+
- The last four, eight, twelve, or twenty-four hours.
28+
- A specific date and time period.
29+
30+
Required Permissions
31+
--------------------
32+
33+
To download {+adl+} query logs, you must have the
34+
:authrole:`Project Data Access Read Only` or higher role.
35+
36+
Procedure
37+
~~~~~~~~~
38+
39+
To download query logs:
40+
41+
.. include:: /includes/steps/download-query-logs.rst

source/query/query-data-lake.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,3 +395,4 @@ again.
395395
/admin/determine-query-status
396396
/admin/terminate-running-query
397397
/query/view-query-history
398+
/query/download-query-logs

0 commit comments

Comments
 (0)