Export Documentation to PDF


Documentation for XpoLog 6.0.x
Documentation for the previous version of XpoLog is available too.

Skip to end of metadata
Go to start of metadata


Configuring XpoLog to Storage

It is highly recommended to configure XpoLog to work against an external storage location / directory. XpoLog requires full permissions (read/write) on this location with direct/fast access.

To configure XpoLog to storage:
  1. Create a folder under the name “XpoLogConfig”.
  2. Go to XpoLog > Settings > General
  3. Select the Use external configuration directory checkbox and type the absolute path into XpoLogConfig – “…/XpoLogConfig/”
    XpoLog saves the information and requests a restart.
  4. Restart XpoLog, and go once again to XpoLog > Settings > General, and ensure that the configuration was saved successfully. 
    XpoLog saves all the information into this external folder.
    Note: It is recommended to back it up occasionally. If you remove your XpoLog version and redeploy, you can always point the new XpoLog instance to this folder to use the existing configuration or for clustering purposes.
    For further information, contact the support team at support@xplg.com

Allocating More Memory to XpoLog (64-bit installations)

It is highly recommended to install XpoLog on a 64 bit OS, which enables higher allocation of memory than the default.

To allocate more memory:
  1. Stop XpoLog.
  2. Edit the file /.../XPOLOG_INSTALL_DIR/XpoLog.lax (Windows) OR /.../XPOLOG_INSTALL_DIR/XpoLog.sh.lax (Linux/Solaris).
  3. Look for -Xmx1024m (default allocation is 1024 MB) and allocate more memory based on the available memory of the machine. For example, to allocate 4096 MB change the value to be -Xmx4096m and save.
    Note: it is recommended to allocate 75% of the machine's memory.
  4. Start XpoLog. 


Setting a default Character Encoding (Optional)

In case XpoLog should be able to support special characters which are different from the machine's default (Especially Chinese, Japanese, Korean, etc.) it is recommended to modify the default encoding as follows.

To change default encoding:
  1. Stop XpoLog.
  2. Edit the file /.../XPOLOG_INSTALL_DIR/XpoLog.lax (Windows) OR /.../XPOLOG_INSTALL_DIR/XpoLog.sh.lax (Linux/Solaris).
  3. Edit the parameter -Dfile.encoding=UTF-8 at the end of the LAX.NL.JAVA.OPTION.ADDITIONAL parameters line to any desired default encoding.
    Note: the encoding can be any of the JAVA supported encoding
  4. Start XpoLog. 

Setting a default locale (Optional)

In case XpoLog should be capable of displaying content in different languages and normalize dates from different regions, it is possible to assign a JVM locale. By default, the JVM locale is the locale of the platform where XpoLog is installed. To override the default JVM locale, you must set the appropriate language and region (country) arguments in XpoLog.

To change default locale:
  1. Stop XpoLog.
  2. Edit the file /.../XPOLOG_INSTALL_DIR/XpoLog.lax (Windows) OR /.../XPOLOG_INSTALL_DIR/XpoLog.sh.lax (Linux/Solaris).
  3. Add the parameters -Duser.language=en_US -Duser.region=en_US at the end of the LAX.NL.JAVA.OPTION.ADDITIONAL parameters line
    Note: The above example is for English US locale, the complete locale list that JAVA supports can be found here: JAVA locale list
  4. Start XpoLog.

Windows Specific - Assign a service account

After installation, XpoLog service is available under the Windows services panel (XpoLogCenter). It is highly recommended, after installation, to assign an account on the service for optimized connectivity between XpoLog and remote log sources over the Windows network. 

To assign a service account:
  1. Go to the Windows Services Panel.
  2. Right click the XpoLogCenter service > Properties
  3. Go to the 'Log On' tab (by default, XpoLog is installed with a Local System Account). Select 'This account' radio button and enter a specific account with sufficient privileges that XpoLog can use to read remote log sources.
  4. Save and restart.

This will allow Administrators adding  logs over the Windows network as if they were local (direct access) using UNC paths: \\<server-name>\<drive-name>$\...\<log> (for example: \\server1\c$\logs\log4j.log{string})

Linux Specific - Allocating Allowed Open Files / Number of Processes 

It is very important to allocate 10,000 allowed open files and allowed number of processes to XpoLog that runs on Linux (default is usually 1024).
The allocation can be done specifically to the user who runs XpoLog: 

To check the limitation for the user who runs XpoLog:
  1. Open SSH terminal to XpoLog's machine and log in using the same user that runs XpoLog (for example, Putty).
  2. Run the command: 'ulimit -n' and then the command: 'ulimit -u'
    The recommended output should be 10000.
To allocate the required number of open files:
  • Log in to the machine that runs XpoLog, as superuser if needed, and edit the file /etc/security/limits.conf, by adding the following line:
    [USER_THAT_RUNS_XPOLOG] - nofile [MAX_NUMBER_OF_FILES]
    Where
    [USER_THAT_RUNS_XPOLOG] is the user who you are using to run the XpoLog process (superuser, if you logged in as such).
    [MAX_NUMBER_OF_FILES] is the new limitation that has to be set to 10000.
    For instance, you can add the line: xpolog - nofile 10000
To allocate the required number of processes:
  • Log in to the machine that runs XpoLog, as superuser if needed, and edit the file /etc/security/limits.conf, by adding the following line:
    [USER_THAT_RUNS_XPOLOG] - nproc [MAX_NUMBER_OF_PROCESSES]
    Where
    [USER_THAT_RUNS_XPOLOG] is the user who you are using to run the XpoLog process (superuser, if you logged in as such).
    [MAX_NUMBER_OF_PROCESSES] is the new limitation that has to be set to 10000.
    For instance, you can add the line: xpolog - nproc 10000

IMPORTANT: After making this change, log out and then log in again so that the changes take effect, verify by getting 10000 as a result of running 'ulimit -n' and 'ulimit -u' again using the same user which runs XpoLog, and then restart XpoLog.

Solaris Specific - Allocating Allowed Open Files 

It is very important to allocate 10,000 allowed open files to XpoLog that runs on Solaris (default is usually 1024). 

To check the limitation for the user who runs XpoLog:
  1. Open SSH terminal to XpoLog's machine and log in using the same user that runs XpoLog (for example, Putty).
  2. Run the command: 'ulimit -a'
    The recommended output should be 10000.
To allocate the required number of open files:
  • Log in to the machine that runs XpoLog, as superuser if needed, and edit the file /etc/security, by adding the following line:
    set rlim_fd_max = [MAX_NUMBER_OF_FILES]
    Where
    [MAX_NUMBER_OF_FILES] is the new limitation that has to be set to 10000.
  • Once the above hard limit is set reboot the system once. You can then increase the value of this property explicitly (up to this limit) using the following command:
    ulimit -n [MAX_NUMBER_OF_FILES]


    IMPORTANT: After making this change, log out and then log in again so that the changes take effect, verify by getting 10000 as a result of running 'ulimit -a' again using the same user which is used to run XpoLog, and then restart XpoLog.

WAR Deployment Specific - Configuring XpoLog to Storage 

It is highly recommended to configure XpoLog that is deployed as a war on an application server to an external configuration directory (storage) - instructions are available at the top of this page.
In case you need to update your XpoLog version, the war file will be replaced and if an external storage is not configured all the data and configuration will be removed.

Red Hat 7 and above

HEL 7, using restart.sh during recycle process no longer work with init.d but with systemd. As result, once recycle kicks in early morning, the systemd process starts it back before XpoLog and results case in which there are 2 processes of XpoLog up simultaneously.To overcome the issue, there is a need to DISABLE the start process of XpoLog in the restart.sh so that the only process that restarts XpoLog will be the systemd service of the REHL.

Steps:
  1. Change restart.sh of XpoLog (located in the install directory), its contents should be:
    #!/bin/sh
    DIR=`dirname $0`

    sh $DIR/runXpoLog.sh stop


  2. Set a service via systemctl:
    -
    Add a file xpolog.service under the path /etc/systemd/system/
    Contents:

    [Unit]
    Description=xpolog Service
    After=network.target

    [Service]
    Type=forking
    NotifyAccess=main
    User=<USER_THAT_RUNS_XPOLOG>
    ExecStart=/<ABSOLUTE_PATH_TO_XPOLOG_HOME>/runXpoLog.sh start
    Restart=always

    [Install]
    WantedBy=multi-user.target
  3. Reload systemctlsystemctl daemon-reload
     
  4.  
    - Ensure XpoLog service is down.

    - Run the following: systemctl stop|start|status xpolog
    - Restart via support console >Advanced > Restart (this operation simulates recycle to verify it is working with the service)

     



  • No labels