Wtyczka MSSQL

Przegląd

Parametry konfiguracyjne umożliwiają dostosowanie działania wtyczki MSSQL.

Zaleca się określanie ich w osobnym pliku konfiguracyjnym (np. mssql.conf), a nie w pliku konfiguracyjnym agenta 2. Następnie należy użyć dyrektywy Include, aby dołączyć ten plik do konfiguracji Zabbix agent 2.

Wtyczka MSSQL jest wtyczką ładowaną i jest dostępna oraz w pełni opisana w repozytorium wtyczki MSSQL.

Wszystkie parametry są opcjonalne, chyba że wyraźnie zaznaczono, że dany parametr jest obowiązkowy.

Ta strona jest podzielona na:

  • Przegląd parametrów (aby zobaczyć pełne szczegóły parametru, kliknij jego nazwę)
  • Szczegóły parametrów
Parameter Description
Plugins.MSSQL.CustomQueriesDir Określa ścieżkę do katalogu zawierającego zdefiniowane przez użytkownika pliki .sql z niestandardowymi zapytaniami, które wtyczka może wykonywać.
Plugins.MSSQL.CustomQueriesEnabled Włącza wykonywanie klucza pozycji mssql.custom.query.
Plugins.MSSQL.Default.CACertPath Określa domyślną ścieżkę do pliku certyfikatu klucza publicznego urzędu certyfikacji (CA), który wydał certyfikat serwera MSSQL.
Plugins.MSSQL.Default.Database Określa domyślną nazwę bazy danych.
Plugins.MSSQL.Default.Encrypt Określa domyślny poziom szyfrowania.
Plugins.MSSQL.Default.HostNameInCertificate Określa domyślnie nazwę pospolitą (CN) certyfikatu serwera MSSQL.
Plugins.MSSQL.Default.Password Określa domyślne hasło.
Plugins.MSSQL.Default.TLSMinVersion Określa domyślną minimalną wersję TLS.
Plugins.MSSQL.Default.TrustServerCertificate Domyślnie ufa certyfikatowi serwera bez jego weryfikacji.
Plugins.MSSQL.Default.Uri Określa domyślny URI.
Plugins.MSSQL.Default.User Określa domyślną nazwę użytkownika.
Plugins.MSSQL.KeepAlive Określa maksymalny czas oczekiwania (w sekundach) przed zamknięciem nieużywanych połączeń wtyczki.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath Określa ścieżkę pliku dla nazwanej sesji do certyfikatu klucza publicznego urzędu certyfikacji (CA), który wydał certyfikat serwera MSSQL.
Plugins.MSSQL.Sessions.<SessionName>.Database Określa nazwę bazy danych dla nazwanej sesji.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt Określa poziom szyfrowania dla nazwanej sesji.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate Określa nazwę pospolitą (CN) certyfikatu serwera MSSQL dla nazwanej sesji.
Plugins.MSSQL.Sessions.<SessionName>.Password Określa hasło dla nazwanej sesji.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion Określa minimalną wersję TLS dla nazwanej sesji.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate Domyślnie ufa certyfikatowi serwera dla nazwanej sesji bez jego weryfikacji.
Plugins.MSSQL.Sessions.<SessionName>.Uri Określa URI dla nazwanej sesji.
Plugins.MSSQL.Sessions.<SessionName>.User Określa nazwę użytkownika dla nazwanej sesji.
Plugins.MSSQL.System.Path Określa ścieżkę do pliku wykonywalnego wtyczki MSSQL.
Plugins.MSSQL.Timeout Ustawia czas oczekiwania, w sekundach, na odpowiedź serwera podczas pierwszego połączenia oraz podczas kolejnych operacji w sesji.

Należy pamiętać, że:

  • Wartości domyślne odzwierciedlają domyślne ustawienia procesu, a nie wartości w dostarczonych plikach konfiguracyjnych.
  • Wartości obsługują zmienne środowiskowe;
  • Zabbix obsługuje pliki konfiguracyjne wyłącznie w kodowaniu UTF-8 bez BOM.
  • Komentarze zaczynające się od "#" są obsługiwane tylko na początku wiersza.

Szczegóły parametru

Plugins.MSSQL.CustomQueriesDir

Określa ścieżkę do katalogu zawierającego zdefiniowane przez użytkownika pliki .sql z niestandardowymi zapytaniami, które plugin może wykonywać.
Plugin ładuje wszystkie dostępne pliki .sql w skonfigurowanym katalogu podczas uruchamiania. Oznacza to, że wszelkie zmiany w plikach niestandardowych zapytań nie zostaną uwzględnione, dopóki plugin nie zostanie ponownie uruchomiony. Plugin jest uruchamiany i zatrzymywany razem z agentem Zabbix agent 2.

Wartości domyślne:
/usr/local/share/zabbix/custom-queries/mssql - dla systemów Unix,
*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL - dla systemów Windows (gdzie * to nazwa dysku z zmiennej środowiskowej ProgramFiles)

Plugins.MSSQL.CustomQueriesEnabled

Włącz wykonywanie klucza pozycja mssql.custom.query.
Jeśli opcja jest wyłączona, żadne zapytania nie zostaną załadowane z katalogu niestandardowych zapytań.

Domyślnie: false
Zakres: true/false

Plugins.MSSQL.Default.CACertPath

Określ domyślną ścieżkę do pliku z certyfikatem klucza publicznego urzędu certyfikacji (CA), który wydał certyfikat serwera MSSQL.
Certyfikat musi być w formacie PEM.

Plugins.MSSQL.Default.Database

Określ domyślną nazwę bazy danych.

Plugins.MSSQL.Default.Encrypt

Określa poziom domyślnego szyfrowania.

Zakres:
true - przesyłanie danych między pluginem a serwerem jest szyfrowane;
false - przesyłanie danych między pluginem a serwerem nie jest szyfrowane poza pakietem logowania;
strict - przesyłanie danych między pluginem a serwerem jest szyfrowane end-to-end z użyciem TDS8;
disable - przesyłanie danych między pluginem a serwerem nie jest szyfrowane.

Plugins.MSSQL.Default.HostNameInCertificate

Określ domyślną nazwę pospolitą (CN) certyfikatu serwera MSSQL.

Plugins.MSSQL.Default.Password

Określ domyślne hasło dla chronionego serwera MSSQL.

Plugins.MSSQL.Default.TLSMinVersion

Określ domyślną minimalną wersję TLS.

Zakres: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Domyślnie ufaj certyfikatowi serwera bez jego weryfikacji.

Zakres: true, false

Plugins.MSSQL.Default.Uri

Określ domyślny URI do łączenia się z serwerem MSSQL.
Osadzone poświadczenia zostaną zignorowane.
Jedynym obsługiwanym schematem jest sqlserver://.
Schemat można pominąć.

Domyślnie: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Określ domyślną nazwę użytkownika dla chronionego serwera MSSQL.

Plugins.MSSQL.KeepAlive

Określa maksymalny czas oczekiwania (w sekundach) przed zamknięciem nieużywanych połączeń wtyczki.

Domyślnie: 300
Zakres: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Określ ścieżkę do pliku sesji o podanej nazwie do publicznego certyfikatu klucza urzędu certyfikacji (CA), który wystawił certyfikat serwera MSSQL.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.
Certyfikat musi być w formacie PEM.

Plugins.MSSQL.Sessions.<SessionName>.Database

Określ nazwę bazy danych dla wskazanej sesji.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Określa poziom szyfrowania nazwanej sesji.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.

Zakres:
true - przesyłanie danych między pluginem a serwerem jest szyfrowane;
false - przesyłanie danych między pluginem a serwerem nie jest szyfrowane poza pakietem logowania;
strict - przesyłanie danych między pluginem a serwerem jest szyfrowane end-to-end z użyciem TDS8;
disable - przesyłanie danych między pluginem a serwerem nie jest szyfrowane.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Określ nazwę pospolitą (CN) certyfikatu serwera MSSQL dla nazwanej sesji.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.

Plugins.MSSQL.Sessions.<SessionName>.Password

Określ hasło dla nazwanej sesji do chronionego serwera MSSQL.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Określa minimalną wersję TLS dla wskazanej sesji.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.

Zakres: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Zaufaj certyfikatowi serwera dla wskazanej sesji bez jego weryfikacji.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.

Zakres: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Określ URI nazwanej sesji do łączenia się z serwerem MSSQL.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.
Osadzone poświadczenia zostaną zignorowane.
Jedynym obsługiwanym schematem jest sqlserver://.
Schemat można pominąć.

Domyślnie: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Określ nazwę użytkownika dla nazwanej sesji na chronionym serwerze MSSQL.
<SessionName> - określa nazwę sesji do użycia w kluczach pozycji.

Plugins.MSSQL.System.Path

Określ ścieżkę do pliku wykonywalnego wtyczki MSSQL.
Globalne ustawienie dla wtyczki MSSQL. Ma zastosowanie do wszystkich połączeń.

Przykład: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql

Plugins.MSSQL.Timeout

Ustaw czas oczekiwania, w sekundach, na odpowiedź serwera podczas pierwszego połączenia oraz podczas kolejnych operacji w sesji.

Domyślnie: global timeout
Zakres: 1-30

Opcje

Parameter Description
-V --version Wyświetla wersję wtyczki i informacje o licencji.
-h --help Wyświetla informacje pomocy (skrót).
-t, --test <item key> Uruchamia wtyczkę do testowania (konfiguracja wtyczki jest ignorowana).

Zobacz także