Plugin Oracle

Visão geral

Os parâmetros de configuração permitem personalizar o comportamento do plugin Oracle.

Recomenda-se especificá-los em seu próprio arquivo de configuração (por exemplo, oracle.conf), em vez de no arquivo de configuração do agent 2. Em seguida, use a diretiva Include para incluir esse arquivo na configuração do Zabbix agent 2.

Todos os parâmetros são opcionais, a menos que seja explicitamente indicado que o parâmetro é obrigatório.

Observe que:

  • Os valores padrão refletem os padrões do processo, não os valores nos arquivos de configuração fornecidos.
  • Os valores suportam variáveis de ambiente.
  • O Zabbix suporta arquivos de configuração somente em codificação UTF-8, sem BOM.
  • Comentários que começam com "#" são suportados apenas no início da linha.

Parameter details

Plugins.Oracle.CallTimeout

Specify the maximum wait time in seconds for a request to be completed.

Default: default timeout
Range: 1-30

Plugins.Oracle.ConnectTimeout

Specify the maximum wait time in seconds for a connection to be established.

Default: default timeout
Range: 1-30

Plugins.Oracle.CustomQueriesPath

Specify full pathname of the directory containing .sql files with custom queries.

Defaults:
/usr/local/share/zabbix/custom-queries/oracle - for Unix systems,
*:\Program Files\Zabbix Agent 2\Custom Queries\Oracle - for Windows systems (where * is the drive name from the ProgramFiles environment variable)

Example: 

/etc/zabbix/oracle/sql
Plugins.Oracle.CustomQueriesEnabled

Enable execution of the oracle.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false
Range: true/false

Plugins.Oracle.Default.Password

Specify the default password for connecting to Oracle.
Used if no value is specified in an item key or named session.

Plugins.Oracle.Default.Service

Specify the default service name for connecting to Oracle (SID is not supported).
Used if no value is specified in an item key or named session.

Plugins.Oracle.Default.Uri

Specify the default URI for connecting to Oracle.
Used if no value is specified in an item key or named session.
Embedded credentials will be ignored.
Must match the URI format.
Supported schemes: tcp, tcps
The schema can be omitted.
The port can be omitted (default=1521).
It is also possible to specify the TNS key or TNS value as the connection string. The TNS value must be composed without whitespaces.

Examples: 

tcp://127.0.0.1:1521
localhost
zbx_tns_example (TNS key)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (TNS value)
Plugins.Oracle.Default.User

Specify the default username for connecting to Oracle.
Used if no value is specified in an item key or named session.

Plugins.Oracle.KeepAlive

Set the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300
Range: 60-900

Plugins.Oracle.ResolveTNS

Specify how to interpret the connection string (ConnString) for connecting to the Oracle server.
If it is set to false the default scheme and port will be added to ConnString (if absent).
If the option is set to true, the default scheme and port will be omitted (unless explicitly specified in ConnString), and ConnString will be passed to the Oracle client as is. If the Oracle client finds ConnString in the tnsnames.ora file, the connection description found will be used to connect to the Oracle server.

Default: true
Range: true/false

Plugins.Oracle.Sessions.<SessionName>.Password

Specify the named session password for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.

Plugins.Oracle.Sessions.<SessionName>.Service

Specify the named session service name for connecting to Oracle (SID is not supported).
<SessionName> - define name of a session for using in item keys.

Plugins.Oracle.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
Must match the URI format.
Supported schemes: tcp, tcps
The schema can be omitted.
The port can be omitted (default=1521).
It is also possible to specify the TNS key or TNS value as the connection string. The TNS value must be composed without whitespaces.

Examples: 

tcp://127.0.0.1:1521
localhost
zbx_tns_example (TNS key)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (TNS value)
Plugins.Oracle.Sessions.<SessionName>.User

Specify the named session username for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.

Parâmetros

Parameter Mandatory Range Default Description
Plugins.Oracle.CallTimeout no 1-30 global timeout O tempo máximo de espera, em segundos, para que uma solicitação seja concluída.
Plugins.Oracle.ConnectTimeout no 1-30 global timeout O tempo máximo de espera, em segundos, para que uma conexão seja estabelecida.
Plugins.Oracle.CustomQueriesPath no /usr/local/share/zabbix/custom-queries/oracle for Unix systems

*:\Program Files\Zabbix Agent 2\Custom Queries\Oracle for Windows systems, where * is the drive name from the ProgramFiles environment variable		 Caminho completo de um diretório que contém arquivos .sql com consultas personalizadas.
Exemplo: /etc/zabbix/oracle/sql
Plugins.Oracle.CustomQueriesEnabled no false Se definido, habilita a execução da chave de item oracle.custom.query. Se desabilitado, nenhuma consulta será carregada do caminho do diretório de consultas personalizadas.
Plugins.Oracle.Default.Password no Senha padrão para conexão com o Oracle; usada se nenhum valor for especificado em uma chave de item ou sessão nomeada.
Plugins.Oracle.Default.Service no Nome de serviço padrão para conexão com o Oracle (SID não é suportado); usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.
Plugins.Oracle.Default.Uri no URI padrão para conexão com o Oracle; usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.

Não deve incluir credenciais embutidas (elas serão ignoradas).
Deve corresponder ao formato de URI.
Apenas os esquemas tcp e tcps são suportados; um esquema pode ser omitido.
A porta pode ser omitida (padrão=1521).
Também é possível especificar a chave TNS ou o valor TNS como string de conexão. O valor TNS deve ser composto sem espaços em branco.
Exemplos: tcp://127.0.0.1:1521
localhost
zbx_tns_example (chave TNS)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (valor TNS)
Plugins.Oracle.Default.User no Nome de usuário padrão para conexão com o Oracle; usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.
Plugins.Oracle.KeepAlive no 60-900 300 O tempo máximo de espera (em segundos) antes que conexões de plugin não utilizadas sejam fechadas.
Plugins.Oracle.ResolveTNS no true / false true A opção especifica como interpretar a string de conexão (ConnString) para conectar ao server Oracle.
Se estiver definida como false, o esquema e a porta padrão serão adicionados a ConnString (se ausentes). Se a opção estiver definida como true, o esquema e a porta padrão serão omitidos (a menos que sejam especificados explicitamente em ConnString), e ConnString será passada ao cliente Oracle como está. Se o cliente Oracle encontrar ConnString no arquivo tnsnames.ora, a descrição de conexão encontrada será usada para conectar ao server Oracle.
Plugins.Oracle.Sessions.<SessionName>.Password no Senha da sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso em chaves de item.
Plugins.Oracle.Sessions.<SessionName>.Service no Nome de serviço da sessão nomeada a ser usado para conexão (SID não é suportado).
<SessionName> - defina o nome de uma sessão para uso em chaves de item.
Plugins.Oracle.Sessions.<SessionName>.Uri no String de conexão da sessão nomeada para Oracle.
<SessionName> - defina o nome de uma sessão para uso em chaves de item.

Não deve incluir credenciais embutidas (elas serão ignoradas).
Deve corresponder ao formato de URI.
Apenas os esquemas tcp e tcps são suportados; um esquema pode ser omitido.
A porta pode ser omitida (padrão=1521).
Também é possível especificar a chave TNS ou o valor TNS como string de conexão. O valor TNS deve ser composto sem espaços em branco.
Exemplos: tcp://127.0.0.1:1521
localhost
zbx_tns_example (chave TNS)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (valor TNS)
Plugins.Oracle.Sessions.<SessionName>.User no Nome de usuário da sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso em chaves de item.

Veja também: