OS4X Core environment variables - Revision history

Admin at 20:38, 8 December 2020

2020-12-08T20:38:54Z

Admin at 11:40, 9 August 2019

2019-08-09T11:40:46Z

Admin at 08:12, 25 August 2017

2017-08-25T08:12:42Z

Admin at 15:38, 30 April 2012

2012-04-30T15:38:18Z

Admin at 15:37, 30 April 2012

2012-04-30T15:37:52Z

Admin at 20:02, 10 May 2010

2010-05-10T20:02:55Z

Admin: /* Database performance benchmarking */

2010-04-30T08:03:13Z

Database performance benchmarking

Admin at 08:02, 30 April 2010

2010-04-30T08:02:34Z

Admin at 17:54, 6 February 2010

2010-02-06T17:54:11Z

Admin at 17:53, 6 February 2010

2010-02-06T17:53:37Z

@@ Line 22: / Line 22: @@
 *<code>OS4X_DB_SOCKET</code>
 *<code>OS4X_DB_PORT</code>
-*<code>OS4X_DB_TYPE</code>: either "<code>mysql</code>", "<code>DB2</code>" or "<code>sqlite3</code>"
+*<code>OS4X_DB_TYPE</code>: either "<code>mysql</code>", "<code>DB2</code>", "<code>sqlite</code>" or "<code>POSTGRESQL</code>"
 Beginning from OS4X build 2019-08-09, the following variable exists:
 *<code>OS4X_DB_PREFIX</code>: database table prefix

← Older revision		Revision as of 11:40, 9 August 2019
Line 23:		Line 23:
	*<code>OS4X_DB_PORT</code>		*<code>OS4X_DB_PORT</code>
	*<code>OS4X_DB_TYPE</code>: either "<code>mysql</code>", "<code>DB2</code>" or "<code>sqlite3</code>"		*<code>OS4X_DB_TYPE</code>: either "<code>mysql</code>", "<code>DB2</code>" or "<code>sqlite3</code>"
		+
		+	Beginning from OS4X build 2019-08-09, the following variable exists:
		+	*<code>OS4X_DB_PREFIX</code>: database table prefix

@@ Line 12: / Line 12: @@
 *<code>RRDB_DATAPATH</code>: [[OS4X_Core_configuration#RRDB_data_path|RRD data path]]
 *<code>OS4X_WEBGUI_DIR</code>: web interface installation directory
 *<code>CA_FILE</code>: [[OS4X_Core_configuration#root_certificate_file_.26_root_certificate_path|configured absolute path to the root certificate file]]
 *<code>CA_PATH</code>: [[OS4X_Core_configuration#root_certificate_file_.26_root_certificate_path|configured absolute path to the root certificate directory]]

@@ Line 23: / Line 23: @@
 *<code>OS4X_DB_SOCKET</code>
 *<code>OS4X_DB_PORT</code>
-*<code>OS4X_DB_TYPE</code>: either "mysql", "DB2" or "sqlite3"
+*<code>OS4X_DB_TYPE</code>: either "<code>mysql</code>", "<code>DB2</code>" or "<code>sqlite3</code>"

@@ Line 15: / Line 15: @@
 *<code>CA_FILE</code>: [[OS4X_Core_configuration#root_certificate_file_.26_root_certificate_path|configured absolute path to the root certificate file]]
 *<code>CA_PATH</code>: [[OS4X_Core_configuration#root_certificate_file_.26_root_certificate_path|configured absolute path to the root certificate directory]]
 All processes started by OS4X (event scripts, plugins, etc.) have access to these environment variables.

@@ Line 1: / Line 1: @@
 Environment variables are created and/or set by all OS4X binaries, which values are based on the configuration of OS4X. These variables are:
-*<code>OS4X_CFGFILE</code>: [[OS4X_Core_installation#Main_configuration|OS4X main configuration file (absolute path information)]]
+*<code>OS4X_CFGFILE</code>: [[OS4X Core main configuration file|OS4X main configuration file (absolute path information)]]
 *<code>OS4X_IN_DIR</code>: [[OS4X_Core_configuration#data_incoming_directory|incoming data directory]]
 *<code>OS4X_OUT_DIR</code>: [[OS4X_Core_configuration#data_outgoing_directory|outgoing data directory]]

@@ Line 26: / Line 26: @@
 You can set this variable to an absolute filename where OS4X logs all innformation (example: "ksh" or "bash"):
   export OS4X_DB_BENCHMARKLOG=/tmp/db2perf.log
-This file logs the connect and query time for every single database access, resulting in a fast growing file. The content if this file looks like this:
+This file logs the connect and query time for every single database access, resulting in a fast growing file. The content if this file looks like this (using DB2 database abstraction layer, others like MySQL start with "<code>MySQL</code>"):
 <pre>
 DB2 connect: 0.052482 seconds

← Older revision		Revision as of 08:02, 30 April 2010
Line 20:		Line 20:
	*you may start OS4X programs in a shell where this variable is set without using the parameter "<code>-C</code>" for all binaries (because the environment variable points to the correct position of the configfile)		*you may start OS4X programs in a shell where this variable is set without using the parameter "<code>-C</code>" for all binaries (because the environment variable points to the correct position of the configfile)
	*all subsequent processes started by OS4X (like event scripts) don't have to bother about the given configfile (like plugins of OS4X Enterprise).		*all subsequent processes started by OS4X (like event scripts) don't have to bother about the given configfile (like plugins of OS4X Enterprise).
		+
		+	== Database performance benchmarking ==
		+	Available in OS4X 3 Core, an environment variable can be set to log all database access timing information into that given file:
		+	OS4X_DB_BENCHMARKLOG
		+	You can set this variable to an absolute filename where OS4X logs all innformation (example: "ksh" or "bash"):
		+	export OS4X_DB_BENCHMARKLOG=/tmp/db2perf.log
		+	This file logs the connect and query time for every single database access, resulting in a fast growing file. The content if this file looks like this:
		+	<pre>
		+	DB2 connect: 0.052482 seconds
		+	DB2 SQL query: 0.126631 seconds
		+	DB2 connect: 0.032447 seconds
		+	DB2 SQL query: 0.004983 seconds
		+	DB2 connect: 0.029555 seconds
		+	DB2 SQL query: 0.004500 seconds
		+	DB2 connect: 0.031012 seconds
		+	DB2 SQL query: 0.001324 seconds
		+	</pre>

@@ Line 1: / Line 1: @@
 Some environment variables are created and/or set by all OS4X binaries. These variables are:
-*<code>OS4X_CFGFILE</code>: OS4X main configuration file (absolute path information)
+*<code>OS4X_CFGFILE</code>: [[OS4X_Core_installation#Main_configuration|OS4X main configuration file (absolute path information)]]
-*<code>OS4X_IN_DIR</code>: incoming data directory
+*<code>OS4X_IN_DIR</code>: [[OS4X_Core_configuration#data_incoming_directory|incoming data directory]]
-*<code>OS4X_OUT_DIR</code>: outgoing data directory
+*<code>OS4X_OUT_DIR</code>: [[OS4X_Core_configuration#data_outgoing_directory|outgoing data directory]]
-*<code>OS4X_TMP_DIR</code>: temporary data directory
+*<code>OS4X_TMP_DIR</code>: [[OS4X_Core_configuration#temporary_directory|temporary data directory]]
-*<code>OS4X_BIN_DIR</code>: binary program directory
+*<code>OS4X_BIN_DIR</code>: [[OS4X_Core_configuration#binary_installation_directory|binary program directory]]
-*<code>OS4X_SCRIPT_DIR</code>: script installation directory
+*<code>OS4X_SCRIPT_DIR</code>: [[OS4X_Core_configuration#script_installation_directory|script installation directory]]
-*<code>OS4X_BACKUP_DIR</code>: backup directory
+*<code>OS4X_BACKUP_DIR</code>: [[OS4X_Core_configuration#database_backup_directory|backup directory]]
-*<code>RAND_FILE</code>: entropy file for OFTP2 needs
+*<code>RAND_FILE</code>: [[OS4X_Core_configuration#Entropy_file_for_random_data|entropy file for OFTP2 needs]]
-*<code>OPENSSL_BIN</code>: absolute path to openSSL binary
+*<code>OPENSSL_BIN</code>: [[OS4X_Core_configuration#absolute_path_to_.27openssl.27|absolute path to openSSL binary]]
-*<code>RRDTOOL_BIN</code>: absolute path to RRDtools binary
+*<code>RRDTOOL_BIN</code>: [[OS4X_Core_configuration#absolute_path_to_.27rrdtool.27|absolute path to RRDtools binary]]
-*<code>RRDB_DATAPATH</code>: RRD data path
+*<code>RRDB_DATAPATH</code>: [[OS4X_Core_configuration#RRDB_data_path|RRD data path]]
 *<code>OS4X_WEBGUI_DIR</code>: web interface installation directory
 *<code>JAVA_BIN</code>: configured path to the Java runtime (JRE) binary
-*<code>CA_FILE</code>: configured absolute path to the root certificate file
+*<code>CA_FILE</code>: [[OS4X_Core_configuration#root_certificate_file_.26_root_certificate_path|configured absolute path to the root certificate file]]
-*<code>CA_PATH</code>: configured absolute path to the root certificate directory
+*<code>CA_PATH</code>: [[OS4X_Core_configuration#root_certificate_file_.26_root_certificate_path|configured absolute path to the root certificate directory]]
 All processes started by OS4X (event scripts, plugins, etc.) have access to these environment variables.