3 Maintaining the System
In general, use the following procedure:
-
Stop processing by entering the following command as the
RUEI_USER
user:project -stop
-
Perform the maintenance as described in the relevant section.
-
Restart processing by entering the following command as the
RUEI_USER
user:project -start
Disabling Modification to Administrators' Properties
By default, users with Administrator permissions can change the properties of other Administrators, as well as create and delete Administrator user accounts. If this is not consistent with your security requirements, you can disable this functionality by running the following command:
execsql config_set_value wi_core user_mgmt_admin_edit_admins 0
Increasing the Linux Socket Memory Allocation Limit
The underlying Linux socket interface used by the Collector for monitoring traffic has a memory allocation limit of 20KB. This limit can be exceeded when a large number of network filters (or VLAN definitions) are configured. If limit exceeds, the following error is reported in the Event log:
linux.c, 326,cap_dev_set_filter()]: setsockopt(): Cannot allocate memory
To increase this limit, do the following:
-
Login to the required Collector system as the
root
user. -
Run the following command to increase the underlying limit:
/sbin/sysctl -w net.core.optmem_max=65535
-
To make this setting persistent across reboots, add the following line to the
/etc/sysctl.conf
file:net.core.optmem_max=65535
Backing up a RUEI Deployment
RUEI does not provide dedicated database backup and recovery functionality. Instead, it relies on standard Oracle database functionality. This is described in the Oracle Database Backup and Recovery User's Guide, available at http://docs.oracle.com/cd/B28359_01/backup.111/b28270/toc.htm
.
Important
Regardless of the backup method you use, it is recommended that you first stop RUEI data processing. Unless you do so, the integrity of the backed up data cannot be guaranteed. To stop RUEI data processing, run the following command as the RUEI_USER
user:
project -stop
This procedure may take several minutes, and any data being processed at the time of the stop command will be lost. However, traffic monitoring continues, and is written to log files that will be committed to the database once processing is resumed.
After the backup is complete, restart the processing by running the following command:
project -start
Backing up RUEI Configuration Data
In addition to the database, RUEI configuration data should also be backed up. The following procedure helps to extract configuration data from both the database as well as the file system, and writes it to the file system where it can be picked up for further backup to a suitable storage device.
-
Login to the Reporter system as the
RUEI_USER
user, and run the following command:project -save
By default, this stores the backup data at
RUEI_DATA
/processor/backup
. An alternate location can be specified using the–file
directive. For example, to store to the location/tmp/backup
, run the following command:project -save --file=/tmp/backup/backup.tar.gz
-
To restore an earlier backup, run the following command:
project -restore /tmp/backup/backup.tar.gz
Backing up Session Diagnostic Data
One of the major strengths of RUEI is its ability to diagnose individual user sessions for slow performance or problem pages. This functionality relies on log files that are stored outside of the RUEI database. In order to allow access to Session Diagnostics functionality, this data also needs to be available during a restore. Backup the contents of the RUEI_DATA
/processor/data
directory.
Replay content is the data required to replay error pages or the full content of a session. Backup of this data depends on your requirements. That is, if there is a need to replay session content on a regular basis. Replay content can be easily backed up from the file system. The relevant directories are $APPSENSOR_HOME
/*/REPLAY
. The default location is RUEI_DATA
/collector/wg/REPLAY
. The entire directory (and all sub-directories) should be backed up.
The directories indicated above must be backed for each required Collector system. In a distributed environment, the backup may have to be performed on multiple systems.
Restoring a RUEI Deployment Backup
To restore a RUEI deployment from scratch, do the following:
-
Install the RUEI software. For more information, see Oracle Real User Experience Insight Installation Guide.
-
Restore the database content for the selected backup approach. For information, see Oracle Database Backup and Recovery User's Guide.
-
To restore the RUEI configuration information, run the following command:
project -restore --all
backup-file-location
Where,
backup-file-location
specifies the location of the backed-up data. -
Restore the RUEI Session Diagnostics information by restoring the contents of the
RUEI_DATA
/processor/data
directory. -
Stop the Collector by running the following command as the RUEI_DATA user:
appsensor stop wg
-
For each required Collector system, restore the replay content to the location
$APPSENSOR_HOME
/*/REPLAY
. -
Start the Collector by running the following command as the
RUEI_DATA
user:appsensor start wg
Moving RUEI Datafiles to a New Location
There might be a requirement to move the database data files to a new location. For example, because the current mount point or directory is running out of space. The following procedure assumes that the database is running on the Reporter system, and the default installation paths are being used. For more information, see Oracle Real User Experience Insight Installation Guide.
Complete the following steps:
-
Log in to the Reporter system as the
RUEI_USER
user. -
Stop the database and processing by running the following command:
project -stop/etc/init.d/oracledb stop
-
Prepare the new mount running the following commands:
mkdir -p /oradata/ux/ chown oracle:oinstall -R /oradata
-
Copy the datafiles as the
oracle
user by running the following commands:cd /u01/app/oracle/oradata mv ux/* /oradata/ux rm -f ux ln -s /oradata/ux ux
-
Restart the database and processing by running the following commands:
# /etc/init.d/oracledb start # su -
RUEI_USER
$ project -start
Managing Users
You can create and manage user accounts by using Reporter interface in RUEI.
Creating Users
To create a new user account, run the following commands:
set serveroutput on exec dbms_output.put_line (uxs_users.create_user('name', 'full-name
', 'mail-address
', 'authentication
', 'access-level
', [ADM|SEC|EM_ACCESS => 1]));
Where:
-
name specifies the user name by which the user will be known within the RUEI installation.
-
full-name
specifies the user's full name. -
mail-address
specifies the user's E-mail address. This is the address to which reports and E-mail alerts will be sent. Ensure that this is correct. -
authentication
specifies whether the user is authenticated against a configured LDAP (ldap
) or Oracle SSO (osso
) server. -
access-level
specifies the Business and IT access-level permissions to be assigned to the user. This must be0
(Full),1
(Analytical),2
(Inquiry),3
(Overview), or4
(None). -
Optionally, additional privileges can be assigned to the user. These are
ADM
(Administrator), SEC (Security Officer), orEM_ACCESS
(Oracle Enterprise Manager access).
For example:
exec dbms_output.put_line(uxs_users.create_user('Jan', 'Jan Janssen', 'jan.janssen@test.com', 'ldap', '0', ADM => 1, SEC => 1));
The command will report an error message with the return code -1 if addition of the user account failed; 1 if successful.
Updating Users
To update a user account, issue the following commands:
set serveroutput on exec dbms_output.put_line(uxs_users.update_user('current_name','new_name','new_full_name', 'new_mail-address
', 'new_authentication
' ,'new_access-level
', [ADM|SEC|EM_ACCESS => 1])); exec dbms_output.put_line (uxs_users.create_user('name', 'full-name
', 'mail-address
', 'authentication
', 'access-level
', [ADM|SEC|EM_ACCESS => 1]));
Where:
-
current_name specifies the user name of the existing user that you want to update.
-
new_name specifies the modified user name by which the user will be known within the RUEI installation.
-
new_full-name
specifies the user's full name. -
new_mail-address
specifies the user's E-mail address. This is the address to which reports and E-mail alerts will be sent. Ensure that this is correct. -
new_authentication
specifies whether the user is authenticated against a configured LDAP (ldap
) or Oracle SSO (osso
) server. -
new_access-level
specifies the Business and IT access-level permissions to be assigned to the user. This must be0
(Full),1
(Analytical),2
(Inquiry),3
(Overview), or4
(None). -
Optionally, additional privileges can be assigned to the user. These are
ADM
(Administrator), SEC (Security Officer), orEM_ACCESS
(Oracle Enterprise Manager access).
The command will report an error message with the return code -1 if update of the user account failed; 1 if successful.
Deleting Users
To delete a user, run the following command:
exec dbms_output.put_line(uxs_users.delete_user('name
'));
Where, name specifies the user name by which the user is known within the RUEI installation.
Modifying Browser JS Library API Keys
If you define Browser JS Library settings as described in the Identifying and Reporting Web Pages chapter of the RUEI User's Guide, an API key is automatically created. To modify an API key, do the following:
Note:
Before attempting to modify the API key, make sure that the associated application is enabled.
-
List all RUEI applications and the association application ID by running the following command:
execsql get_matches
-
Note the application ID for the application you want to modify.
-
Set the API key by running the following command:
execsql config_set_api_key application_ID API_key
Where, application_ID is the application ID you noted in step 2 and API_key is the new value for the API key.
Uploading Named Clients from file
You can now upload named clients from file through a new command line tool upload-named-clients.
Usage:
upload-named-clients [options] -f <named_clients_file>
Options:
-r clear existing entries
The format of the named_clients_file
should be:
<ip_range>\t<client_group>\t<client_name> per line
Increasing SSHD MaxStartups on collector systems
When syncing collector log files to the reporter system on a busy collector system or if the collector system experiences a lower SSH throughput, the reporter displays a warning about the failure to sync data from that specific collector, or unexpected connection termination.
To increase SSHD MaxStartups on collector systems, do the following:
-
On the affected collector system as the
root
user, edit the file/etc/ssh/sshd_config
. -
Uncomment the line that reads
#MaxStartups 10:30:100
(remove the hash tag), and change theMaxStartups
value to30
. -
Save the changes and restart the
SSH
daemon by runningservice sshd restart
command as theroot
user.