Skip to main content

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.

Screen overview

image.png

Related objects

    Standard attributes

    Synchronization servers

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

    💻 Image

    image.png

    Sync server status

    The graph of agent status shows the number of agents connected (green light) and the number of agents disconnected (red light).

    Attributes:

    • "Name": syncserver name in bold type
    • URL : URL of the syncserver
    • "Circle of agents": graph that visually indicates how many agents are enabled. The colours indicate which agents are active and which ones could not be started due to an error.
    💻 Image

    image.png

    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.

    Agent list attributes:

    • Agent: Name of the agent
    • Tasks : Number of tasks not finished (peding, ongoing and tasks with error)
    • Status: Connected or disconnected
    • URL agent: local (internal syncsever synchronization) or the URL of the syncserver confgured

    Task list attributes (also task attributes):

    • URL agent: local (internal syncsever synchronization) or the URL of the syncserver confgured
    • Error: message description when the agent has an error and it is disconnected
    • Task: name of the task to be executed, there are many types, the most common being the following
      • UpdateUser
      • UpdateUserAlias
      • UpdateUserPassword
      • UpdateGroup
      • UpdateRole
      • UpdateHost
      • UpdateNetworks
    • Priority: priority of the task
      • 1: high priority
      • 2: low priority
    • Executions: number of executions not finished due to any error
    • Executions time: last execution
    • Message: error message from the last execution
    • Scheduled: next scheduled execution
    💻 Image

    image.png

    image.png

    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.

    Image

    image.png

    View details

    Display the details of the sync server. Here you can check the version of the sync server.

    Attributes:

    • Version: version of the syncserver
    • Jetty: status of the jetty process
    • SSO Daemon: status of the SSO daemon process
    • Task Generator: status of the task generator process
    • Certificate expiration: expiration date of the certificate
    • Server time: time of the server
    • DB Connections: number of the threads used to connect to the database
    💻 Image

    image.png

    View tasks

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

    The available status for a task are: 

    • DONE (green light).
    • 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, sscheduled 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.

    List attributes:

    • Task: name of the task to be executed, there are many types
    • "List of agents" : there is column for each active agent
    💻 Image

    image.png

    Get log

    In version 4, Soffid allows users to review the logs of the sync server or each of the active agents.

    In addition, debugging can be enabled/disabled for each log, and users can decide whether to view the log in real time or pause it.

    Page attributes:

    • Log file: name of the log to review, there are several posibilities
      • main: generic log of the syncserver, agent logs now are not included
      • master/agent/AGENTNAME: each agent has its own log to impruve the data searches
    • Debug: [Yes/No] to enable or disable the debug
    • Live|pause: to enable to see the log in real time or not
    • View:  to show and hide columns in the table.

    Table attributes:

    • Timestamp: Time of the log (the date is always the current date)
    • Level: level of debug (DEBUG, INFO, WARNING, SEVERE)
    • Message: the log
    • Thread: name of the thread that has managed the log
    • Source: name of the class that has generated the log
    Image

    image.png

    Stats

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

    To use this functionality, you must first schedule the "Feed statistic tables" process on the Scheduled tasks screen.

    💻 Image

    image.png

    Not scheduled tasks

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

    Attributes:

    • Task: name of the task to be executed, there are many types
    • Status: status of the task (at this point HELD)
    💻 Image

    image.png

     

    image.png


    Tasks

    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.

    Actions

    Page actions

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

    Syncserver actions

    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.

    Restart server Allows you to restart the synchronization server. Soffis will ask for your confirmation before performing that action.
    View details Display the details of the sync server.
    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.
    Get log Allows you to display the log trace of the syncserver and agents
    Stats Displays the performance (tasks per minute) graph of the synchronization servers.

    Agents list actions

    Refresh (icon)

    Allow you to refresh the data of the table

    Tasks list actions

    Refresh (icon)

    Allow you to refresh the data of the table

    Download CVS file Allows you to download a CSV file with task list
    Cancel task

    Allows you to cancel all the tasks. Soffid will ask for your confirmation, if you confirm, that task will be canceled.

    Prioritize Allows you to release all the tasks. Soffid will ask for your confirmation, if you confirm, that task will be executed. 
    Get log Open the log page with the specific log of the agent
    Close Close the popup

    Task actions

    Refresh (icon)

    Allow you to refresh the data of the table

    Cancel task

    Allows you to cancel a specific task. Soffid will ask for your confirmation, if you confirm, that task will be canceled.

    Prioritize Allows you to release a specific task. Soffid will ask for your confirmation, if you confirm, that task will be executed. 
    Close Close the popup

    View tasks actions

    Refresh (icon)

    Allow you to refresh the data of the table

    Not scheduled tasks actions

    Refresh (icon)

    Allow you to refresh the data of the table

    Cancel task

    Allows you to cancel a specific task. Soffid will ask for your confirmation, if you confirm, that task will be canceled.

    Release task Allows you to release a task so that it goes to the syncservers task synchronizer and can be executed.