Skip to content

Logs download #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: console
Choose a base branch
from
Open

Logs download #683

wants to merge 2 commits into from

Conversation

fiquick
Copy link
Collaborator

@fiquick fiquick commented May 7, 2025

No description provided.

@fiquick fiquick changed the title docs magic touch Logs download May 7, 2025
@fiquick fiquick requested a review from AlexicaWright May 7, 2025 13:31
Copy link
Collaborator

@AlexicaWright AlexicaWright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments and suggestions. Well done!

@@ -11,43 +11,48 @@
label:AuraDB-Professional[]
label:AuraDB-Virtual-Dedicated-Cloud[]

Both *Query log analyzer* and *Security log analyzer* allow you to download the fetched logs.
The downloaded logs account for any filters and search that have been applied.
Downloading logs requires a project role of either _{role-project-admin}_ or _{role-project-member}_.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Downloading logs requires a project role of either _{role-project-admin}_ or _{role-project-member}_.
Downloading logs requires a role of either _{role-project-admin}_ or _{role-project-member}_.

The downloaded logs account for any filters and search that have been applied.
Downloading logs requires a project role of either _{role-project-admin}_ or _{role-project-member}_.

You can download logs from the *Query log* and the *Security log*.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can download logs from the *Query log* and the *Security log*.
You can download Query logs and Security logs.

====
Downloading logs requires a project role of either _{role-project-admin}_ or _{role-project-member}_.
====
== Initiate logs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Initiate logs
== Initiate download

Alternatively, you could maybe say "Request log"


== Initiate download
Each request is up to {max-request-hours} hours of data and a maximum of {max-download-rows} rows.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Each request is up to {max-request-hours} hours of data and a maximum of {max-download-rows} rows.
You can request a log for up to {max-request-hours} hours of data and a maximum of {max-download-rows} rows.


To initiate a download, after fetching the logs, use the _Initiate log download_ icon button (Arrow Down Tray Icon) in the top right corner of either the Summary or Details table.
Select the following options in the dialog:
After fetching logs, use the *Initiate logs download* button (arrow down tray icon) in the top right corner of the *Summary* and *Details* table.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After fetching logs, use the *Initiate logs download* button (arrow down tray icon) in the top right corner of the *Summary* and *Details* table.
After fetching logs, use the *Initiate logs download* button in the top right corner of the *Summary* and *Details* table.


*Confirm* starts the download.
When the requested log is ready, it appears in the *Downloads archive.*
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit weird since the log isn't actually downloaded at this point. But that's a UI problem.

*Confirm* starts the download.
When the requested log is ready, it appears in the *Downloads archive.*

== Download log
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Download log
== Download log

== Download log

Download logs from the *Downloads archive*.
When the status is Ready, select the Download icon to download the file.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When the status is Ready, select the Download icon to download the file.
When the status is Ready, use the Download icon to download the file.

Download logs from the *Downloads archive*.
When the status is Ready, select the Download icon to download the file.

Logs are provided as a zipped file in your chosen format (JSON or CSV), containing the same fields shown in the Field Name columns of the Summary and Details tables above.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Logs are provided as a zipped file in your chosen format (JSON or CSV), containing the same fields shown in the Field Name columns of the Summary and Details tables above.
Logs are provided as a zipped file of your selected format (JSON or CSV).

== Download the file
== Downloads archive

To access the archive click the *Open downloads archive* icon (Document Text icon) in the top-right corner of the page.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To access the archive click the *Open downloads archive* icon (Document Text icon) in the top-right corner of the page.
To access the archive click the *Open downloads archive* icon in the top-right corner of the page.

Instead of trying to describe it, maybe we should have s screenshot?

@neo4j-docops-agent
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-aura-683.surge.sh

Updated pages:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants