==About DBforBix==
[[Image:Dbforbix_architecture_full.png|frame|none|alt=DBforBIX Architecture|Fig. 1 - DBforBIX Architecture]]
DBforBIX is a daemon designed to work in combination with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for the many kind of different databases, along with server performance metrics.

It provides an effective mechanism to acquire data from numerous databases installation, and in turn provides this information for monitoring and performance metrics to your Zabbix server.

You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders.

The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. 
However these can be fine tuned to suit your needs and data/monitoring requirements.

DBforBIX can run as a Windows Service and is able to work on many different environments. Where is available a JRE 1.6 you can run DbforBIX.
History

You can read about the history and evolution of the DBforBIX plug-in in these threads below: 

Original here: http://www.zabbix.com/forum/showthread.php?t=13666 
Latest here: http://www.zabbix.com/forum/showthread.php?t=16391 
The origins of DBforBIX can be traced though Orabbix, PostBIX, MySQLBIX and DB2Bix, and as such inherits all its predecessors benefits.

==Author==
DBforBIX2 was developed and written by: 
'''Andrea Dalle Vacche''' : http://www.smartmarmot.com

==Supported Databases==
DBforBIX can acquire and retrieve every kind performance parameter and vital statistic that is supported or available through standard queries.

DBforBIX support the following databases:
* Oracle
* MySQL Server
* PostgreSQL
* MS SQL Server
* DB2
* Sybase Anywhere
* HP Allbase

All information gathered from the monitored databases is retrieved by query, using the Java JDBC layer. This ensures compatibility and diversity with future database versions and types.

===Monitoring Capabilities===
Below are some examples of what DBforBIX is capable of monitoring.

on Oracle Database
The following are just some of parameters that DBforBIX is capable of monitoring on Oracle:

Availability
* DB Version (for every vendor)
* Archiving (Archive log production with trend analysis)
* Event Waits (Files I/O, single block read, multi-block read, direct path read, SQLNet Messages,
* Control file I/O, Log Write)
* Hit Ratio (Hit Ratio on Triggers, Tables/Procedures, SQL Area, Body)
* Logical I/O (Server performance on Logical I/O of: Current Read, Consistent Read, Block Change)
* Physical I/O (Redo Writes, Datafile Writes, Datafile Reads)
* PGA
* SGA (In particular; Fixed Buffer, Java Pool, Large Pool, Log Buffer, Shared Poolm Buffer Cache)
* Shared Pool (Pool Dictionary Cache, Pool Free Memory, Library Chache, SQL Area, MISC.)
* Pin Hit Ratio (Oracle library cache pin are caused by contention with the library cache, the area used to store SQL executables for re-use)
* Sessions / Processes
* Sessions (Active Sessions, Inactive Sessions, System Sessions)
* DBSize/DBFileSize (DBSize size of database really used space and of Filesize) on MySQL server
The following are just some of parameters that DBforBIX is capable of monitoring on MySQL.
The list was truncated due to the sheer volume of list items:

* Dbversion
* table/thread cache
* Com created/dropped/changed/committed
* Innodb statistics
* Key read/write/requests
* Qcache statistics

on PostgreSQL server
The following are just some of parameters that DBforBIX is capable of monitoring on PostgreSQL:

* Availability
* Buffers (Backend, checkpoint, clean, allocated)
* Checkpoint (requested, timed)
* Connections
* Tuples (deleted, updated, fetched, returned, inserted)
* Xact (rollback, commit)
* Locks (every kind of exclusive locks and every kind of general locks)

on MS SQL server
The following are just some of parameters that DBforBIX is capable of monitoring on Microsoft SQL Server:
* Cachehit
* I/O Pending
* waittime
* dbsize/logsize
* log usedsize
* Page reades/writes

On DB2
Coming soon to a DBforBIX distribution near you!

On Sybase Anywhere
Coming soon to a DBforBIX distribution near you!

On HP ALLBASE
Coming soon to a DBforBIX distribution near you!

==Distribution==

You can find the latest versions of DBforBIX locations listed below:
* http://www.smartmarmot.com/product/dbforbix/download/
or
* https://sourceforge.net/projects/dbforbix/

==Technical Details==
DBforBIX has been made to monitor and control every kind of principal database with just one daemon.

Points of force of this daemon are:
* Apache DBCP connection pool
* logging realized by Log4J
* Hyper Threading
* Superscalar (you can monitor a huge amount of databases of different kind)
* Refresh parameter while running (you don't need to restart the daemon)
* unlimited support of Zabbix servers (send the retrieved items to all Zabbix server
* Items collision free

Pros:
You can customize connection pooling for each database with different parameters.
This means that connections are reused (constantly making a new connection introduces an overhead for all databases) and when idle or dropped.
You can customize your logfile format as you see fit, so it can be parsed to/from your own software to maintain control of information gathered by DBforBIX logging and assist in error troubleshooting.
Hyper Threading: If a database is slow, it won’t impact your other databases as every job is a thread and all generated threads run independently.
DBforBIX can scale on multiple processors and is really lightweight.
You can definitively use it in your mission critical environment, since the architecture allows you to send all retrieved items to any number of Zabbix servers, without limitations.
All the Items retrieved are collision free.
e.g. Alive is a true ''common'' item that can have collision with another Item with the same name.

Here is an example of the collision problem, solved by DBforBIX automatically introducing a prefix that is always in the form of:

'''DBforBIX.<db type>.itemkey'''

<dbtype> can be Oracle, MySQL, PostgreSQL, DB2, MSSQL and are predefined (you don't need to configure or modify anything)

==Requirements==
To use DBforBIX, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6
* DBforBIX distribution binaries

Current known successfully tested DBforBIX host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested Oracle Versions:
* 9i
* 10g
* 10.2
* 11G

Currently known tested PostgreSQL Versions:
* 8.3
* 8.4
* 9.0

Currently known tested MySQL Versions:
* 5.x

Currently known tested SQLServer Versions:
* 2005
* 2000

'''IMPORTANT'''
You do NOT need to install any client of any kind for DBforBIX to work.
You need to download and place under /lib/ directory the following library:
* db2jcc_license_cu.jar (DB2)
* db2jcc.jar (DB2)
* ojdbc6.jar (Oracle)
* jconn4d.jar (Sybase Anywhere)
* mbfjdbc2.jar (HP Allbase)

DBforBIX uses Java objects and connection strings to connect to the Oracle Database, and as such doesn’t require any database client to be installed on your Zabbix Server.

===Generated Graphs===
There are a significant number of graphs generated by the default templates included in DBforBIX, for each kind of database.

Some examples are coming soon.

==Installation==
===Assumptions===
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly. 

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x database Server. If you are planning on monitoring a database instance that is running on your Zabbix Server, the steps are the same,with minor adjustments required for your connection information. 

The steps also assume you are configuring DBforBIX to monitor a new installation or setup of Oracle. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. 

If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions. 

===Common (Universal) Installation Steps===
'''Common Part'''

Download DBforBIX to your Zabbix Server

On your Zabbix server, unzip DBforBIX to: /opt/dbforbix

Install the JAVA JVM >= 1.7 (both Oracle and OpenJDK works properly)

Install JSVC (Java daemon launcher)

Copy config.properties.sample to config.properties and change it adding your databases.

'''Initd'''

Now for all the distribution that are still using initd use the following procedure:

Copy file /opt/dbforbix/init.d/dbforbix to /etc/init.d/dbforbix

Grant execute permissions to the following files:
* /etc/init.d/dbforbix
* /opt/dbforbix/run.sh
For this example on RedHat, run:
chkconfig -add dbforbix
Verify with:
chkconfig -list
Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import your needed templates found at:
/opt/dbforbix/template
'''Systemd'''

If your distribution uses systemd, like most of the nowadays here are the steps:

Copy the systemd included files

cp systemd/dbforbix.service /etc/systemd/system/dbforbix.service

Notify systemd that a new dbforbix.service file exists by executing the following command as root:

systemctl daemon-reload
systemctl start dbforbix.service

To configure the service to start at each boot run (from root console):

systemctl enable name.service

If you would like to test dbforbix from command line you can simply type:

java -jar dbforbix.jar -a start -C /opt/dbforbix

===Installation on Windows===
DBforBIX implements an Apache daemon and offers the capability to run as a service on Microsoft Windows environments.

Install DBforBIX on Windows is really easy just follow these steps:
* Create a directory on c: called dbforbix
* extract the distribution inside “c:\dbforbix”
* double click on “install.cmd”
* Install a JRE >= 1.7 on the system
* Copy config.properties.sample to config.properties and modify
* Run install.cmd contained with the distribution
after you'll find a service called “DBforBIX Universal Database Monitor for Zabbix”

You can use “dbforbixctl.exe” to customize service's parameters if required.

Refer Figures 1.a and 1.b for screenshots that show dbforbixctl.exe at work.

[[Image:Dbforbix 01.JPG|frame|none|alt=DBforBIX General|Fig. 2 - DBforBIX General]]
[[Image:Dbforbix 02.JPG|frame|none|alt=DBforBIX Logging|Fig. 3 - DBforBIX Logging]]
[[Image:Dbforbix 03.JPG|frame|none|alt=DBforBIX Java|Fig. 4 - DBforBIX Java]]
[[Image:Dbforbix 04.JPG|frame|none|alt=DBforBIX Startup|Fig. 5 - DBforBIX Startup]]
[[Image:Dbforbix 05.JPG|frame|none|alt=DBforBIX Shutdown|Fig. 6 - DBforBIX Shutdown]]

===Install steps for Oracle===
Create a User (ZABBIX) for DBforBIX to access your Oracle Database. You can use the following script:
CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
-– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
–- 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

'''NOTE :''' If you are using Oracle 11g, you will need to add the following:
exec dbms_network_acl_admin.create_acl(acl => ‘resolve.xml’,description => ‘resolve acl‘, principal =>’ZABBIX’,is_grant => true, privilege => ‘resolve’);
exec dbms_network_acl_admin.assign_acl(acl => ‘resolve.xml’, host =>’*');

You can verify the above is correct by running:

select utl_inaddr.get_host_name(’127.0.0.1′) from dual;

'''NOTE:''' To create a User (ZABBIX) for DBforBIX with MINIMAL grants you can use the following script:
CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE USERS
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
GRANT ALTER SESSION TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT CONNECT TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
GRANT SELECT ON V_$INSTANCE TO ZABBIX;
GRANT SELECT ON DBA_USERS TO ZABBIX;
GRANT SELECT ON V_$LOG_HISTORY TO ZABBIX;
GRANT SELECT ON V_$PARAMETER TO ZABBIX;
GRANT SELECT ON SYS.DBA_AUDIT_SESSION TO ZABBIX;
GRANT SELECT ON V_$LOCK TO ZABBIX;
GRANT SELECT ON DBA_REGISTRY TO ZABBIX;
GRANT SELECT ON V_$LIBRARYCACHE TO ZABBIX;
GRANT SELECT ON V_$SYSSTAT TO ZABBIX;
GRANT SELECT ON V_$PARAMETER TO ZABBIX;
GRANT SELECT ON V_$LATCH TO ZABBIX;
GRANT SELECT ON V_$PGASTAT TO ZABBIX;
GRANT SELECT ON V_$SGASTAT TO ZABBIX;
GRANT SELECT ON V_$LIBRARYCACHE TO ZABBIX;
GRANT SELECT ON V_$PROCESS TO ZABBIX;
GRANT SELECT ON DBA_DATA_FILES TO ZABBIX;
GRANT SELECT ON DBA_TEMP_FILES TO ZABBIX;
GRANT SELECT ON DBA_FREE_SPACE TO ZABBIX;
GRANT SELECT ON V_$SYSTEM_EVENT TO ZABBIX;

===Install steps for PostgreSQL===
Create a User (ZABBIX) for DBforBIX to access your PostgreSQL Database. 
You can use the following script:
CREATE USER zabbix WITH PASSWORD 'passw0rd';
GRANT SELECT ON pg_stat_activity to zabbix;
GRANT SELECT ON pg_stat_activity to zabbix;
GRANT SELECT ON pg_database to zabbix;
GRANT SELECT ON pg_authid to zabbix;
GRANT SELECT ON pg_stat_bgwriter to zabbix;
GRANT SELECT ON pg_locks to zabbix;
GRANT SELECT ON pg_stat_database to zabbix;

===Steps for Installation on MySQL===
Create a User (ZABBIX) for DBforBIX to access your MySQL Database. 
You can use the following script:
CREATE USER 'zabbix_monitor'@'%.mydomain.com' IDENTIFIED BY 'zabbixpassword';
GRANT SELECT, SHOW VIEW ON *.* TO 'zabbix_monitor'@'%.mydomain.com';

===Steps for Installation on Microsoft SQL Server===
Coming soon

===Steps for Installation on IBM DB2===
Coming soon

==Configuration==
Now we need to configure your DBforBIX setup.

The tags below are listed as they will appear within the respective configuration files.
The first you will need to modify is your config.props file to define your connection properties for Zabbix and your databases.

The config.props file can be found at /opt/dbforbix/conf/config.props

===Config.props===
The file which is included in DBforBIX distribution if is the first installation need be renamed removing “.sample”.
With this way you will never find out overwritten your configurations file updating DBforBIX with a new release.
ZabbixServerList
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
DBforBIX can also be configured to send your Oracle data to multiple Zabbix servers.

Replace with your Zabbix Server info where appropriate;
ZabbixServerList=ZabbixServer1,ZabbixServer2
ZabbixServer1.Address=192.168.0.1
ZabbixServer1.Port=10051
ZabbixServer2.Address=192.168.0.2
ZabbixServer2.Port=10051

DBforBIXDaemon
Entries under this tag allow you to set your DBforBIX Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the DBforBIX Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by DB, now this parameter

if not set is automatically calculated.
e.g. For 50 Databases, we are using 100 threads
DBforBIX.MaxThreadNumber=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/dbforbix/logs
DBforBIX.PidFile=./logs/dbforbix.pid

'''NOTE:
'''Relative path is permitted here

DatabaseList
Entries under this heading allow you to configure your database list information:
#put here your databases in a comma separated list
This is where you define your database instances. You can specify more than one instance here, separated using a comma.
DatabaseList=EXAMPLE1,...

'''NOTE:
'''The names of the instances must match those you have specified as your HOST name in Zabbix

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, DBforBIX will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.
DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100
Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.
DatabaseList.MaxIdle=1

===Database Connection Parameters===
This section sets your connection string to the Oracle Database. This string invokes a Java Database Connector (JDBC) to your Oracle Databases, and as such does not need the Oracle Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as: DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information .

EXAMPLE1.Url=write here your database Url should be in the form:
Oracle = jdbc:oracle:thin:@<host>:<LISTENER_PORT>:<instance>
PostgreSQL = jdbc:postgresql://<host>:<port>/<database>
MS Sql Server = jdbc:jtds:sqlserver://<host>:<port>/<instancename>
MySQL Server = jdbc:mysql://[host:port],[host:port].../[database]
DB2 = jdbc:db2://<servername>:<port>/<installation>
Set your Database username and password below. e.g.
EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password
EXAMPLE1.DatabaseType=<databasetype>
where <databasetype> can be = [oracle]|[pgsql]|[mssql]|[mysql]|[db2]
it depend from your database
EXAMPLE1.QueryListFile=<path to query file>

'''Note:
'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish. 

'''Query List File''' 

This defines where the file containing the databases specific queries (SQL) queries can be found. This is a customizable file. 

You need to specify the query parameter file:
<DBNAME>.QueryListFile=./confQueryTest.props
This entry will specify the query file of a database relative path are allowed.

'''NOTE:
'''Most common query files are included in DBforBIX distribution you need to rename and remove “.sample”

Configuration of query.props file
The query.props file can be modified or added to, so you can supply your own customized queries through DBforBIX against your Oracle instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:'''
Item names must be unique. The configurable items are formatted as follows.

#QueryList
You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;
QueryList=queryName1,queryName2,queryName3

#Query
You must identify the query by the unique item name you specified in the
QueryList, followed by '.Query' for DBforBIX to recognise that this is the query string.
It’s important to remember NOT to add the semi-colon “;” to the end of your custom query.
customQueryItemName.Query=yourQueryHere
Now you can define what you want DBforBIX to return to your Zabbix Server if no data is found for your query.
customQueryItemName.NoDataFound=none
You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
Next you can specify a query that will be executed and if return ‘RaceConditionValue’ the query ‘customQueryItemName’ is executed, otherwise it is skipped
customQueryItemName.ACTIVE=[true|false]
if true query is executed otherwise skipped
archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes \
FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

<QueryName>.Trim=[true|false]

if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]

if true then add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset

==DBforBIX FAQ==
How do I start/stop the Daemon? 
To start the DBforBIX Daemon, run: 
/etc/init.d/dbforbix start

To stop the DBforBIX Daemon, run:
/etc/init.d/dbforbix stop

How does Logging work?
The DBforBIX daemon outputs its log file to the default location of /opt/dbforbix/logs/
Logging properties can be modified by making your required changes to:
/opt/dbforbix/conf/log4j.properties
The property setting responsible for defining the output location is:
log4j.appender.DBforBIX.File=logs/dbforbix.log

Is there a way for DBforBIX to monitor RAC or DataGuard?
Yes is possible, for example;
If you have two hosts, RAC1 and RAC2, in one instance of RACINST
you should write the connection string as follow:
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

What can I modify without restarting the daemon?
The parameters that are dynamically read at each iteration of “DBforBIXDaemon.Sleep” are as follows;
* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the
ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.
Is it possible divide monitoring for based on database type and/or environment?
Yes it's possible and it's easy! Basically, you just need to copy your installation directory into a new one
e.g. you can have
/opt/dbforbix_prod
/opt/dbforbix_test
/opt/dbforbix_devel

and then you need to copy /etc/init.d/dbforbix into
/etc/init.d/dbforbix_prod
/etc/init.d/dbforbix_test
/etc/init.d/dbforbix_devel

After this, you need to customize start/stop script to locate the right directory for each instance of DBforBIX
e.g.
dbforbix=/opt/dbforbix
should be changed into:
/opt/dbforbix_prod
/opt/dbforbix_test
/opt/dbforbix_devel

Now you have completely divided your monitoring solution to the most common scenarios of:
development environment
test/quality/pre-production environment
production environment

After that you can customize your queries file for you different environments, ensure each fulfils the requirements based on their varying needs. You can play around with the suggestions above and do the same as needed.

==Document Copyright==
Document Copyright © Andrea Dalle Vacche and Jason Chatfield

==License Information==
[[Image:DBforBIX.png|left|link=DBforBIX]]
DBforBIX is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE '''
Version 3, 29 June 2007

File:DBforBIX2.png

2016-11-04T21:37:33Z

Admin:

2013-07-08T09:32:29Z

Admin:

=''ORABBIX''=
[[File:orabbix_logo.png]]
=''Authors''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

=''Download & Installation Instructions''=

=''About Orabbix''=
==Product Description==
Orabbix is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for Oracle Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous Oracle instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:Orabbix_architecture.png|frame|none|alt=Orabbix Architecture|Fig. 1 - Orabbix Architecture]]

==''What can it monitor?''==
Below are some examples of what Orabbix is capable of monitoring:
* DB Version (i.e. Validity of package) 
* Archiving (Archive log production with trend analysis) 
* Event Waits (Files I/O, single block read, multi-block read, direct path read, SQLNet Messages, Control file I/O, Log Write)
* Hit Ratio (Hit Ratio on Triggers, Tables/Procedures, SQL Area, Body)
* Logical I/O (Server performance on Logical I/O of: Current Read, Consistent Read, Block Change)
* Physical I/O (Redo Writes, Datafile Writes, Datafile Reads)
* PGA
* SGA (In particular; Fixed Buffer, Java Pool, Large Pool, Log Buffer, Shared Poolm Buffer Cache)
* Shared Pool (Pool Dictionary Cache, Pool Free Memory, Library Chache, SQL Area, MISC.)
* Pin Hit Ratio (Oracle library cache pin are caused by contention with the library cache, the area used to store SQL executables for re-use)
* Sessions / Processes
* Sessions (Active Sessions, Inactive Sessions, System Sessions)
* DBSize/DBFileSize (DBSize size of database really used space and of Filesize)

[[Image:Orabbix_ARCHIVELOG.png|frame|none|alt=Orabbix Archivelog|Fig. 2 - Orabbix Archivelog]]
[[Image:Orabbix_DBSIZEFILESIZE.png|frame|none|alt=Orabbix DBFileSize|Fig. 3 - Orabbix DBFileSize]]
[[Image:Orabbix_EVENTWAITS.png|frame|none|alt=Orabbix Events Waits|Fig. 4 - Orabbix Events Waits]]
[[Image:Orabbix_SHAREDPOOL.png|frame|none|alt=Orabbix Shared Pool|Fig. 5 - Orabbix SHared Pool]]
[[Image:Orabbix_SGA.png|frame|none|alt=Orabbix SGA|Fig. 6 - Orabbix SGA]]
[[Image:Orabbix_PINHITRATIO.png|frame|none|alt=Orabbix Pin Hit Ratio|Fig. 7 - Orabbix Pin Hit Ratio]]
[[Image:Orabbix_SESSIONS.png|frame|none|alt=Orabbix Sessions|Fig. 8 - Orabbix Sessions]]
[[Image:Orabbix_SESSIONPROCESS.png|frame|none|alt=Orabbix Sessions Processes|Fig. 9 - Orabbix Sessions Processes]]
[[Image:Orabbix_PGA.png|frame|none|alt=Orabbix PGA|Fig. 10 - PGA]]
[[Image:Orabbix_LIO.png|frame|none|alt=Orabbix Logical I/O|Fig. 11 - Logical I/O]]
[[Image:Orabbix_PHIO.png|frame|none|alt=Orabbix Physical I/O|Fig. 12 - Physical I/O]]

==Orabbix Author==
''Andrea Dalle Vacche:'' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the Orabbix plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=13666 
Latest here: http://www.zabbix.com/forum/showthread.php?t=16391

=Distribution=
You can find the latest versions of Orabbix at the locations listed below: 

http://www.smartmarmot.com/product/orabbix/download/ 
or 
https://sourceforge.net/projects/orabbix/ 

==Requirements==
To use Orabbix, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested Oracle host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested Oracle Versions:
* 10g
* 10.2

IMPORTANT
You do NOT need to install an Oracle client of any kind for Orabbix to work.
Orabbix uses Java objects and connection strings to connect to the Oracle Database, and as such doesn’t require an Oracle client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x Oracle Server. If you are planning on monitoring an Oracle instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring Orabbix to monitor a new installation or setup of Oracle. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download Orabbix to your Zabbix Server
* On your Zabbix server, unzip Orabbix to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for Orabbix to access your Oracle Database. You can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
– 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

* '''NOTE''' if you need an User (ZABBIX) for Orabbix with the minimum grants available, you can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE USERS
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
GRANT ALTER SESSION TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT CONNECT TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
GRANT SELECT ON V_$INSTANCE TO ZABBIX;
GRANT SELECT ON DBA_USERS TO ZABBIX;
GRANT SELECT ON V_$LOG_HISTORY TO ZABBIX;
GRANT SELECT ON V_$PARAMETER TO ZABBIX;
GRANT SELECT ON SYS.DBA_AUDIT_SESSION TO ZABBIX;
GRANT SELECT ON V_$LOCK TO ZABBIX;
GRANT SELECT ON DBA_REGISTRY TO ZABBIX;
GRANT SELECT ON V_$LIBRARYCACHE TO ZABBIX;
GRANT SELECT ON V_$SYSSTAT TO ZABBIX;
GRANT SELECT ON V_$PARAMETER TO ZABBIX;
GRANT SELECT ON V_$LATCH TO ZABBIX;
GRANT SELECT ON V_$PGASTAT TO ZABBIX;
GRANT SELECT ON V_$SGASTAT TO ZABBIX;
GRANT SELECT ON V_$LIBRARYCACHE TO ZABBIX;
GRANT SELECT ON V_$PROCESS TO ZABBIX;
GRANT SELECT ON DBA_DATA_FILES TO ZABBIX;
GRANT SELECT ON DBA_TEMP_FILES TO ZABBIX;
GRANT SELECT ON DBA_FREE_SPACE TO ZABBIX;
GRANT SELECT ON V_$SYSTEM_EVENT TO ZABBIX;

'''NOTE''' : If you are using Oracle 11g, you will need to add the following:

exec dbms_network_acl_admin.create_acl(acl => 'resolve.xml',description => 'resolve acl', principal =>'ZABBIX', is_grant => true, privilege => 'resolve');
exec dbms_network_acl_admin.assign_acl(acl => 'resolve.xml', host =>'*');
commit;

You can verify the above is correct by running:
select utl_inaddr.get_host_name('127.0.0.1') from dual;

* For this example on RedHat, run:
chkconfig -add orabbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/orabbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or Oracle instance name'''.

=Configuration=
Now we need to configure your Orabbix setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and Oracle.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
Orabbix can also be configured to send your Oracle data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating Orabbix data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===OrabbixDaemon===
Entries under this tag allow you to set your Orabbix Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the Orabbix Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by Orabbix, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''OrabbixDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''OrabbixDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the Orabbix Daemon, it is possible to clone Orabbix and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, Orabbix will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the Oracle Database. This string invokes a Java Database Connector (JDBC) to your Oracle Databases, and as such does not need the Oracle Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the Oracle (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each Oracle Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through Orabbix against your Oracle instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for Orabbix to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want Orabbix to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, Orabbix would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, Orabbix would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use Orabbix/FAQ=

'''How do I start/stop the Daemon?''' 
To start the Orabbix Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the Orabbix Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The Orabbix daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.Orabbix.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “OrabbixDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
Orabbix is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

2012-02-16T14:50:54Z

2011-10-31T15:06:35Z

Admin: /* Steps for Installation */

='''POSTBIX'''=
[[File:postbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About PostBIX'''=
==Product Description==
PostBIX is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for PostgreSQL Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous PostgreSQL instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:PostBIX_architecture.png|frame|none|alt=PostBIX Architecture|Fig. 1 - PostBIX Architecture]]

=='''What can it monitor?'''==
Below are some examples of what PostBIX is capable of monitoring:
*comming soon

[[Image:PostBIX_ALIVE.png|frame|none|alt=PostBIX Alive|Fig. 2 - PostBIX Alive]]
[[Image:PostBIX_BUFFERS.png|frame|none|alt=PostBIX BUFFERS|Fig. 3 - PostBIX Buffers]]
[[Image:PostBIX_CHECKPOINT.png|frame|none|alt=PostBIX CHECKPOINT|Fig. 4 - PostBIX Checkpoint]]
[[Image:PostBIX_XACT.png|frame|none|alt=PostBIX XACT|Fig. 5 - PostBIX XACT]]
[[Image:PostBIX_CONNECTIONS.png|frame|none|alt=PostBIX Connections|Fig. 6 - PostBIX SGA]]
[[Image:PostBIX_TUPLES.png|frame|none|alt=PostBIX Tuples|Fig. 7 - PostBIX Tuple]]
[[Image:PostBIX_LOCKS.png|frame|none|alt=PostBIX Locks|Fig. 8 - PostBIX Locks]]

==PostBIX Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the PostBIX plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=18690 

=Distribution=
You can find the latest versions of PostBIX at the locations listed below: 

http://www.smartmarmot.com/product/postbix/download/ 
or 
https://sourceforge.net/projects/postbix/ 

==Requirements==
To use PostBIX, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested PostgreSQL host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested PostgreSQL Versions:
* 8.3
* 8.4

IMPORTANT
You do NOT need to install an PostgreSQL client of any kind for PostBIX to work.
PostBIX uses Java objects and connection strings to connect to the PostgreSQL Database, and as such doesn’t require an PostgreSQL client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x PostgreSQL Server. If you are planning on monitoring an PostgreSQL instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring PostBIX to monitor a new installation or setup of PostgreSQL. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download PostBIX to your Zabbix Server
* On your Zabbix server, unzip PostBIX to: /opt/postbix
* Copy file /opt/postbix/init.d/postbixto /etc/init.d/postbix
* Grant execute permissions to the following files:
/etc/init.d/postbix
/opt/postbix/run.sh
* Create a User (ZABBIX) for PostBIX to access your PostgreSQL Database. You can use the following script:

CREATE USER zabbix WITH PASSWORD 'passw0rd';
GRANT SELECT ON pg_stat_activity to zabbix;
GRANT SELECT ON pg_stat_activity to zabbix;
GRANT SELECT ON pg_database to zabbix;
GRANT SELECT ON pg_authid to zabbix;
GRANT SELECT ON pg_stat_bgwriter to zabbix;
GRANT SELECT ON pg_locks to zabbix;
GRANT SELECT ON pg_stat_database to zabbix;

* For this example on RedHat, run:
chkconfig -add postbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/postbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or PostgreSQL instance name'''.

=Configuration=
Now we need to configure your PostBIX setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and PostgreSQL.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
PostBIX can also be configured to send your PostgreSQL data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating PostBIX data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===PostBIXDaemon===
Entries under this tag allow you to set your PostBIX Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the PostBIX Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by PostBIX, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''PostBIXDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''PostBIXDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the PostBIX Daemon, it is possible to clone PostBIX and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, PostBIX will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the PostgreSQL Database. This string invokes a Java Database Connector (JDBC) to your PostgreSQL Databases, and as such does not need the PostgreSQL Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the PostgreSQL (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each PostgreSQL Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through PostBIX against your PostgreSQL instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for PostBIX to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want PostBIX to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, PostBIX would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, PostBIX would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use PostBIX/FAQ=

'''How do I start/stop the Daemon?''' 
To start the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The PostBIX daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.PostBIX.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “PostBIXDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
PostBIX is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

Postbix

2011-10-31T15:06:14Z

Admin: /* Steps for Installation */

='''POSTBIX'''=
[[File:postbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About PostBIX'''=
==Product Description==
PostBIX is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for PostgreSQL Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous PostgreSQL instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:PostBIX_architecture.png|frame|none|alt=PostBIX Architecture|Fig. 1 - PostBIX Architecture]]

=='''What can it monitor?'''==
Below are some examples of what PostBIX is capable of monitoring:
*comming soon

[[Image:PostBIX_ALIVE.png|frame|none|alt=PostBIX Alive|Fig. 2 - PostBIX Alive]]
[[Image:PostBIX_BUFFERS.png|frame|none|alt=PostBIX BUFFERS|Fig. 3 - PostBIX Buffers]]
[[Image:PostBIX_CHECKPOINT.png|frame|none|alt=PostBIX CHECKPOINT|Fig. 4 - PostBIX Checkpoint]]
[[Image:PostBIX_XACT.png|frame|none|alt=PostBIX XACT|Fig. 5 - PostBIX XACT]]
[[Image:PostBIX_CONNECTIONS.png|frame|none|alt=PostBIX Connections|Fig. 6 - PostBIX SGA]]
[[Image:PostBIX_TUPLES.png|frame|none|alt=PostBIX Tuples|Fig. 7 - PostBIX Tuple]]
[[Image:PostBIX_LOCKS.png|frame|none|alt=PostBIX Locks|Fig. 8 - PostBIX Locks]]

==PostBIX Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the PostBIX plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=18690 

=Distribution=
You can find the latest versions of PostBIX at the locations listed below: 

http://www.smartmarmot.com/product/postbix/download/ 
or 
https://sourceforge.net/projects/postbix/ 

==Requirements==
To use PostBIX, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested PostgreSQL host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested PostgreSQL Versions:
* 8.3
* 8.4

IMPORTANT
You do NOT need to install an PostgreSQL client of any kind for PostBIX to work.
PostBIX uses Java objects and connection strings to connect to the PostgreSQL Database, and as such doesn’t require an PostgreSQL client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x PostgreSQL Server. If you are planning on monitoring an PostgreSQL instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring PostBIX to monitor a new installation or setup of PostgreSQL. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download PostBIX to your Zabbix Server
* On your Zabbix server, unzip PostBIX to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for PostBIX to access your PostgreSQL Database. You can use the following script:

CREATE USER zabbix WITH PASSWORD 'passw0rd';
GRANT SELECT ON pg_stat_activity to zabbix;
GRANT SELECT ON pg_stat_activity to zabbix;
GRANT SELECT ON pg_database to zabbix;
GRANT SELECT ON pg_authid to zabbix;
GRANT SELECT ON pg_stat_bgwriter to zabbix;
GRANT SELECT ON pg_locks to zabbix;
GRANT SELECT ON pg_stat_database to zabbix;

* For this example on RedHat, run:
chkconfig -add postbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/postbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or PostgreSQL instance name'''.

=Configuration=
Now we need to configure your PostBIX setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and PostgreSQL.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
PostBIX can also be configured to send your PostgreSQL data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating PostBIX data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===PostBIXDaemon===
Entries under this tag allow you to set your PostBIX Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the PostBIX Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by PostBIX, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''PostBIXDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''PostBIXDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the PostBIX Daemon, it is possible to clone PostBIX and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, PostBIX will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the PostgreSQL Database. This string invokes a Java Database Connector (JDBC) to your PostgreSQL Databases, and as such does not need the PostgreSQL Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the PostgreSQL (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each PostgreSQL Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through PostBIX against your PostgreSQL instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for PostBIX to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want PostBIX to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, PostBIX would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, PostBIX would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use PostBIX/FAQ=

'''How do I start/stop the Daemon?''' 
To start the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The PostBIX daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.PostBIX.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “PostBIXDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
PostBIX is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

Postbix

2011-10-31T15:05:01Z

Admin: /* Requirements */

='''POSTBIX'''=
[[File:postbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About PostBIX'''=
==Product Description==
PostBIX is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for PostgreSQL Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous PostgreSQL instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:PostBIX_architecture.png|frame|none|alt=PostBIX Architecture|Fig. 1 - PostBIX Architecture]]

=='''What can it monitor?'''==
Below are some examples of what PostBIX is capable of monitoring:
*comming soon

[[Image:PostBIX_ALIVE.png|frame|none|alt=PostBIX Alive|Fig. 2 - PostBIX Alive]]
[[Image:PostBIX_BUFFERS.png|frame|none|alt=PostBIX BUFFERS|Fig. 3 - PostBIX Buffers]]
[[Image:PostBIX_CHECKPOINT.png|frame|none|alt=PostBIX CHECKPOINT|Fig. 4 - PostBIX Checkpoint]]
[[Image:PostBIX_XACT.png|frame|none|alt=PostBIX XACT|Fig. 5 - PostBIX XACT]]
[[Image:PostBIX_CONNECTIONS.png|frame|none|alt=PostBIX Connections|Fig. 6 - PostBIX SGA]]
[[Image:PostBIX_TUPLES.png|frame|none|alt=PostBIX Tuples|Fig. 7 - PostBIX Tuple]]
[[Image:PostBIX_LOCKS.png|frame|none|alt=PostBIX Locks|Fig. 8 - PostBIX Locks]]

==PostBIX Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the PostBIX plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=18690 

=Distribution=
You can find the latest versions of PostBIX at the locations listed below: 

http://www.smartmarmot.com/product/postbix/download/ 
or 
https://sourceforge.net/projects/postbix/ 

==Requirements==
To use PostBIX, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested PostgreSQL host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested PostgreSQL Versions:
* 8.3
* 8.4

IMPORTANT
You do NOT need to install an PostgreSQL client of any kind for PostBIX to work.
PostBIX uses Java objects and connection strings to connect to the PostgreSQL Database, and as such doesn’t require an PostgreSQL client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x PostgreSQL Server. If you are planning on monitoring an PostgreSQL instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring PostBIX to monitor a new installation or setup of PostgreSQL. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download PostBIX to your Zabbix Server
* On your Zabbix server, unzip PostBIX to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for PostBIX to access your PostgreSQL Database. You can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
– 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

'''NOTE''' : If you are using PostgreSQL 11g, you will need to add the following:

exec dbms_network_acl_admin.create_acl(acl => 'resolve.xml',description => 'resolve acl', principal =>'ZABBIX', is_grant => true, privilege => 'resolve');
exec dbms_network_acl_admin.assign_acl(acl => 'resolve.xml', host =>'*');
commit;

You can verify the above is correct by running:
select utl_inaddr.get_host_name('127.0.0.1') from dual;

* For this example on RedHat, run:
chkconfig -add orabbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/orabbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or PostgreSQL instance name'''.

=Configuration=
Now we need to configure your PostBIX setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and PostgreSQL.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
PostBIX can also be configured to send your PostgreSQL data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating PostBIX data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===PostBIXDaemon===
Entries under this tag allow you to set your PostBIX Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the PostBIX Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by PostBIX, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''PostBIXDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''PostBIXDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the PostBIX Daemon, it is possible to clone PostBIX and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, PostBIX will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the PostgreSQL Database. This string invokes a Java Database Connector (JDBC) to your PostgreSQL Databases, and as such does not need the PostgreSQL Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the PostgreSQL (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each PostgreSQL Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through PostBIX against your PostgreSQL instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for PostBIX to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want PostBIX to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, PostBIX would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, PostBIX would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use PostBIX/FAQ=

'''How do I start/stop the Daemon?''' 
To start the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The PostBIX daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.PostBIX.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “PostBIXDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
PostBIX is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

Postbix

2011-10-31T15:04:37Z

Admin: /* Distribution */

='''POSTBIX'''=
[[File:postbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About PostBIX'''=
==Product Description==
PostBIX is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for PostgreSQL Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous PostgreSQL instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:PostBIX_architecture.png|frame|none|alt=PostBIX Architecture|Fig. 1 - PostBIX Architecture]]

=='''What can it monitor?'''==
Below are some examples of what PostBIX is capable of monitoring:
*comming soon

[[Image:PostBIX_ALIVE.png|frame|none|alt=PostBIX Alive|Fig. 2 - PostBIX Alive]]
[[Image:PostBIX_BUFFERS.png|frame|none|alt=PostBIX BUFFERS|Fig. 3 - PostBIX Buffers]]
[[Image:PostBIX_CHECKPOINT.png|frame|none|alt=PostBIX CHECKPOINT|Fig. 4 - PostBIX Checkpoint]]
[[Image:PostBIX_XACT.png|frame|none|alt=PostBIX XACT|Fig. 5 - PostBIX XACT]]
[[Image:PostBIX_CONNECTIONS.png|frame|none|alt=PostBIX Connections|Fig. 6 - PostBIX SGA]]
[[Image:PostBIX_TUPLES.png|frame|none|alt=PostBIX Tuples|Fig. 7 - PostBIX Tuple]]
[[Image:PostBIX_LOCKS.png|frame|none|alt=PostBIX Locks|Fig. 8 - PostBIX Locks]]

==PostBIX Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the PostBIX plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=18690 

=Distribution=
You can find the latest versions of PostBIX at the locations listed below: 

http://www.smartmarmot.com/product/postbix/download/ 
or 
https://sourceforge.net/projects/postbix/ 

==Requirements==
To use PostBIX, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested PostgreSQL host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested PostgreSQL Versions:
* 10g
* 10.2

IMPORTANT
You do NOT need to install an PostgreSQL client of any kind for PostBIX to work.
PostBIX uses Java objects and connection strings to connect to the PostgreSQL Database, and as such doesn’t require an PostgreSQL client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x PostgreSQL Server. If you are planning on monitoring an PostgreSQL instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring PostBIX to monitor a new installation or setup of PostgreSQL. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download PostBIX to your Zabbix Server
* On your Zabbix server, unzip PostBIX to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for PostBIX to access your PostgreSQL Database. You can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
– 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

'''NOTE''' : If you are using PostgreSQL 11g, you will need to add the following:

exec dbms_network_acl_admin.create_acl(acl => 'resolve.xml',description => 'resolve acl', principal =>'ZABBIX', is_grant => true, privilege => 'resolve');
exec dbms_network_acl_admin.assign_acl(acl => 'resolve.xml', host =>'*');
commit;

You can verify the above is correct by running:
select utl_inaddr.get_host_name('127.0.0.1') from dual;

* For this example on RedHat, run:
chkconfig -add orabbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/orabbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or PostgreSQL instance name'''.

=Configuration=
Now we need to configure your PostBIX setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and PostgreSQL.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
PostBIX can also be configured to send your PostgreSQL data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating PostBIX data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===PostBIXDaemon===
Entries under this tag allow you to set your PostBIX Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the PostBIX Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by PostBIX, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''PostBIXDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''PostBIXDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the PostBIX Daemon, it is possible to clone PostBIX and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, PostBIX will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the PostgreSQL Database. This string invokes a Java Database Connector (JDBC) to your PostgreSQL Databases, and as such does not need the PostgreSQL Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the PostgreSQL (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each PostgreSQL Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through PostBIX against your PostgreSQL instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for PostBIX to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want PostBIX to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, PostBIX would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, PostBIX would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use PostBIX/FAQ=

'''How do I start/stop the Daemon?''' 
To start the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The PostBIX daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.PostBIX.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “PostBIXDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
PostBIX is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

Postbix

2011-10-31T15:04:22Z

2011-10-31T15:01:44Z

Admin: /* What can it monitor? */

='''POSTBIX'''=
[[File:postbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About PostBIX'''=
==Product Description==
PostBIX is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for PostgreSQL Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous PostgreSQL instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:PostBIX_architecture.png|frame|none|alt=PostBIX Architecture|Fig. 1 - PostBIX Architecture]]

=='''What can it monitor?'''==
Below are some examples of what PostBIX is capable of monitoring:
*comming soon

[[Image:PostBIX_ALIVE.png|frame|none|alt=PostBIX Alive|Fig. 2 - PostBIX Alive]]
[[Image:PostBIX_BUFFERS.png|frame|none|alt=PostBIX BUFFERS|Fig. 3 - PostBIX Buffers]]
[[Image:PostBIX_CHECKPOINT.png|frame|none|alt=PostBIX CHECKPOINT|Fig. 4 - PostBIX Checkpoint]]
[[Image:PostBIX_XACT.png|frame|none|alt=PostBIX XACT|Fig. 5 - PostBIX XACT]]
[[Image:PostBIX_CONNECTIONS.png|frame|none|alt=PostBIX Connections|Fig. 6 - PostBIX SGA]]
[[Image:PostBIX_TUPLES.png|frame|none|alt=PostBIX Tuples|Fig. 7 - PostBIX Tuple]]
[[Image:PostBIX_LOCKS.png|frame|none|alt=PostBIX Locks|Fig. 8 - PostBIX Locks]]

==PostBIX Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the PostBIX plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=13666 
Latest here: http://www.zabbix.com/forum/showthread.php?t=16391

=Distribution=
You can find the latest versions of PostBIX at the locations listed below: 

http://www.smartmarmot.com/product/orabbix/download/ 
or 
https://sourceforge.net/projects/orabbix/ 

==Requirements==
To use PostBIX, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested PostgreSQL host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested PostgreSQL Versions:
* 10g
* 10.2

IMPORTANT
You do NOT need to install an PostgreSQL client of any kind for PostBIX to work.
PostBIX uses Java objects and connection strings to connect to the PostgreSQL Database, and as such doesn’t require an PostgreSQL client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x PostgreSQL Server. If you are planning on monitoring an PostgreSQL instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring PostBIX to monitor a new installation or setup of PostgreSQL. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download PostBIX to your Zabbix Server
* On your Zabbix server, unzip PostBIX to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for PostBIX to access your PostgreSQL Database. You can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
– 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

'''NOTE''' : If you are using PostgreSQL 11g, you will need to add the following:

exec dbms_network_acl_admin.create_acl(acl => 'resolve.xml',description => 'resolve acl', principal =>'ZABBIX', is_grant => true, privilege => 'resolve');
exec dbms_network_acl_admin.assign_acl(acl => 'resolve.xml', host =>'*');
commit;

You can verify the above is correct by running:
select utl_inaddr.get_host_name('127.0.0.1') from dual;

* For this example on RedHat, run:
chkconfig -add orabbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/orabbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or PostgreSQL instance name'''.

=Configuration=
Now we need to configure your PostBIX setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and PostgreSQL.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
PostBIX can also be configured to send your PostgreSQL data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating PostBIX data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===PostBIXDaemon===
Entries under this tag allow you to set your PostBIX Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the PostBIX Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by PostBIX, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''PostBIXDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''PostBIXDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the PostBIX Daemon, it is possible to clone PostBIX and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, PostBIX will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the PostgreSQL Database. This string invokes a Java Database Connector (JDBC) to your PostgreSQL Databases, and as such does not need the PostgreSQL Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the PostgreSQL (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each PostgreSQL Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through PostBIX against your PostgreSQL instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for PostBIX to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want PostBIX to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, PostBIX would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, PostBIX would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use PostBIX/FAQ=

'''How do I start/stop the Daemon?''' 
To start the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The PostBIX daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.PostBIX.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “PostBIXDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
PostBIX is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

Main Page

2011-10-31T14:58:23Z

Admin:

File:Postbix logo.png

2011-10-31T14:57:11Z

Admin:

Postbix

2011-10-31T14:55:10Z

Admin: Created page with "='''POSTBIX'''= File:postbix_logo.png ='''Authors'''= ''Andrea Dalle Vacche'' ''Jason Chatfield'' ='''Download & Installation Instructions'''= ='''About PostBIX'''= ==..."

='''POSTBIX'''=
[[File:postbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About PostBIX'''=
==Product Description==
PostBIX is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for PostgreSQL Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous PostgreSQL instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:PostBIX_architecture.png|frame|none|alt=PostBIX Architecture|Fig. 1 - PostBIX Architecture]]

=='''What can it monitor?'''==
Below are some examples of what PostBIX is capable of monitoring:
* DB Version (i.e. Validity of package) 
* Archiving (Archive log production with trend analysis) 
* Event Waits (Files I/O, single block read, multi-block read, direct path read, SQLNet Messages, Control file I/O, Log Write)
* Hit Ratio (Hit Ratio on Triggers, Tables/Procedures, SQL Area, Body)
* Logical I/O (Server performance on Logical I/O of: Current Read, Consistent Read, Block Change)
* Physical I/O (Redo Writes, Datafile Writes, Datafile Reads)
* PGA
* SGA (In particular; Fixed Buffer, Java Pool, Large Pool, Log Buffer, Shared Poolm Buffer Cache)
* Shared Pool (Pool Dictionary Cache, Pool Free Memory, Library Chache, SQL Area, MISC.)
* Pin Hit Ratio (PostgreSQL library cache pin are caused by contention with the library cache, the area used to store SQL executables for re-use)
* Sessions / Processes
* Sessions (Active Sessions, Inactive Sessions, System Sessions)
* DBSize/DBFileSize (DBSize size of database really used space and of Filesize)

[[Image:PostBIX_ARCHIVELOG.png|frame|none|alt=PostBIX Archivelog|Fig. 2 - PostBIX Archivelog]]
[[Image:PostBIX_DBSIZEFILESIZE.png|frame|none|alt=PostBIX DBFileSize|Fig. 3 - PostBIX DBFileSize]]
[[Image:PostBIX_EVENTWAITS.png|frame|none|alt=PostBIX Events Waits|Fig. 4 - PostBIX Events Waits]]
[[Image:PostBIX_SHAREDPOOL.png|frame|none|alt=PostBIX Shared Pool|Fig. 5 - PostBIX SHared Pool]]
[[Image:PostBIX_SGA.png|frame|none|alt=PostBIX SGA|Fig. 6 - PostBIX SGA]]
[[Image:PostBIX_PINHITRATIO.png|frame|none|alt=PostBIX Pin Hit Ratio|Fig. 7 - PostBIX Pin Hit Ratio]]
[[Image:PostBIX_SESSIONS.png|frame|none|alt=PostBIX Sessions|Fig. 8 - PostBIX Sessions]]
[[Image:PostBIX_SESSIONPROCESS.png|frame|none|alt=PostBIX Sessions Processes|Fig. 9 - PostBIX Sessions Processes]]
[[Image:PostBIX_PGA.png|frame|none|alt=PostBIX PGA|Fig. 10 - PGA]]
[[Image:PostBIX_LIO.png|frame|none|alt=PostBIX Logical I/O|Fig. 11 - Logical I/O]]
[[Image:PostBIX_PHIO.png|frame|none|alt=PostBIX Physical I/O|Fig. 12 - Physical I/O]]

==PostBIX Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the PostBIX plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=13666 
Latest here: http://www.zabbix.com/forum/showthread.php?t=16391

=Distribution=
You can find the latest versions of PostBIX at the locations listed below: 

http://www.smartmarmot.com/product/orabbix/download/ 
or 
https://sourceforge.net/projects/orabbix/ 

==Requirements==
To use PostBIX, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested PostgreSQL host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested PostgreSQL Versions:
* 10g
* 10.2

IMPORTANT
You do NOT need to install an PostgreSQL client of any kind for PostBIX to work.
PostBIX uses Java objects and connection strings to connect to the PostgreSQL Database, and as such doesn’t require an PostgreSQL client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x PostgreSQL Server. If you are planning on monitoring an PostgreSQL instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring PostBIX to monitor a new installation or setup of PostgreSQL. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download PostBIX to your Zabbix Server
* On your Zabbix server, unzip PostBIX to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for PostBIX to access your PostgreSQL Database. You can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
– 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

'''NOTE''' : If you are using PostgreSQL 11g, you will need to add the following:

exec dbms_network_acl_admin.create_acl(acl => 'resolve.xml',description => 'resolve acl', principal =>'ZABBIX', is_grant => true, privilege => 'resolve');
exec dbms_network_acl_admin.assign_acl(acl => 'resolve.xml', host =>'*');
commit;

You can verify the above is correct by running:
select utl_inaddr.get_host_name('127.0.0.1') from dual;

* For this example on RedHat, run:
chkconfig -add orabbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/orabbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or PostgreSQL instance name'''.

=Configuration=
Now we need to configure your PostBIX setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and PostgreSQL.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
PostBIX can also be configured to send your PostgreSQL data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating PostBIX data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===PostBIXDaemon===
Entries under this tag allow you to set your PostBIX Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the PostBIX Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by PostBIX, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''PostBIXDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''PostBIXDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the PostBIX Daemon, it is possible to clone PostBIX and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, PostBIX will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the PostgreSQL Database. This string invokes a Java Database Connector (JDBC) to your PostgreSQL Databases, and as such does not need the PostgreSQL Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the PostgreSQL (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each PostgreSQL Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through PostBIX against your PostgreSQL instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for PostBIX to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want PostBIX to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, PostBIX would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, PostBIX would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use PostBIX/FAQ=

'''How do I start/stop the Daemon?''' 
To start the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the PostBIX Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The PostBIX daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.PostBIX.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “PostBIXDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
PostBIX is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

Orabbix

2011-10-28T14:15:54Z

Admin: /* How to Use Orabbix/FAQ */

='''ORABBIX'''=
[[File:orabbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About Orabbix'''=
==Product Description==
Orabbix is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for Oracle Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous Oracle instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:Orabbix_architecture.png|frame|none|alt=Orabbix Architecture|Fig. 1 - Orabbix Architecture]]

=='''What can it monitor?'''==
Below are some examples of what Orabbix is capable of monitoring:
* DB Version (i.e. Validity of package) 
* Archiving (Archive log production with trend analysis) 
* Event Waits (Files I/O, single block read, multi-block read, direct path read, SQLNet Messages, Control file I/O, Log Write)
* Hit Ratio (Hit Ratio on Triggers, Tables/Procedures, SQL Area, Body)
* Logical I/O (Server performance on Logical I/O of: Current Read, Consistent Read, Block Change)
* Physical I/O (Redo Writes, Datafile Writes, Datafile Reads)
* PGA
* SGA (In particular; Fixed Buffer, Java Pool, Large Pool, Log Buffer, Shared Poolm Buffer Cache)
* Shared Pool (Pool Dictionary Cache, Pool Free Memory, Library Chache, SQL Area, MISC.)
* Pin Hit Ratio (Oracle library cache pin are caused by contention with the library cache, the area used to store SQL executables for re-use)
* Sessions / Processes
* Sessions (Active Sessions, Inactive Sessions, System Sessions)
* DBSize/DBFileSize (DBSize size of database really used space and of Filesize)

[[Image:Orabbix_ARCHIVELOG.png|frame|none|alt=Orabbix Archivelog|Fig. 2 - Orabbix Archivelog]]
[[Image:Orabbix_DBSIZEFILESIZE.png|frame|none|alt=Orabbix DBFileSize|Fig. 3 - Orabbix DBFileSize]]
[[Image:Orabbix_EVENTWAITS.png|frame|none|alt=Orabbix Events Waits|Fig. 4 - Orabbix Events Waits]]
[[Image:Orabbix_SHAREDPOOL.png|frame|none|alt=Orabbix Shared Pool|Fig. 5 - Orabbix SHared Pool]]
[[Image:Orabbix_SGA.png|frame|none|alt=Orabbix SGA|Fig. 6 - Orabbix SGA]]
[[Image:Orabbix_PINHITRATIO.png|frame|none|alt=Orabbix Pin Hit Ratio|Fig. 7 - Orabbix Pin Hit Ratio]]
[[Image:Orabbix_SESSIONS.png|frame|none|alt=Orabbix Sessions|Fig. 8 - Orabbix Sessions]]
[[Image:Orabbix_SESSIONPROCESS.png|frame|none|alt=Orabbix Sessions Processes|Fig. 9 - Orabbix Sessions Processes]]
[[Image:Orabbix_PGA.png|frame|none|alt=Orabbix PGA|Fig. 10 - PGA]]
[[Image:Orabbix_LIO.png|frame|none|alt=Orabbix Logical I/O|Fig. 11 - Logical I/O]]
[[Image:Orabbix_PHIO.png|frame|none|alt=Orabbix Physical I/O|Fig. 12 - Physical I/O]]

==Orabbix Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the Orabbix plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=13666 
Latest here: http://www.zabbix.com/forum/showthread.php?t=16391

=Distribution=
You can find the latest versions of Orabbix at the locations listed below: 

http://www.smartmarmot.com/product/orabbix/download/ 
or 
https://sourceforge.net/projects/orabbix/ 

==Requirements==
To use Orabbix, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested Oracle host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested Oracle Versions:
* 10g
* 10.2

IMPORTANT
You do NOT need to install an Oracle client of any kind for Orabbix to work.
Orabbix uses Java objects and connection strings to connect to the Oracle Database, and as such doesn’t require an Oracle client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x Oracle Server. If you are planning on monitoring an Oracle instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring Orabbix to monitor a new installation or setup of Oracle. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download Orabbix to your Zabbix Server
* On your Zabbix server, unzip Orabbix to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for Orabbix to access your Oracle Database. You can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
– 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

'''NOTE''' : If you are using Oracle 11g, you will need to add the following:

exec dbms_network_acl_admin.create_acl(acl => 'resolve.xml',description => 'resolve acl', principal =>'ZABBIX', is_grant => true, privilege => 'resolve');
exec dbms_network_acl_admin.assign_acl(acl => 'resolve.xml', host =>'*');
commit;

You can verify the above is correct by running:
select utl_inaddr.get_host_name('127.0.0.1') from dual;

* For this example on RedHat, run:
chkconfig -add orabbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/orabbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or Oracle instance name'''.

=Configuration=
Now we need to configure your Orabbix setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and Oracle.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
Orabbix can also be configured to send your Oracle data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating Orabbix data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===OrabbixDaemon===
Entries under this tag allow you to set your Orabbix Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the Orabbix Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by Orabbix, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''OrabbixDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''OrabbixDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the Orabbix Daemon, it is possible to clone Orabbix and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, Orabbix will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the Oracle Database. This string invokes a Java Database Connector (JDBC) to your Oracle Databases, and as such does not need the Oracle Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the Oracle (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each Oracle Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through Orabbix against your Oracle instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for Orabbix to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want Orabbix to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, Orabbix would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, Orabbix would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use Orabbix/FAQ=

'''How do I start/stop the Daemon?''' 
To start the Orabbix Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the Orabbix Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The Orabbix daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.Orabbix.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM) \
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “OrabbixDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
Orabbix is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007

Orabbix

2011-10-28T14:15:43Z

Admin: /* How to Use Orabbix/FAQ */

='''ORABBIX'''=
[[File:orabbix_logo.png]]
='''Authors'''=
''Andrea Dalle Vacche'' 
''Jason Chatfield''

='''Download & Installation Instructions'''=

='''About Orabbix'''=
==Product Description==
Orabbix is a plugin designed to work with Zabbix Enterprise Monitor to provide multi-tiered monitoring, performance and availability reporting and measurement for Oracle Databases, along with server performance metrics. 
It provides an effective mechanism to acquire data from numerous Oracle instances, and in turn provides this information for monitoring and performance metrics to your Zabbix server. You can then utilize the reporting capabilities of Zabbix for all data collected, and provide analysis such as graphs and service level agreement metrics for stakeholders. 
The current distribution contains a set of pre-defined templates which incorporate alerting and graphing capabilities from initial deployment. However these can be fine tuned to suit your needs and data/monitoring requirements. 
[[Image:Orabbix_architecture.png|frame|none|alt=Orabbix Architecture|Fig. 1 - Orabbix Architecture]]

=='''What can it monitor?'''==
Below are some examples of what Orabbix is capable of monitoring:
* DB Version (i.e. Validity of package) 
* Archiving (Archive log production with trend analysis) 
* Event Waits (Files I/O, single block read, multi-block read, direct path read, SQLNet Messages, Control file I/O, Log Write)
* Hit Ratio (Hit Ratio on Triggers, Tables/Procedures, SQL Area, Body)
* Logical I/O (Server performance on Logical I/O of: Current Read, Consistent Read, Block Change)
* Physical I/O (Redo Writes, Datafile Writes, Datafile Reads)
* PGA
* SGA (In particular; Fixed Buffer, Java Pool, Large Pool, Log Buffer, Shared Poolm Buffer Cache)
* Shared Pool (Pool Dictionary Cache, Pool Free Memory, Library Chache, SQL Area, MISC.)
* Pin Hit Ratio (Oracle library cache pin are caused by contention with the library cache, the area used to store SQL executables for re-use)
* Sessions / Processes
* Sessions (Active Sessions, Inactive Sessions, System Sessions)
* DBSize/DBFileSize (DBSize size of database really used space and of Filesize)

[[Image:Orabbix_ARCHIVELOG.png|frame|none|alt=Orabbix Archivelog|Fig. 2 - Orabbix Archivelog]]
[[Image:Orabbix_DBSIZEFILESIZE.png|frame|none|alt=Orabbix DBFileSize|Fig. 3 - Orabbix DBFileSize]]
[[Image:Orabbix_EVENTWAITS.png|frame|none|alt=Orabbix Events Waits|Fig. 4 - Orabbix Events Waits]]
[[Image:Orabbix_SHAREDPOOL.png|frame|none|alt=Orabbix Shared Pool|Fig. 5 - Orabbix SHared Pool]]
[[Image:Orabbix_SGA.png|frame|none|alt=Orabbix SGA|Fig. 6 - Orabbix SGA]]
[[Image:Orabbix_PINHITRATIO.png|frame|none|alt=Orabbix Pin Hit Ratio|Fig. 7 - Orabbix Pin Hit Ratio]]
[[Image:Orabbix_SESSIONS.png|frame|none|alt=Orabbix Sessions|Fig. 8 - Orabbix Sessions]]
[[Image:Orabbix_SESSIONPROCESS.png|frame|none|alt=Orabbix Sessions Processes|Fig. 9 - Orabbix Sessions Processes]]
[[Image:Orabbix_PGA.png|frame|none|alt=Orabbix PGA|Fig. 10 - PGA]]
[[Image:Orabbix_LIO.png|frame|none|alt=Orabbix Logical I/O|Fig. 11 - Logical I/O]]
[[Image:Orabbix_PHIO.png|frame|none|alt=Orabbix Physical I/O|Fig. 12 - Physical I/O]]

==Orabbix Author==
'''Andrea Dalle Vacche:''' http://www.smartmarmot.com

=History=
You can read about the history and evolution of the Orabbix plug-in in these threads below:

Original here: http://www.zabbix.com/forum/showthread.php?t=13666 
Latest here: http://www.zabbix.com/forum/showthread.php?t=16391

=Distribution=
You can find the latest versions of Orabbix at the locations listed below: 

http://www.smartmarmot.com/product/orabbix/download/ 
or 
https://sourceforge.net/projects/orabbix/ 

==Requirements==
To use Orabbix, you will require the following on your Zabbix Server:
* Zabbix 1.8.x Server
* Java Runtime Environment 6

Current known successfully tested Oracle host platforms:
* RHEL5.X (CentOS 5.4 & 5.5)
* Windows 2003 (with Java SE 1.6)
* HP-UX 11.31
* AIX 5.3

Currently known tested Oracle Versions:
* 10g
* 10.2

IMPORTANT
You do NOT need to install an Oracle client of any kind for Orabbix to work.
Orabbix uses Java objects and connection strings to connect to the Oracle Database, and as such doesn’t require an Oracle client to be installed on your Zabbix Server.
Installation

==Assumptions==
The installation instructions have been created based on instructions for most *nix deployments (i.e. RHEL/CentOS), and is assumed that any alterations required for your specific environment are to be taken into account accordingly.

This guide is based upon there being two (2) Hosts, 1x Zabbix Server and 1x Oracle Server. If you are planning on monitoring an Oracle instance that is running on your Zabbix Server, the steps are the same, with minor adjustments required for your connection information.

The steps also assume you are configuring Orabbix to monitor a new installation or setup of Oracle. The installation steps will have you GRANT access for the Zabbix user to all tables, and this will include any USER tables present at the time of execution. If you do not want Zabbix to have access to specific tables or resources within your database, you will need to set a DENY to the Zabbix users access as required. Consult your DBA for details, as this is beyond the scope of these instructions.

==Steps for Installation==

* Download Orabbix to your Zabbix Server
* On your Zabbix server, unzip Orabbix to: /opt/orabbix
* Copy file /opt/orabbix/init.d/orabbix to /etc/init.d/orabbix
* Grant execute permissions to the following files:
/etc/init.d/orabbix
/opt/orabbix/run.sh
* Create a User (ZABBIX) for Orabbix to access your Oracle Database. You can use the following script:

CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>
DEFAULT TABLESPACE SYSTEM
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
– 2 Roles for ZABBIX
GRANT CONNECT TO ZABBIX;
GRANT RESOURCE TO ZABBIX;
ALTER USER ZABBIX DEFAULT ROLE ALL;
– 5 System Privileges for ZABBIX
GRANT SELECT ANY TABLE TO ZABBIX;
GRANT CREATE SESSION TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;
GRANT UNLIMITED TABLESPACE TO ZABBIX;
GRANT SELECT ANY DICTIONARY TO ZABBIX;

'''NOTE''' : If you are using Oracle 11g, you will need to add the following:

exec dbms_network_acl_admin.create_acl(acl => 'resolve.xml',description => 'resolve acl', principal =>'ZABBIX', is_grant => true, privilege => 'resolve');
exec dbms_network_acl_admin.assign_acl(acl => 'resolve.xml', host =>'*');
commit;

You can verify the above is correct by running:
select utl_inaddr.get_host_name('127.0.0.1') from dual;

* For this example on RedHat, run:
chkconfig -add orabbix
* Verify with:
chkconfig -list
* Create a Host entry in Zabbix for the DB Instance/s you are planning to monitor, and import the templates found at: /opt/orabbix/template

Please note, instructions for this step can be found in the Zabbix Manual at
http://www.zabbix.com/documentation.php
With this step, '''ensure the name of your host in Zabbix is the same name of the SID or Oracle instance name'''.

=Configuration=
Now we need to configure your Orabbix setup. The tags below are listed as they will appear within the respective configuration files. The first you will need to modify is your config.props file to define your connection properties for Zabbix and Oracle.

==config.props==
The config.props file can be found at /opt/orabbix/conf/config.props

''ZabbixServerList''
#comma separed list of Zabbix servers
The settings under this tag allow you to configure your Zabbix Server information.
Orabbix can also be configured to send your Oracle data to multiple Zabbix servers.

This can be beneficial for distributed monitoring scenarios, server migrations or replicating Orabbix data to a Disaster Recovery site or server.

Replace with your Zabbix Server info where appropriate;

''ZabbixServerList''=ZabbixServer1,ZabbixServer2
''ZabbixServer1.Address''=192.168.0.1
''ZabbixServer1.Port''=10051

''ZabbixServer2.Address''=192.168.0.2
''ZabbixServer2.Port''=10051

===OrabbixDaemon===
Entries under this tag allow you to set your Orabbix Daemon parameters.

#MaxThreadNumber should be >= than the number of your databases
Set the number of threads the Orabbix Daemon should have inside his internal pool of DB Jobs. This number should be at least equal to (or more than) then number of databases monitored by Orabbix, now this parameter if not set is automatically calculated.

e.g. For 50 Databases, we are using 100 threads

''OrabbixDaemon.MaxThreadNumber''=100

#pidFile
Next you can set the location of the Daemons PID file. Default location is: /opt/orabbix/logs

''OrabbixDaemon.PidFile''=./logs/orabbix.pid

'''NOTE:''' Relative path is permitted here

'''TIP:''' With the features of the Orabbix Daemon, it is possible to clone Orabbix and use different configurations.
As such, it is therefore possible to have one Daemon that checks your TEST databases, another iteration that checks your
DEVELOPMENT databases and a third that checks your PRODUCTION databases, each with different timings and check loops!

''DatabaseList''

This is where you define your database instances. You can specify more than one instance here, separated using a comma.

DatabaseList=EXAMPLE1,EXAMPLE2

'''NOTE: The names of the instances must match those you have specified as your HOST name in Zabbix'''

#Configuration of Connection pool
From here, you will configure settings that are specific to the connection pool.
As the comments in config.props suggest, if you do not specify these values, Orabbix will use default values which have been hard-coded.

#Maximum number of active connection inside pool
Set the maximum number of connections that can be allocated to this pool at any time,or alternatively set a negative value for no limit.

DatabaseList.MaxActive=10

#The maximum number of milliseconds
Here you define how long that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or set the value <= 0 to wait indefinitely.

DatabaseList.MaxWait=100

Also under the same section, you can define the maximum number of connections that can remain idle within the connection pool, without being released. Alternatively, you can set a negative value for no limit.

DatabaseList.MaxIdle=1

'''TIP:''' You can specify the Database connection parameters for each database you wish to monitor individually, underneath your Database Connection Parameters. This allows you to customise your connection settings based on the Database constraints I.e one connection pool for your PRODUCTION DB and another for you TEST DB, for example;

DB1.MaxActive=10
DB1.MaxWait=100
DB1.MaxIdle=1

Note that any settings defines this way will override the general settings for your generic connection pool.

===Database Connection Parameters===

This section sets your connection string to the Oracle Database. This string invokes a Java Database Connector (JDBC) to your Oracle Databases, and as such does not need the Oracle Client to be installed.

#define here your connection string for each database
Here you will define the connection string. These are formatted as:
DBName.Url(as specified in your DatabaseList) followed by the jdbc string and your Database Server information.
EXAMPLE1.Url=jdbc:oracle:thin:@SERVER1.EXAMPLE.COM:1521:DB1

Set your Database username and password below. e.g.

EXAMPLE1.User=zabbix
EXAMPLE1.Password=zabbix_password

'''TIP:''' Setting connections to multiple databases is made easy by adding more connection strings, with their corresponding credentials. Example given below.

EXAMPLE2.Url=jdbc:oracle:thin:@server2.domain.example.com:<LISTENER_PORT>:EXAMPLE2
EXAMPLE2.User=zabbix
EXAMPLE2.Password=zabbix_password

EXAMPLE3.Url=jdbc:oracle:thin:@server3.domain.example.com:<LISTENER_PORT>:EXAMPLE3
EXAMPLE3.User=zabbix
EXAMPLE3.Password=zabbix_password

'''NOTE:'''After these entries, you can set your MaxActive, MaxWait and MaxIdle for the individual database connections if you so wish.

There is a pair of default parameter:

DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the following pair

<DB_NAME>.User and <DB_NAME>.User
It is only possible to override Username or Password.

===Query List File===

This defines where the file containing the Oracle (SQL) queries can be found. This is a customisable file. You can find the query parameter file at:

QueryListFile=/opt/orabbix/conf/query.props
you can also specify :
<DBNAME>.QueryListFile=./confQueryTest.props this file specify the query file of a database relative path are allowed

'''TIP:''' This is really useful to use different query file for different databases or to have a pool of query file one for each Oracle Release (if you have different release) and/or to have different query files for Production environment, Test environment, Developement environment etc.. 
the following parameter

<DB_NAME>.ExtraQueryListFile ==./confQueryTest_2.props

adds another custom query to the default query file.
If there are duplicates the ExtraQueryListFile will override them.

==query.props==
Configuration of query.props file

The query.props file can be modified or added to, so you can supply your own customised queries through Orabbix against your Oracle instances/databases. Each query created has an associated 'Item' or item name that Zabbix will use to identify the query.

'''NOTE:''' Item names must be unique.

The configurable items are formatted as follows.

You have to set the query name under the QueryList in the query.props file. Each query name is comma separated. For example;

QueryList=queryName1,queryName2,queryName3

You must identify the query by the unique item name you specified in the QueryList, followed by '.Query' for Orabbix to recognize that this is the query string. Its important to remember NOT to add the semi-colon “;” to the end of your custom query.

customQueryItemName.Query=yourQueryHere

Now you can define what you want Orabbix to return to your Zabbix Server if no data is found for your query.

customQueryItemName.NoDataFound=none

'''TIP:''' In the example above, Orabbix would send the string “none” to the Zabbix Server.

You can specify if you want a different execution period for your query
customQueryItemName.Period=<Express a period in minute>
'''TIP:'''You can change the execution time of dbversion that don’t change often

Next you can specify a query that will be executed and if return RaceCondiftionValue the query customQueryItemName is executed otherwise is skipped

customQueryItemName.ACTIVE=[true|false] if true query is executed otherwise skipped

archive.Query=select round( A.LOGS*B.AVG/1024/1024/10 ) \
from ( SELECT COUNT (*) LOGS FROM V$LOG_HISTORY WHERE \
FIRST_TIME >= (sysdate -10/60/24)) A, \
( SELECT Avg(BYTES) AVG, Count(1), Max(BYTES) Max_Bytes,Min(BYTES) Min_Bytes FROM v$log) B

archive.RaceConditionQuery=select value \
from \
v$parameter where name='log_archive_start'

archive.RaceConditionValue=FALSE

'''TIP:'''In the example above, Orabbix would execute “archive.Query” only if the query “archive.RaceConditionQuery” return the value “archive.RaceConditionValue”. Pratically the “Archive” query is execute only if database is in arhivelogmode (Parameter “log_archive_start” set to TRUE)

<QueryName>.Trim=[true|false]
if true the resultset is trimmed (default is true)

<QueryName>.AddSpaces=[true|false]
if true the add a space between columns of resultset(default is true)

<QueryName>.ExcludeColumnsList=[1,2,3,..n]
exclude from result set the 1st, the 2nd etc.. columns from resultset
<QueryName>.Period

<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing such will "clean" the graphs generated in Zabbix with a "set" value.

Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
<QueryName>.ExtraQueryListFile = <VALUE>

on query's properties file I've added the following parameter:
<QUERY_NAME>.WhenNotAlive = <VALUE>

with these parameter you can define a default username and password for
all the database.
DefaultUser = <USERNAME>
DefaultPassword = <PASSWORD>
this default parameter can be overridden using the couple
<DB_NAME>.User and <DB_NAME>.User
Is possible to override only Username or Password.

the following parameter
<DB_NAME>.ExtraQueryListFile =
add another custom query to a default query file.
if there are duplicate the ExtraQueryListFile will override them.

the following parameter
<QUERY_NAME>.WhenNotAlive = <VALUE>
is used to specify a value or a string to send if a database is not working,
doing so you are going to "clean" the graphs generated in Zabbix with a "set" value.

=How to Use Orabbix/FAQ=

'''How do I start/stop the Daemon?''' 
To start the Orabbix Daemon, simply run: 
/etc/init.d/orabbix start 
To stop the Orabbix Daemon, simply run: 
/etc/init.d/orabbix start 

'''How does Logging work?''' 
The Orabbix daemon outputs its log file to the default location of /opt/orabbix/logs/ 

'''How to modify Log format?''' 
Logging properties can be modified by making your required changes to 
/opt/orabbix/conf/log4j.properties

The property setting responsible for defining the output location is: 
log4j.appender.Orabbix.File=logs/orabbix.log

'''TIP:'''From this properties file, you can modify the location, file name and log format as desired.
For additional information, please refer to the official log4j documentation, found at: http://logging.apache.org/log4j/1.2/index.html

'''Is there a way for orabbix to connect to RAC or DataGuard?''' 
Yes is possible. 
e.g. 
If you have two host RAC1 and RAC2 and one instance RACINST 
you should write the connection string as follow: 
RACINST.Url=jdbcracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=RAC1.EXAMPLE.COM)
(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=RAC2.EXAMPLE.COM)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=RACINST)))

==What can I modify without restarting the daemon?==
The parameters that are dynamically read at each iteration of “OrabbixDaemon.Sleep” are as follows;

* Any Query added to query.props
* Modifications to config.props
* Database List

Currently, the only known items that don't dynamically update are the ZabbixDaemon.MaxThreadNumber, and changes to Connection Pool info.

=LICENCE Information=
[[Image:orabbix_logo.png|left]]
Orabbix is released under and according to the 
'''GNU GENERAL PUBLIC LICENSE''' 
Version 3, 29 June 2007