Creating a Log Server

A log server is used to record logs about the web services running on Apinizer.

Step 1: Creating a Log Server

  • To define a log server, you must select the “Log Server” option while creating a server in the new server screen

    Log Creation Form

  • The Server Name and Host Name/ IP Address fields should be filled with the right info for your environment.

All the fields and their explanations are given in the below table:

General Settings
Operating System The server’s operating system
Server Name Unique server name
Host Name/ IP Address Server’s host name or IP address
Port Port number the server will service from
Log Level Level of logging detail
Connection Settings for Install
Server Connection Type How should we connect to the server
Installation Directory Directory where the server should be installed in
Performance Settings
Initial Memory JVM minimum stack size in megabytes
Maximum Memory JVM maximum stack size in megabytes
Other settings. Properties that are wanted in the start parameters of the log server can be added here. The parameter should be saved as key and value. The key’s name should start with -E. The -Ethread_pool.index.queue_size=500 and -Ethread_pool.write.queue_size=500 parameters are added by default. The -Ethread_pool.index.queue_size property determines the count of requests that are queued during indexing or deleting operations. The -Ethread_pool.write.queue_size property determines the count of requests that are queued if they are writing, indexing, updating or deleting of multiple files in a single request. The count of the requests that are queued can be determined by Number of Shards x Amount of Simultaneous Requests. This setting both increases the performance of logging to the database and reduces any potential data loss. After the key and value of the property is added the Save button can be used to apply it. Likewise, it can be deleted with the Delete button.
Log Server Settings
ES Http Port It is the port number that is communicated via HTTP with the Log Instance.
ES Transport Tcp Port The port that the ES nodes will communicate. Can be a single value or a range. If a range is given the nodes will use the first available port.
ES Master Node If a node’s node.master property is set to true this node will become the master node.
ES Data Node If a node’s node.data property is set to true this node will become the data node. Data nodes are the nodes that hold data and do CRUD, search and combination operations on them.
ES Data Path If you’re using .zip or .tar.gz files, data and log files will be kept under the $ES_HOME directory. If these important files are left in their default location, there is a risk of them being deleted when ES is updated.
ES Log Path If you’re using .zip or .tar.gz files, data and log files will be kept under the $ES_HOME directory. If these important files are left in their default location, there is a risk of them being deleted when ES is updated.
ES Repo Path The repo path of ES
  • After the necessary values are entered the “Save and Verify” button should be clicked to save the changes.
When defining a log server, the below requirements must be met:
  • The server name must be unique.
  • The hostname/ IP Address should be available.
  • The Log Transport Port and Log HTTP Ports should be available.
  • The directory shouldn’t be occupied by another server.

Step 2: Setting up Log Server

  • Once the Save and Verify button is clicked, info about verification will appear on the right side of the page.
    • The checks that are complete will be marked with green check marks.
    • When all conditions are met, the Start Automatic Install buttons will become available