Aller au contenu principal

Oracle Database

Contenu du pack​

Modèles​

Le connecteur de supervision Oracle Database apporte un modèle d'hôte :

  • App-DB-Oracle-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescriptionDécouverte
Connection-NumberApp-DB-Oracle-Connection-Number-customContrôle permettant de vérifier le nombre de connexions au serveur Oracle
Connection-TimeApp-DB-Oracle-Connection-Time-customContrôle permettant de vérifier la durée de connexion au serveur. Ce temps est donné en secondes
Corrupted-BlocksApp-DB-Oracle-Corrupted-Blocks-customContrôle permettant de vérifier le nombre de blocks corrompus du serveur.
Datacache-HitratioApp-DB-Oracle-Datacache-Hitratio-customContrôle permettant de vérifier le 'Data Buffer Cache Hit Ratio' du serveur. Aucunes alertes par défaut
Process-UsageApp-DB-Oracle-Process-Usage-customContrôle permettant de vérifier l'utilisation des 'process' Oracle
Rman-Backup-ProblemsApp-DB-Oracle-Rman-Backup-Problems-customContrôle permettant de vérifier les erreurs de sauvegarde 'RMAN' du serveur durant les 3 derniers jours
Session-UsageApp-DB-Oracle-Session-Usage-customContrôle permettant de vérifier l'utilisation des sessions
Tablespace-Usage-GlobalApp-DB-Oracle-Tablespace-Usage-Global-customContrôle permettant de vérifier l'utilisation des 'tablespaces' du serveurX
TnspingApp-DB-Oracle-Tnsping-customContrôle permettant de vérifier la connexion à un 'listener' distant

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-DB-Oracle-custom est utilisé.

Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.

Règles de découverte​

Découverte de service​

Nom de la règleDescription
App-DB-Oracle-ASM-Diskgroup-Usage-NameDiscover the disk partitions and monitor space occupation
App-DB-Oracle-Tablespaces-Usage-Name

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

MétriqueUnité
dg#statusN/A
dg#offline-disksN/A
dg#usageN/A
dg#usage-failureN/A

Concerne les modèles de service suivants : ASM-Diskgroup-Usage-Generic-Name, ASM-Diskgroup-Usage-Global

Pour obtenir ce nouveau format de métrique, incluez la valeur --use-new-perfdata dans la macro de service EXTRAOPTIONS.

Prérequis​

Dépendances​

dnf install gcc wget

Oracle instant client​

Se connecter sur Instant Client Downloads. Choisir le groupe de paquets correspondant au système d'exploitation du collecteur et télécharger les paquets (RPM) suivants :

  • oracle-instantclient-basic
  • oracle-instantclient-sqlplus
  • oracle-instantclientdevel

Installer les paquets avec la commande suivante :

rpm -ivh oracle-*.rpm

Bibliothèque Perl pour Oracle​

En tant que root, exécuter :

cd /usr/local/src 
wget https://www.cpan.org/modules/by-module/DBD/DBD-Oracle-1.83.tar.gz 
tar xzf DBD-Oracle-1.83.tar.gz 
cd DBD-Oracle-1.83 
export ORACLE_HOME=/usr/lib/oracle/21/client64
export LD_LIBRARY_PATH=/usr/lib/oracle/21/client64/lib 
export PATH=$ORACLE_HOME:$PATH
export TNS_ADMIN=$ORACLE_HOME/network/admin
perl Makefile.PL -m /usr/share/oracle/21/client64/demo/demo.mk

Le message suivant devrait apparaître :

LD_RUN_PATH=/usr/lib/oracle/21/client64/lib
Using DBD::Oracle 1.83.
Using DBD::Oracle 1.83.
Using DBI 1.641 (for perl 5.026003 on x86_64-linux-thread-multi) installed in /usr/lib64/perl5/vendor_perl/auto/DBI/
Generating a Unix-style Makefile
Writing Makefile for DBD::Oracle

Si vous rencontrez une erreur durant l'étape du Makefile.PL, essayez de spécifier explicitement une version d'Oracle fonctionnelle pour la compilation (cela n'aura pas d'impact sur le fonctionnement): perl Makefile.PL -V 12.1.0 -m /usr/share/oracle/21/client64/demo/demo.mk

Compiler la bibliothèque :

make

Puis l'installer :

make install

Puis créer le fichier : /etc/ld.so.conf.d/oracle.conf. Éditer et ajouter un lien vers la bibliothèque Perl d’Oracle :

cat > /etc/ld.so.conf.d/oracle.conf <<EOF
/usr/lib/oracle/21/client64/lib/
EOF

Mettez à jour le cache avec la commande suivante :

/sbin/ldconfig

Compte d'utilisateur​

La façon la plus sûre de récupérer des informations du serveur Oracle est de créer un utilisateur dédié à Centreon.

Ce compte utilisateur doit avoir la permission de lecture/READ (Oracle 12+) ou de sélection/SELECT (Oracle < 12) sur les tables suivantes :

  • dba_free_space
  • dba_data_files
  • dba_temp_files
  • dba_segments
  • dba_jobs
  • dba_objects
  • DBA_MVIEW_refresh_times
  • dba_indexes
  • dba_ind_partitions
  • dba_ind_subpartitions
  • dba_registry
  • dba_tablespaces
  • DBA_MVIEW_refresh_times
  • DBA_TABLESPACE_USAGE_METRICS
  • v_$sysstat
  • v_$sgastat
  • v_$parameter
  • v_$process
  • v_$session
  • v_$filestat
  • v_$log
  • v_$instance
  • V_$ASM_DISKGROUP
  • v_$database_block_corruption
  • v_$tempstat
  • v_$rowcache
  • v_$system_event
  • v_$recovery_area_usage
  • v_$librarycache
  • v_$sql_monitor
  • v_$resource_limit
  • v_$rman_status
  • v_$backup
  • v_$rman_status
  • v_$rollstat
  • v_$resource_limit
  • v_$tablespace
  • v_$tempfile
  • v_$event_name
  • v_$waitstat

Installer le connecteur de supervision​

Pack​

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Connecteurs > Connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-applications-databases-oracle
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Oracle Database depuis l'interface web et le menu Configuration > Connecteurs > Connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Applications-Databases-Oracle

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte App-DB-Oracle-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
ORACLEUSERNAMEUser name used to connect to the databaseUSERNAME
ORACLEPASSWORDPassword for the defined user namePASSWORD
ORACLEPORTDatabase Server Port1521
ORACLESERVICENAMEDatabase Service Name
ORACLESIDDatabase SIDSID
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
FILTERFilter by name (regexp can be used)
WARNINGWarning threshold80
CRITICALCritical threshold90
WARNINGUSAGEFAILUREWarning threshold
CRITICALUSAGEFAILURECritical threshold
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_oracle.pl \
	--plugin=database::oracle::plugin \
	--hostname='10.0.0.1' \
	--port='1521' \
	--sid='SID' \
	--servicename='' \
	--username='USERNAME' \
	--password='PASSWORD' \
	--mode=rollback-segment-usage \
	--warning-extends='' \
	--critical-extends='' \
	--warning-wraps='' \
	--critical-wraps='' \
	--warning-hit-ratio='' \
	--critical-hit-ratio='' \
	--warning-block-contention='' \
	--critical-block-contention=''  \
	--warning-header-contention='' \
	--critical-header-contention=''

La commande devrait retourner un message de sortie similaire à :

OK: Extends : 7/s Wraps : 21/s Header Contention :  88 % Block Contention :  27 % gets/waits Ratio :  85 % | 'extends'=7/s;;;0;'wraps'=21/s;;;0;'header-contention'=88%;;;0;100'block-contention'=27%;;;0;100'hit-ratio'=85%;;;0;100

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins/centreon_oracle.pl \
	--plugin=database::oracle::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
asm-diskgroup-usage [code]App-DB-Oracle-ASM-Diskgroup-Usage-Generic-Name-custom
App-DB-Oracle-ASM-Diskgroup-Usage-Global-custom
collection [code]Not used in this Monitoring Connector
connected-users [code]App-DB-Oracle-Connection-Number-custom
connection-time [code]App-DB-Oracle-Connection-Time-custom
corrupted-blocks [code]App-DB-Oracle-Corrupted-Blocks-custom
data-files-status [code]App-DB-Oracle-Data-Files-Status-custom
datacache-hitratio [code]App-DB-Oracle-Datacache-Hitratio-custom
dataguard [code]Not used in this Monitoring Connector
dictionary-cache-usage [code]App-DB-Oracle-Dictionary-Cache-Usage-custom
event-waits-usage [code]App-DB-Oracle-Event-Waits-Usage-custom
fra-usage [code]App-DB-Oracle-Fra-Usage-custom
invalid-object [code]App-DB-Oracle-Invalid-Object-custom
library-cache-usage [code]App-DB-Oracle-Library-Cache-Usage-custom
list-asm-diskgroups [code]Used for service discovery
list-tablespaces [code]Used for service discovery
long-queries [code]App-DB-Oracle-Long-Queries-custom
password-expiration [code]Not used in this Monitoring Connector
process-usage [code]App-DB-Oracle-Process-Usage-custom
redolog-usage [code]App-DB-Oracle-Redolog-Usage-custom
rman-backup-age [code]App-DB-Oracle-Rman-Backup-Age-custom
rman-backup-problems [code]App-DB-Oracle-Rman-Backup-Problems-custom
rman-online-backup-age [code]App-DB-Oracle-Rman-Backup-Online-Age-custom
rollback-segment-usage [code]App-DB-Oracle-Rollback-Segment-Usage-custom
session-usage [code]App-DB-Oracle-Session-Usage-custom
sql [code]App-DB-Oracle-Sql-Statement-Generic-custom
sql-string [code]App-DB-Oracle-Sql-Statement-String-Generic-custom
tablespace-usage [code]App-DB-Oracle-Tablespace-Usage-Global-custom
tnsping [code]App-DB-Oracle-Tnsping-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--hostnameHostname to query.
--portDatabase Server Port.
--sidDatabase SID.
--servicenameDatabase Service Name.
--containerChange container (does an alter session set container command).
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--sqlmodeThis plugin offers several ways to query the database (default: dbi). See --list-sqlmode.
--list-sqlmodeList all available sql modes.
--multipleEnable connecting to multiple databases (required by some specific modes such as replication).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Eg: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Eg: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic_in,,percent()
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--datasourceDatabase server information, mandatory if the server's address and port are not defined in the corresponding options. The syntax depends on the database type.
--usernameUser name used to connect to the database.
--passwordPassword for the defined user name.
--connect-optionsAdd connection options for the DBI connect method. Format: name=value,name2=value2,...
--connect-queryExecute a query just after the connection.
--sql-errors-exitExpected status in case of DB error or timeout. Possible values are warning, critical and unknown (default).
--timeoutTimeout in seconds for connection.
--exec-timeoutTimeout in seconds for query execution

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--warning-usageWarning threshold.
--critical-usageCritical threshold.
--warning-usage-failureWarning threshold.
--critical-usage-failureCritical threshold.
--unknown-statusDefine the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{display}
--warning-statusDefine the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{display}
--critical-statusDefine the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{display}
--warning-offline-disksSet warning threshold for offline disks (Default: '(%{offline_disks} > 0 && %{type} eq "extern") || (%{offline_disks} > 1 && %{type} eq "high")'). You can use the following variables: %{offline_disks}, %{type}, %{display}
--critical-offline-disksSet critical threshold for offline disks (Default: '%{offline_disks} > 0 && %{type} =~ /^normal|high$/'). You can use the following variables: %{offline_disks}, %{type}, %{display}
--unitsUnits of thresholds (Default: '%') ('%', 'B').
--freeThresholds are on free space left.
--filter-nameFilter by name (regexp can be used).

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_oracle.pl \
	--plugin=database::oracle::plugin \
	--hostname='10.0.0.1' \
	--help