PostgreSQL spraudnis

Pārskats

Konfigurācijas parametri ļauj pielāgot PostgreSQL spraudņa darbību.

Ieteicams tos norādīt atsevišķā konfigurācijas failā (piem., postgresql.conf), nevis aģenta 2 konfigurācijas failā. Pēc tam izmantojiet direktīvu Include, lai iekļautu šo failu Zabbix aģenta 2 konfigurācijā.

PostgreSQL spraudnis ir ielādējams spraudnis, un tas ir pieejams, kā arī pilnībā aprakstīts PostgreSQL spraudņa repozitorijā.

Visi parametri ir neobligāti, ja vien nav skaidri norādīts, ka parametrs ir obligāts.

Ņemiet vērā:

  • Noklusējuma vērtības atspoguļo procesa noklusējuma iestatījumus, nevis vērtības piegādātajos konfigurācijas failos.
  • Vērtības atbalsta vides mainīgos;
  • Zabbix atbalsta konfigurācijas failus tikai UTF-8 kodējumā bez BOM.
  • Komentāri, kas sākas ar "#", tiek atbalstīti tikai rindas sākumā.

Parameter details

Plugins.PostgreSQL.CallTimeout

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

Default: global timeout
Range: 1-30

Plugins.PostgreSQL.CustomQueriesPath

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

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

Example:

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

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

Default: false
Range: true/false

Plugins.PostgreSQL.Default.CacheMode

Specify the default cache mode for the PostgreSQL connection.

Default: prepare
Range:
prepare - create prepared statements on the PostgreSQL server;
describe - use the anonymous prepared statement to describe a statement without creating a statement on the server.

Note that describe is primarily useful when the environment does not allow prepared statements such as when running a connection pooler like PgBouncer.

Plugins.PostgreSQL.Default.Database

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

Plugins.PostgreSQL.Default.Password

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

Plugins.PostgreSQL.Default.TLSCAFile

Specify full pathname of the file containing the top-level CA(s) certificate for peer certificate verification for encrypted communications between Zabbix agent 2 and monitored databases.
Used if no value is specified in a named session.

Mandatory: yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full

Plugins.PostgreSQL.Default.TLSCertFile

Specify full pathname of the file containing the PostgreSQL certificate or certificate chain for encrypted communications between Zabbix agent 2 and monitored databases.
Used if no value is specified in a named session.

Mandatory: yes, if Plugins.PostgreSQL.Default.TLSKeyFile is specified

Plugins.PostgreSQL.Default.TLSConnect

Specify the default level of encryption for communications between Zabbix agent 2 and monitored databases.
Used if no value is specified in a named session.

Range:
required - connect using TLS as transport mode without identity checks;
verify_ca - connect using TLS and verify certificate;
verify_full - connect using TLS, verify certificate and verify that database identity (CN) specified by DBHost matches its certificate.

Undefined encryption type means unencrypted connection.

Plugins.PostgreSQL.Default.TLSKeyFile

Specify full pathname of the file containing the PostgreSQL private key for encrypted communications between Zabbix agent 2 and monitored databases.
Used if no value is specified in a named session.

Mandatory: yes, if Plugins.PostgreSQL.Default.TLSCertFile is specified

Plugins.PostgreSQL.Default.Uri

Specify the default URI for connecting to PostgreSQL.
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, unix

Examples:

tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Default.User

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

Plugins.PostgreSQL.KeepAlive

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

Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode

Specify the named session cache mode for the PostgreSQL connection.
<SessionName> - define name of a session for using in item keys.

Default: prepare
Range:
prepare - create prepared statements on the PostgreSQL server;
describe - use the anonymous prepared statement to describe a statement without creating a statement on the server.

Note that describe is primarily useful when the environment does not allow prepared statements such as when running a connection pooler like PgBouncer.

Plugins.PostgreSQL.Sessions.<SessionName>.Database

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

Plugins.PostgreSQL.Sessions.<SessionName>.Password

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

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile

Specify full pathname of the file containing the top-level CA(s) certificate for peer certificate verification for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile

Specify full pathname of the file containing the PostgreSQL certificate or certificate chain for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified

Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect

Specify the named session level of encryption for communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Range:
required - connect using TLS as transport mode without identity checks;
verify_ca - connect using TLS and verify certificate;
verify_full - connect using TLS, verify certificate and verify that database identity (CN) specified by DBHost matches its certificate.

Undefined encryption type means unencrypted connection.

Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile

Specify full pathname of the file containing the PostgreSQL private key for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile is specified.

Plugins.PostgreSQL.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to PostgreSQL.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
Must match the URI format.
Supported schemes: tcp, unix

Examples:

tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Sessions.<SessionName>.User

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

Plugins.PostgreSQL.System.Path

Specify path to the PostgreSQL plugin executable.

Mandatory: yes

Example:

Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql
Plugins.PostgreSQL.Timeout

Set the request execution timeout (the duration, in seconds, to wait for a request to complete before shutting it down).

Default: global timeout
Range: 1-30

Opcijas

Parameter Description
-V --version Izdrukā spraudņa versiju un licences informāciju.
-h --help Izdrukā palīdzības informāciju (saīsināti).
-t, --test <item key> Palaiž spraudni testēšanai (spraudņa konfigurācija tiek ignorēta).

Parametri

Parameter Mandatory Range Default Description
Plugins.PostgreSQL.Default.CacheMode no prepare Kešatmiņas režīms PostgreSQL savienojumam.
Atbalstītās vērtības:
prepare (noklusējums) - izveidos sagatavotos priekšrakstus PostgreSQL serverī;
describe - izmantos anonīmu sagatavoto priekšrakstu, lai aprakstītu priekšrakstu, neveidojot priekšrakstu serverī.
Ņemiet vērā, ka "describe" galvenokārt ir noderīgs tad, ja vide neļauj izmantot sagatavotos priekšrakstus, piemēram, darbinot savienojumu pūlētāju, piemēram, PgBouncer.
Plugins.PostgreSQL.CallTimeout no 1-30 global timeout Maksimālais gaidīšanas laiks (sekundēs), līdz pieprasījums tiek izpildīts.
Plugins.PostgreSQL.CustomQueriesPath no /usr/local/share/zabbix/custom-queries/postgreSQL Unix sistēmām

*:\Program Files\Zabbix Agent 2\Custom Queries\PostgreSQL Windows sistēmām, kur * ir diska nosaukums no vides mainīgā ProgramFiles
Pilns ceļš uz direktoriju, kurā ir .sql faili ar pielāgotiem vaicājumiem.
Plugins.PostgreSQL.CustomQueriesEnabled no false Ja ir iestatīts, iespējo postgresql.custom.query vienums atslēgas izpildi. Ja ir atspējots, no pielāgoto vaicājumu direktorija ceļa netiks ielādēts neviens vaicājums.
Plugins.PostgreSQL.Default.Database no Noklusējuma datubāze savienojumam ar PostgreSQL; tiek izmantota, ja vienuma atslēgā vai nosauktajā sesijā nav norādīta vērtība.
Plugins.PostgreSQL.Default.Password no Noklusējuma parole savienojumam ar PostgreSQL; tiek izmantota, ja vienuma atslēgā vai nosauktajā sesijā nav norādīta vērtība.
Plugins.PostgreSQL.Default.TLSCAFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)
Pilns ceļš uz failu, kurā ir augstākā līmeņa CA sertifikāts(-i) vienaudža sertifikāta verifikācijai šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm; tiek izmantots, ja nosauktajā sesijā nav norādīta vērtība.
Plugins.PostgreSQL.Default.TLSCertFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)
Pilns ceļš uz failu, kurā ir PostgreSQL sertifikāts vai sertifikātu ķēde šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm; tiek izmantots, ja nosauktajā sesijā nav norādīta vērtība.
Plugins.PostgreSQL.Default.TLSConnect no Šifrēšanas veids saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm; tiek izmantots, ja nosauktajā sesijā nav norādīta vērtība.
Atbalstītās vērtības:
required - savienoties, izmantojot TLS kā transporta režīmu bez identitātes pārbaudēm;
verify_ca - savienoties, izmantojot TLS, un pārbaudīt sertifikātu;
verify_full - savienoties, izmantojot TLS, pārbaudīt sertifikātu un pārbaudīt, ka datubāzes identitāte (CN), kas norādīta ar DBHost, atbilst tās sertifikātam.
Nenorādīts šifrēšanas veids nozīmē nešifrētu savienojumu.
Plugins.PostgreSQL.Default.TLSKeyFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)
Pilns ceļš uz failu, kurā ir PostgreSQL privātā atslēga šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm; tiek izmantots, ja nosauktajā sesijā nav norādīta vērtība.
Plugins.PostgreSQL.Default.Uri no Noklusējuma URI savienojumam ar PostgreSQL; tiek izmantots, ja vienuma atslēgā vai nosauktajā sesijā nav norādīta vērtība.

Nedrīkst ietvert iegultus akreditācijas datus (tie tiks ignorēti).
Jāatbilst URI formātam.
Atbalstītās shēmas: tcp, unix.
Piemēri: tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Default.User no Noklusējuma lietotājvārds savienojumam ar PostgreSQL; tiek izmantots, ja vienuma atslēgā vai nosauktajā sesijā nav norādīta vērtība.
Plugins.PostgreSQL.KeepAlive no 60-900 300 Maksimālais gaidīšanas laiks (sekundēs) pirms neizmantotie spraudņa savienojumi tiek aizvērti.
Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode no prepare Kešatmiņas režīms PostgreSQL savienojumam.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.
Atbalstītās vērtības:
prepare (noklusējums) - izveidos sagatavotos priekšrakstus PostgreSQL serverī;
describe - izmantos anonīmu sagatavoto priekšrakstu, lai aprakstītu priekšrakstu, neveidojot priekšrakstu serverī.
Ņemiet vērā, ka "describe" galvenokārt ir noderīgs tad, ja vide neļauj izmantot sagatavotos priekšrakstus, piemēram, darbinot savienojumu pūlētāju, piemēram, PgBouncer.
Plugins.PostgreSQL.Sessions.<SessionName>.Database no Datubāze sesijas savienojumam.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.PostgreSQL.Sessions.<SessionName>.Password no Must match the password format. Parole sesijas savienojumam.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile no
(yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full)
Pilns ceļš uz failu, kurā ir augstākā līmeņa CA sertifikāts(-i) vienaudža sertifikāta verifikācijai.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified Pilns ceļš uz failu, kurā ir PostgreSQL sertifikāts vai sertifikātu ķēde.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect no Šifrēšanas veids PostgreSQL savienojumam.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.

Atbalstītās vērtības:
required - savienoties, izmantojot TLS kā transporta režīmu bez identitātes pārbaudēm;
verify_ca - savienoties, izmantojot TLS, un pārbaudīt sertifikātu;
verify_full - savienoties, izmantojot TLS, pārbaudīt sertifikātu un pārbaudīt, ka datubāzes identitāte (CN), kas norādīta ar DBHost, atbilst tās sertifikātam.
Nenorādīts šifrēšanas veids nozīmē nešifrētu savienojumu.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile is specified Pilns ceļš uz failu, kurā ir PostgreSQL privātā atslēga.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.PostgreSQL.Sessions.<SessionName>.Uri no Nosauktas sesijas savienojuma virkne.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.

Nedrīkst ietvert iegultus akreditācijas datus (tie tiks ignorēti).
Jāatbilst URI formātam.
Atbalstītās shēmas: tcp, unix.
Piemēri: tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Sessions.<SessionName>.User no Nosauktās sesijas lietotājvārds.
<SessionName> - definējiet sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.PostgreSQL.System.Path yes Ceļš uz PostgreSQL spraudņa izpildfailu.
Lietošanas piemērs: Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql
Plugins.PostgreSQL.Timeout no 1-30 global timeout Pieprasījuma izpildes noildze (ilgums sekundēs, cik ilgi gaidīt pieprasījuma pabeigšanu pirms tā pārtraukšanas).

Skatiet arī: