Download & About Orabbix Product Description Ora bbix is a plugi n designed to work wi performance and availability reporting metrics. t provides an effective mechanism to information for moni to ring an d perform ca pa bilities of Zabbix for all data co llec metrics for stakeholders. "he current distribution contains a set capabi lit ie s from in it ia l deplo yment. #o re!uirements. JDBC JDBC JDBC JDB Documentation relative to Release: 1. Authors: Andrea Dalle VaccJason ChatfiInstallation Ins th Zabbix Enterprise Monitor to provide m nd measuremen t for Oracle Databases, al c!uire data from numerous Oracle instanc ance metr ics to your Zabbix server. $ou c ed, and provide analysis such a s graphs a f pre%defined templates which incorporate wever these can be fine tuned to suit your Zabbix Protocol Fig. 1 - Orabbix Architecture.2 e ld ructions lti%tiered monitoring, ong with server performance es, and in turn provides this n then utili'e the reporting d service level agreement alerting and graphing needs and data&monitoring
(elow are some examples of what Orabbix is capable of monitoring)* D( +ersion i.e. +alidity of package-* rchiving rchive log production with trend analysis-
* 1hared 7ool 7ool Dictionary 5ache, 7ool 0ree Memory, 3ibrary 5hache, 123 rea, M15.-* 7in #it 6atio Oracle library cache pin are caused by contention with the library cache, the areaused to store 123 executables for re%use-* 1essions & 7rocesses
*
1essions ctive 1essions, nactive 1essions, 1ystem 1essions-* D(1i'e&D(0ile1i'e D(1i'e si'e of database really used space and of 0ilesi'e-
Fig. 1 – Archivelog Fig. 2 - DBSize and DBFileSize
Requirements"o use Orabbix, you will re!uire the following on your Zabbix 1erver)
* Zabbix =.B.x 1erver* :ava 6untime Environment ?
5urrent known successfully tested Oracle host platforms)* 6#E3C. 5entO1 C. F C.C-
*
/indows GHH> with :ava 1E =.?-* #7%I ==.>=* C.>
5urrently known tested Oracle +ersions)
* =Hg* =H.G
** IMPORTANT**$ou do 4O" need to install an Oracle client of any kind for Orabbix to work.
Orabbix uses :ava obAects and connection strings to connect to the Oracle Database, and as such doesnJt
re!uire an Oracle client to be installed on your Zabbix 1erver.
Installation
Assumptions"he installation instructions have been created based on instructions for most Knix deployments i.e.6#E3&5entO1-, and is assumed that any alterations re!uired for your specific environment are to be taken
into account accordingly.
"his guide is based upon there being two G- #osts, =x Zabbix 1erver and =x Oracle 1erver. f you areplanning on monitoring an Oracle instance that is running on your Zabbix 1erver, the steps are the same,with minor adAustments re!uired for your connection information.
"he steps also assume you are configuring Orabbix to monitor a new installation or setup of Oracle. "heinstallation steps will have you 864" access for the Zabbix user to all tables, and this will include any I1E6tables present at the time of execution. f you do not want Zabbix to have access to specific tables or
resources within your database, you will need to set a DE4$ to the Zabbix users access as re!uired. 5onsultyour D( for details, as this is beyond the scope of these instructions.
teps !or Installation
=. Download Orabbix to your Zabbix 1erverG. On your Zabbix server, un'ip Orabbix to) &opt&orabbix>. 5opy file &opt&orabbix&init.d&orabbix to &etc&init.d&orabbix. 8rant execute permissions to the following files)
* &etc&init.d&orabbix* &opt&orabbix&run.sh
C. 5reate a Iser Z((- for Orabbix to access your Oracle Database. $ou can use the following script)
CREATE USER ZABBIX
IDENTIFIED BY <REPLACE WITH PASSWORD>DEFAULT TABLESPACE SYSTEMTEMPORARY TABLESPACE TEMPPROFILE DEFAULTACCOUNT UNLOCK; – 2 Roles for ZABBIXGRANT CONNECT TO ZABBIX;GRANT RESOURCE TO ZABBIX;ALTER USER ZABBIX DEFAULT ROLE ALL; – 5 System Privileges for ZABBIXGRANT 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 : f you are using Oracle ==g, you will need to add the following)
B. 5reate a #ost entry in Zabbix for the D( nstance&s you are planning to monitor, and import thetemplates found at) &opt&orabbix&template
KK 7lease note, instructions for step B- can be found in the Zabbix Manual athttp)&&www.'abbix.com&documentation.php
/ith this step B-, ensure the name of your host in Zabbix is the same name of the 1D or Oracle
instance name.
"on!i#uration4ow we need to configure your Orabbix setup. "he tags below are listed as they will appear within therespective configuration files. "he first you will need to modify is your config.props file to define yourconnection properties for Zabbix and Oracle.
"he config.props file can be found at /opt/orabbix/conf/config.props
$abbixer%erist
'comma separed list o! $abbix ser%ers
"he settings under this tag allow you to configure your Zabbix 1erver information.Orabbix can also be configured to send your Oracle data to multiple Zabbix servers.
TIP: This can be beneficial for distributed monitoring scenarios, server migrations or replicatingOrabbix data to a Disaster Recovery site or server.
6eplace with your Zabbix 1erver info where appropriate9
Entries under this tag allow you to set your Orabbix Daemon parameters.
'(ax)hread*umber should be +, than the number o! your databases1et the number of threads the Orabbix Daemon should have inside his internal pool of D( :obs. "his
number should be at least e!ual to or more than- then number of databases monitored by Orabbix, now thisparameter if not set is automatically calculated.
e.g. 0or CH Databases, we are using =HH threads
Orabbix+ae,on.MaxT-rea%N,ber!"))
'pid-ile4ext you can set the location of the Daemons 7D file. Default location is) &opt&orabbix&logs
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 T!T databases,another iteration that checks your D"#O$%&T databases and a third that checks your $ROD'(T)O&
databases, each *ith different timings and check loops+
Databaseist
'put here your databases in a comma separated list
"his is where you define your database instances. $ou can specify more than one instance here,separated using a comma.
+atabaseist!E1AMPE"#E1AMPE$
KK 4ote) "he names of the instances must match those you have specified as your #O1" name inZabbix
'"on!i#uration o! "onnection pool0rom here, you will configure settings that are specific to the connection pool.s the comments in config.props suggest, if you do not specify these values, Orabbix will use default
values which have been hard%coded.
'(aximum number o! acti%e connection inside pool1et the maximum number of connections that can be allocated to this pool at any time,or alternatively
set a negative value for no limit.
+atabaseist.MaxActive!")
')he maximum number o! milliseconds#ere 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 < H to wait indefinitely.
+atabaseist.Max2ait!"))
lso under the same section, you can define the maximum number of connections that can remain idle
within the connection pool, without being released. lternatively, you can set a negative value for no limit.
+atabaseist.MaxI%0e!"
TIP: ou can specify the Database connection parameters for each database you *ish to monitorindividually, underneath your Database (onnection $arameters. This allo*s you to customise your connectionsettings based on the Database constraints ).e one connection pool for your $ROD'(T)O& D- and another for
you T!T D-, for example
D-/.%axActive0/1
D-/.%axWait0/11D-/.%ax)dle0/
&ote that any settings defines this *ay *ill override the general settings for your genericconnection pool.
"his section sets your connection string to the Oracle Database. "his string invokes a :ava Database5onnector :D(5- to your Oracle Databases, and as such does not need the Oracle 5lient to be installed.
'de!ine here your connection strin# !or each database
#ere you will define the connection string. "hese are formatted as) D(4ame.Irlas specified in yourDatabase#ist - followed by the Adbc string and your Database 1erver information.
KK 4ote) fter these entries, you can set your Maxctive, Max/ait and Maxdle for the individual
database connections if you so wish.
"here is a pair of default parameter)
+efa0t3ser ! 93SERNAME+efa0tPass5or% ! 9PASS2OR+
this default parameter can be overridden using the following pair
9+<6NAME.3ser an% 9+<6NAME.3ser
t is only possible to override Isername or 7assword.
1uery ist -ile
"his defines where the file containing the Oracle 123- !ueries can be found. "his is a customisable file. $oucan find the !uery parameter file at)
=er>isti0e!/opt/orabbix/conf/?er>.props you can also specify )9+<NAME.=er>isti0e!./conf=er>Test.props t-is fi0e specif> t-e ?er> fi0e of a %atabasere0ative pat- are a00o5e%
T)$3 "his is really useful to use different !uery file for different databases or to have a pool of !uery file one
for each Oracle 6elease if you have different release- and&or to have different !uery files for 7roductionenvironment, "est environment, Developement environment etc..the following parameter
9+<6NAME.Extra=er>isti0e !!./conf=er>Test6$.propsadds another custom !uery to the default !uery file.
f there are duplicates the Extra2uery3ist0ile will override them.
"he !uery.props file can be modified or added to, so you can supply your own customised !ueries throughOrabbix against your Oracle instances&databases. Each !uery created has an associated NtemN or item namethat Zabbix will use to identify the !uery.
KK 4ote) tem names must be uni!ue.
"he configurable items are formatted as follows.
'1ueryist$ou have to set the !uery name under the 2uery3ist in the !uery.props file. Each !uery name is
comma separated. 0or example9
=er>ist!?er>Na,e"#?er>Na,e$#?er>Na,e;
'1uery$ou must identify the !uery by the uni!ue item name you specified in the 2uery3ist, followed by
N.2ueryN for Orabbix to recogni'e that this is the !uery string. ts important to remember 4O" to add the
semi%colon 9P to the end of your custom !uery.
csto,=er>Ite,Na,e.=er>!>or=er>@ere
4ow you can define what you want Orabbix to return to your Zabbix 1erver if no data is found for your!uery.
csto,=er>Ite,Na,e.No+ataon%!none
T)$3 )n the example above, Orabbix *ould send the string 8none9 to the :abbix !erver.
$ou can specify if you want a different execution period for your !uery
csto,=er>Ite,Na,e.Perio%!9Express a perio% in ,inte
T)$3ou can change the execution time of dbversion that don;t change often
4ext you can specify a !uery that will be executed and if return Race(ondiftion"alue the !uery
custom<uery)tem&ame is executed otherwise is skipped
csto,=er>Ite,Na,e.ATIBE!CtreDfa0se if true !uery is executed otherwise skipped
arc-ive.=er>!se0ect ron%F A.OGS*<.ABG/")$H/")$H/") fro, F SEET O3NT F* OGS ROM BJOG6@ISTORK 2@ERE
T)$3 )n the example above, Orabbix *ould execute 8archive.<uery9 only if the =uery
8archive.Race(ondition<uery9 return the value 8archive.Race(ondition"alue9. $ratically the 8Archive9 =uery isexecute only if database is in arhivelogmode >$arameter 8log?archive?start9 set to TR'@
9=er>Na,e.Tri,!CtreDfa0se
if true the resultset is trimmed >default is true@
9=er>Na,e.A%%Spaces!CtreDfa0se if true the add a space bet*een columns of resultset>default is true@
9=er>Na,e.Exc0%eo0,nsist!C"#$#;#..n
exclude from result set the /st, the 7nd etc.. columns from resultset9=er>Na,e.Perio%
9=3ERK6NAME.2-enNotA0ive ! 9BA3Eis used to specify a value or a string to send if a database is not *orking,doing such *ill clean the graphs generated in :abbix *ith a set value.
Added the following parameter on main configuration file:
DefaultUser = <USERNAME>
Defaultassword = <ASS!"RD>
9 =er>Na,e .Extra=er>isti0e ! 9BA3E
on #uer$%s properties file &%'e added the following parameter:
<(UER)*NAME>+!henNotAli'e = <,A-UE>
with these parameter $ou can define a default username and password for
all the data.ase+
DefaultUser = <USERNAME>
Defaultassword = <ASS!"RD>
this default parameter can .e o'erridden using the couple
<D/*NAME>+User and <D/*NAME>+User
&s possi.le to o'erride onl$ Username or assword+
the following parameter
<D/*NAME>+E0tra(uer$-ist1ile =
add another custom #uer$ to a default #uer$ file+if there are duplicate the E0tra(uer$-ist1ile will o'erride them+
the following parameter
<(UER)*NAME>+!henNotAli'e = <,A-UE>
is used to specif$ a 'alue or a string to send if a data.ase is not wor2ing3
doing so $ou are going to 4clean4 the graphs generated in 5a..i0 with a 4set4 'alue+
How to 0se Orabbix2-A1
How do I start2stop the Daemon?
"o start the Orabbix Daemon, simply run)/etc/init.%/orabbix start
"o stop the Orabbix Daemon, simply run)/etc/init.%/orabbix start
How does o##in# wor3?
"he Orabbix daemon outputs its log file to the default location of /opt/orabbix/0ogs/
3ogging properties can be modified by making your re!uired changes to9 /opt/orabbix/conf/0ogH7.properties
"he property setting responsible for defining the output location is9 logB2.appender.Orabbix.Cile0logsorabbix.log
T)$3 Crom this properties file, you can modify the location, file name and log format as desired. Coradditional information, please refer to the official logB2 documentation, found at http)&&logging.apache.org&logA&=.G&index.html
Is there a way !or orabbix to connect to RA" or Data4uard?
es is possible.
e.g.
)f you have t*o host RA(/ and RA(7 and one instance RA()&!T
