.. _cloud-up-logs:

~~~~~~~~~~~~~~
Logs & Reports
~~~~~~~~~~~~~~~

The **Logs & Reports** area lets you inspect the debug logs produced by your license
servers and control how long report logs are retained. You reach it from **Logs &
Reports** in the left sidebar.

####################
Debug Logs
####################

The Logs page lists all of your license servers in a table with **Server Name** and
**Host** columns. A **Search** box filters the list by server name, and a **Host**
filter narrows the list to a single server machine. Two tabs appear at the top of the
page: **Debug Log** and **Report Log**.

.. TODO: screenshot

Viewing a debug log
*******************

Pressing **View** (requires **View**) opens the selected server's live debug log
inline, directly in the portal. Very large logs are not shown in full: only the most
recent portion of the log is displayed, and a notice indicates that the log was
truncated and that you should download the full file to see all of its content.

.. note:: The debug log is read live from the running license server. If the server
	cannot be reached, or if it has no debug log yet, the portal reports that no debug
	log is available.

Downloading and deleting a debug log
************************************

* **Download** (requires **Manage**) saves the server's debug log to a file on your
  computer.
* **Delete** (requires **Manage**) clears the server's debug log. You are asked to
  confirm before the log is removed. Once you confirm, a new log cycle begins
  automatically on the server, and the deletion is recorded in the
  :ref:`Audit Log <cloud-up-administration>`.

.. note:: Report-log viewing is forthcoming. The **Report Log** tab appears on the Logs
	page but is not yet enabled; this release supports viewing and managing debug logs
	only. Report logs are still collected and rotated automatically (see below), and you
	can run usage reports from the reporting area.

------

.. _cloud-up-report-logs:

####################
Report Logs
####################

------

The report logs are listed to the right of the debug logs for each of your license servers in RLM
Cloud. For more details on the report log format, see :ref:`reportlog-format`.

Viewing and saving a report log
*******************************

Pressing **View** (requires **View**) opens the selected server's report log, starting at the end
of the log (the most recent entries).

Clicking **Save** (requires **Manage**) will save the full report log to your local machine.

Switching and resetting the report log
**************************************

Clicking **Switch** (requires **Manage**) will open the **Switch Report Log** modal with a default
name pre-filled; a custom name for the report log may optionally be enetered. Clicking **Switch**
will start a new report log using the name that was entered into the modal. The previous report log
may be viewed by clicking the **List** button.

Clicking **Reset** (requires **Manage**) will set the report log back to it's default name. The 
server will truncate the existing log and redirect reporting to the new log. Click **Yes** to 
confirm or **Cancel** to abort the operatino.

Listing and deleting report logs
********************************

Click **List** to view the current and previous report logs within the retention period set in your
RLM Cloud environment (see :ref:`cloud-up-report-log-retention`). From this menu, you may **View**,
**Save**, and **Delete** the report logs. The view and save behavior is the same as described above.
Clicking **Delete** will present you with a confirmation window; click **Yes** to confirm the 
delete, or **Cancel** to abort the operation.


.. _cloud-up-report-log-retention:

####################
Report Log Retention
####################

RLM Cloud rotates your report logs daily, automatically. You do not need to schedule or
trigger rotation yourself.

An **Admin** user controls how long rotated report logs are kept before they are removed.
This setting lives at **Admin** > **General** > **Customization**, under **Report Log
Processing**. Enter the number of days to retain report logs — any value from **0** to
**1825** (the default is **90**) — and save. Saving pushes the new retention period to
your active license servers.

.. TODO: screenshot

.. note:: Keeping report logs for at least a couple of days ensures that nightly report
	summarization has data to process. A value of 0 disables retention-based pruning.

The configuration of report-log retention is part of the Admin area; see
:ref:`cloud-up-administration` for the full Admin section.