# Monitoring and reporting



# Sync server monitoring

## Description

Soffid provides a monitoring functionality to consult all the information of the different agents and the status of each one of them and the amount of tasks assigned. Consequently, it allows diagnosing possible incidents in a quick and easy way.

This option allows you to manage all the options related to the tasks created according to the configuration of each of the agents.

### Sync server

Shows a list with the URL of all the sync servers that you have configured and the options to perform for every sync server.

<details id="bkmrk-%F0%9F%92%BB-image"><summary>💻 Image</summary>

[![image-1720165127612.png](https://bookstack.soffid.com/uploads/images/gallery/2024-07/scaled-1680-/image-1720165127612.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-07/image-1720165127612.png)

</details>#### Agent Status

The graph of agent status shows the number of agents connected (green light) and the number of agents disconnected (red light). By clicking on the captions you can select if you want to show only the connected agents, only the disconnected agents, or both agents.

<details id="bkmrk-%F0%9F%92%BB-image-0"><summary>💻 Image</summary>

[![image-1710860571986.png](https://bookstack.soffid.com/uploads/images/gallery/2024-03/scaled-1680-/image-1710860571986.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-03/image-1710860571986.png)

</details>#### View Agents

Allows you to access a new window with the information of every single agent. That page shows a list with the information about Agent, Number of the pending tasks, the Status, and the URL of the agent.

If you click one of the agents, Soffid will display all the pending tasks for that agent. If you click on one pending task, you can view the details of that task and you could perform the actions available for that depending on your permissions.

<details id="bkmrk-%F0%9F%92%BB-image-1"><summary>💻 Image</summary>

[![image-1710860669782.png](https://bookstack.soffid.com/uploads/images/gallery/2024-03/scaled-1680-/image-1710860669782.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-03/image-1710860669782.png)

</details>#### View Tasks

Displays a matrix with all the agents configured, all the tasks, and the status of the task for each agent. You can reload the matrix with the updated tasks.

The available status for a task are:

- Done (green light): finished tasks.
- Pending (yellow light).
- Error (red light).

If you click on one error task, Soffid will display the details of that task, the basic data, and the specific data about Execution time, Error message, Scheduled and Log detail, and Soffid will allow you to perform the available actions. If you click on one pending task, you can perform the available actions.

<details id="bkmrk-%F0%9F%92%BB-image-2"><summary>💻 Image</summary>

[![image-1710860692532.png](https://bookstack.soffid.com/uploads/images/gallery/2024-03/scaled-1680-/image-1710860692532.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-03/image-1710860692532.png)

</details>#### Get log

Allows you to download the Sync Server log file.

#### Stats

Displays the performance (tasks per minute) graph of the synchronization servers.

<details id="bkmrk-%F0%9F%92%BB-image-3"><summary>💻 Image</summary>

[![image-1710918775742.png](https://bookstack.soffid.com/uploads/images/gallery/2024-03/scaled-1680-/image-1710918775742.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-03/image-1710918775742.png)

</details>#### Restart server

Allows you to restart the synchronization server that hosts any agent. Soffis will ask for your confirmation before performing that action. If you confirm, the server will be restarted.

#### Additional information

Display the additional information of Soffid

<details id="bkmrk-%F0%9F%92%BB-image-4"><summary>💻 Image</summary>

[![image-1710918843860.png](https://bookstack.soffid.com/uploads/images/gallery/2024-03/scaled-1680-/image-1710918843860.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-03/image-1710918843860.png)

</details>### Tasks

#### Active tasks

Displays a graph with information about the tasks pending to be performed on the different systems.

#### Tasks by server

Displays a graph with information about the tasks for each server.

#### View Agents

Displays a view with a list of agent tasks, regardless of which synchronization server they are running on.

#### Not scheduled tasks

Displays a view with a list not scheduled tasks. At that view, you can cancel and release the held tasks

<details id="bkmrk-%F0%9F%92%BB-image-5"><summary>💻 Image</summary>

[![image-1710918988780.png](https://bookstack.soffid.com/uploads/images/gallery/2024-03/scaled-1680-/image-1710918988780.png)](https://bookstack.soffid.com/uploads/images/gallery/2024-03/image-1710918988780.png)

</details>## Screen overview

[![image-1698999287005.png](https://bookstack.soffid.com/uploads/images/gallery/2023-11/scaled-1680-/image-1698999287005.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-11/image-1698999287005.png)

## Related objects

1. [**Agents**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/agents "Agents")
2. [**Synchronization Servers**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/synchronization-servers)
3. **Tasks**

<div id="bkmrk-actions"><div><div><span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Actions</span></div></div></div>#### Agent actions

<table id="bkmrk-query-allows-to-sear-0"><tbody><tr><td style="width: 140px;">**Get log**</td><td style="width: 669px;">Soffid displays the log trace.

</td></tr><tr><td style="width: 140px;">**Reset**</td><td style="width: 669px;">Allows you to restart the synchronization server that hosts any agent. Soffis will ask for your confirmation before performing that action.</td></tr></tbody></table>

#### Tasks actions

<table id="bkmrk-cancel-task-allows-y"><tbody><tr><td style="width: 140px;">**Cancel task**</td><td style="width: 669px;">Allows you to cancel a specific task. Soffid will ask for your confirmation, if you confirm, that task will be canceled.

</td></tr><tr><td style="width: 140px;">**Prioritize**</td><td style="width: 669px;">Allows you to release a specific task. Soffid will ask for your confirmation, if you confirm, that task will be executed. </td></tr></tbody></table>

<div id="bkmrk--2"></div><div id="bkmrk--3"></div><div id="bkmrk--4"></div><div id="bkmrk--5"></div><div id="bkmrk--6"></div>

# Scheduled tasks

## Description

Schedule tasks display all the automatic tasks defined on Soffid, the scheduling of each task, and information about the last execution. Also, allows administrator users to update the execution of that tasks using a cron pattern and init the execution.

## Screen overview

#### Scheduled tasks list

[![image-1676892983234.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1676892983234.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1676892983234.png)

#### Schedule task detail

[![image-1676893027236.png](https://bookstack.soffid.com/uploads/images/gallery/2023-02/scaled-1680-/image-1676893027236.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-02/image-1676893027236.png)

## Standard attributes

#### Schedule

- **Enabled**: if it is selected (value is Yes), the task will be perform on scheduled defined.
- **Task description**: brief description of the task
- **Month**: number of the month (1-12) when the task will be performed.
- **Day**: number of the day (1-31) when the task will be performed.
- **Hour**: hour (0-23) when the task will be performed.
- **Minute**: minute (0-59) when the task will be performed.
- **Day of week**: number of the day (0-7 where 0 means Sunday) of the week when the task will be performed.
- **Server**: where the agent is running.
- **Start date**: start date and time of the last execution.
- **End date**: end date and time of the last execution.
- **Status**: The available status for a task are: 
    - Done (green light): finished tasks.
    - Pending (yellow light).
    - Error (red light).

For each value of month, day, hour, minute, or day of the week:

- \* means any month, day, hour, minute, or day of week. e.g. \*/5 to schedule every five minutes.
- A single number specifies that unit value: 3
- Some comma separated numbers: 1,3,5,7
- A range of values: 1-5

#### Current execution

- **Start now**: this allows you to launch the task execution.

#### Last execution

- **Status**: The available status for a task are: 
    - Done (green light): task finished.
    - Pending (yellow light): task has been started but it has not finished yet.
    - Error (red light): task could not be executed.
- **Start date**: start date and time of the last execution.
- **End date**: end date and time of the last execution.
- **Execution log**: log trace. Allows you to download the log file.

#### Previous executions

List with the information about the previous executions:

- **Start date**: start date and time of the execution.
- **Status**: status of the execution.
- **Execution**: log of the execution. Allows you to download the log file.

## Actions

#### Scheduled tasks query actions

<table id="bkmrk-query-allows-to-sear-0"><tbody><tr style="height: 27px;"><td style="width: 182px; height: 27px;">**Add or remove columns

</td><td style="width: 627px; height: 27px;">Allows you to show and hide columns in the table.

</td></tr><tr style="height: 35px;"><td style="width: 182px; height: 35px;">**Download CSV file**

</td><td style="width: 627px; height: 35px;">Allows you to download a CSV file with the scheduled tasks.

</td></tr></tbody></table>

#### Scheduled Task detail actions

<table id="bkmrk-apply-changes-allows"><tbody><tr><td style="width: 168px;">**Apply changes**

</td><td style="width: 641px;">Allows you to save the data of scheduled tasks. To save the data it will be mandatory to fill in the required fields.

</td></tr><tr><td style="width: 168px;">**Start now**

</td><td style="width: 641px;">Allows you to launch the task execution.

</td></tr><tr><td style="width: 168px;">**Undo**

</td><td style="width: 641px;">Allows you to undo any changes made.

</td></tr><tr><td style="width: 168px;">**Logs**

</td><td style="width: 641px;">Allows you to download the log file.

</td></tr></tbody></table>

# Scheduled jobs

## Description

Schedule jobs display all the asynchronous tasks generated for the workflows engine. When a job is finished, it will disappear from that list.

## Standard attributes

- **ID**: job identifier.
- **Name**: job name.
- **Process**: process identifier and description.
- **Next Rerun**: date and time scheduled for next execution.
- **Failed Attempts**: number of failed attempts.
- **Status**

<span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Actions</span>

#### Scheduled jobs query actions

<table id="bkmrk-query-allows-to-sear-0"><tbody><tr style="height: 27px;"><td style="width: 182px; height: 27px;">**Add or remove columns

</td><td style="width: 627px; height: 27px;">Allows you to show and hide columns in the table.

</td></tr><tr style="height: 35px;"><td style="width: 182px; height: 35px;">**Download CSV file**

</td><td style="width: 627px; height: 35px;">Allows you to download a CSV file with the information of the scheduled jobs.

</td></tr></tbody></table>

#### Scheduled Task detail actions

<table id="bkmrk-apply-changes-allows"><tbody><tr><td style="width: 168px;">**Resume**

</td><td style="width: 641px;">Allows you to resume the task

</td></tr><tr><td style="width: 168px;">**Hold**

</td><td style="width: 641px;">Allows you to retain the task.

</td></tr><tr><td style="width: 168px;">**Close**

</td><td style="width: 641px;">Allows you to close the window without perform any action.

</td></tr></tbody></table>

# Audit

## Description

The audit trail page allows you to query for audit records. Each action done at the Soffid console will be reported.

Here you have a list of common Advanced searches, you only have to copy, paste and search, e.g.

```
// User changes trace
calendar ge "2020-01-01T00:00:00.000+01:00" AND user co "admin"
 
// User actions trace
calendar ge "2020-01-01T00:00:00.000+01:00" AND author co "admin"
 
// Soffid accounts
calendar ge "2020-01-01T00:00:00.000+01:00" AND user co "admin" AND database co "soffid"
 
// Created accounts
calendar ge "2020-01-01T00:00:00.000+01:00" AND action co "C" AND object co "SC_ACCOUN"
 
// Removed objects
calendar ge "2020-01-01T00:00:00.000+01:00" AND action co "D" AND object co "SC_ACCOUN"

```

<div id="bkmrk-screen-overview"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Screen overview</span></div>[![image-1679557370520.png](https://bookstack.soffid.com/uploads/images/gallery/2023-03/scaled-1680-/image-1679557370520.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-03/image-1679557370520.png)

<div id="bkmrk-custom-attributes"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Custom attributes</span>  
<svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div>- **Date/Time**: date on which the action was performed.
- **Author**: user who launched the task. When the author is empty, the Syncserver launched this task.
- **Purpose**: is the name of the internal object (also the table of the database) which the action was performed.
- **Source IP**
- **User**: identity who performed the action.
- **Information system:**  details on which information system the action was performed.
- **Role**: details the role with which the action was performed.
- **Account**: if the action has taken place on an account, it will be indicated on which one in this section.
- **Group**: details the group with which the action was performed.
- **Action**: the task performed is specified.

## Actions

<table border="1" id="bkmrk-add-or-remove-column" style="border-collapse: collapse; border-width: 1px;"><tbody><tr><td style="width: 173.636px;">**Query**</td><td style="width: 630.909px;">Allows you to query accounts through different search systems, [Quick and Advanced](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/search-types "Search Types").</td></tr><tr><td style="width: 173.636px;">**Add or remove columns**</td><td style="width: 630.909px;">Allows you to show and hide columns in the table.</td></tr><tr><td style="width: 173.636px;">**Download CSV file**</td><td style="width: 630.909px;">Allows you to download a csv file with the information of audit records. </td></tr></tbody></table>

# Access logs

## Description

The access log page allows querying all the information about the opened sessions.

Note that any session that was active during the specified date will be shown, even when it started before of finished after that date.

<div id="bkmrk-screen-overview"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Screen overview</span></div><div id="bkmrk-"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;"><iframe allowfullscreen="allowfullscreen" height="314" src="//www.youtube.com/embed/rnTFtLeyi3k?rel=0" width="560"></iframe>

</span></div><div id="bkmrk--0"></div><div id="bkmrk-custom-attributes"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Custom attributes</span>  
<svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div>- **Type**
- **Protocol**: access protocol. 
    - SSO
    - SAML
    - PAM
    - CONSOLE
- **Start date**: date and time when start the access.
- **End date**: date and time when end the access.
- **Session**: session identifier.
- **Server**
- **Client**
- **User**: user who perform the access.
- **Information**: additional connection information. 
    - When the information is about the Authentication method, there are the following options: 
        - **P**: Password
        - **K**: Kerberos
        - **E**: Broker
        - **O**: OTP
        - **M**: Email
        - **S**: SMS
        - **I**: PIN
        - **C**: Certificate
        - **F**: Finger print
        - **Z**: Push

## Actions

<table border="1" id="bkmrk-add-or-remove-column" style="width: 805px;"><tbody><tr><td style="width: 173.636px;">**Query**</td><td style="width: 630.909px;">Allows you to query accounts through different search systems, [Quick and Advanced](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/search-types "Search Types").</td></tr><tr><td style="width: 173.636px;">**Add or remove columns**</td><td style="width: 630.909px;">Allows to show and hide columns in the table.</td></tr><tr><td style="width: 173.636px;">**Download CSV file**</td><td style="width: 630.909px;">Allows to download a CSV file with the information of access logs. </td></tr></tbody></table>

# Sessions

## Description

The sessions page displays the current open sessions made with ESSO, WSSO or PAM for which the user is the owner.

This functionality allows the owner users, with appropriate privileges, to open and view online a session opened by another user. It also allows them to interact if necessary.

<div id="bkmrk-screen-overview"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Screen overview</span></div><div id="bkmrk-"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;"><iframe allowfullscreen="allowfullscreen" height="314" src="//www.youtube.com/embed/70uv0gVHEsQ?rel=0" width="560"></iframe>

</span></div><div id="bkmrk-custom-attributes"><span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Custom attributes</span><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div>- **User**: name of the user who opened the session.
- **Device:** IP from which the connection was executed.
- **Client**
- **Type**: 
    - ESSO
    - WSSO
    - PAM
- **Service URL:** connection URL
- **Account name**: user account name to connect.

## Actions

<table border="1" id="bkmrk-add-or-remove-column" style="width: 805px;"><tbody><tr><td style="width: 173.636px;">**Add or remove columns**</td><td style="width: 630.909px;">Allows to show and hide columns in the table.</td></tr><tr><td style="width: 173.636px;">**Download CSV file**</td><td style="width: 630.909px;">Allows to download a CSV file with the information of access logs. </td></tr></tbody></table>

# Console log

## Description

That option allows you to look up server logs from the console. The logs are created on the server filesystem.

## Screen Overview

[![image-1679557650561.png](https://bookstack.soffid.com/uploads/images/gallery/2023-03/scaled-1680-/image-1679557650561.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-03/image-1679557650561.png)

## Actions

<table border="1" id="bkmrk-add-or-remove-column" style="width: 805px;"><tbody><tr><td style="width: 173.636px;">**Download** </td><td style="width: 630.909px;">Allows you to download the log file </td></tr></tbody></table>

# Privileged accounts dashboard

{{@343}}

# Search in PAM recordings

{{@339}}

# Issues

## Definition

Soffid provides a tool to manage all issues and allows you to perform the operations available for each type of task. The actions to be performed will depend on each kind of task.

You can find this functionality in the following path:

`Main Menu > Administration > Monitoring and reporting > Issues`

## Screen Overview

#### Issues

[![image-1691074240103.png](https://bookstack.soffid.com/uploads/images/gallery/2023-08/scaled-1680-/image-1691074240103.png)](https://bookstack.soffid.com/uploads/images/gallery/2023-08/image-1691074240103.png)

## Related objects

1. <span class="ILfuVd"><span class="hgKElc">**[User](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/users)**</span></span>
2. [**Accounts**](https://bookstack.soffid.com/books/soffid-3-reference-guide/page/accounts)

## Standard attributes

- **Issue number**: an incremental number to identify the issue.
- **Created on**: date of creation.
- **Issue type**: issue list defined by Soffid.
- **Description**: a brief description of the issue.
- **Times**: number of times the issue has been repeated.
- **Status**: possible task status. There are three available statuses: 
    - **New**
    - Acknowledged
    - <span style="color: #95a5a6;">Solved</span>
- **Exception**: Error occurred
- **jobName**
- **Actor**: owner of this issue.
- **Actions log**: each of the actions that have been carried out on the issue.

{{@1153}}