Karaf-Konsolen-Befehle für das BPC
Einige Core-Funktionen lassen sich über die Karaf-Konsole steuern.
Info
Ein paar Informationen über die BPC Installation.
bpc:info BPC Name BPC-1 UUID 3dfde089-c1a2-48ac-a9a1-b6d9137dd548 OpenSearch Version 2.17.1 Status Connected to [[host=http://localhost:9200]] OpenSearch Plugin Plugin status ACCESSIBLE Websocket status CONNECTED
Steuerung des Wartungsmodus
Der Wartungsmodus lässt sich über die Karaf-Konsole anschalten und ausschalten. Auch kann der aktueller Zustand abgefragt werden.
Nachfolgend die Befehle und Beispiele
Forcieren vom lokalen Identity Provider (IdP)
Die Verwendung vom lokalen Identity Provider lässt sich über die Karaf-Konsole anschalten und ausschalten. Auch kann der aktuelle Zustand abgefragt werden.
Nachfolgend die Befehle und Beispiele
Benutzer Sessions
Die Benutzer Sessions des BPC lassen sich über die Karaf-Konsole auflisten und löschen.
Nachfolgend die Befehle und Beispiele
Auflistung aller Benutzer Sessions
bpc:sessions-list Session ID │ User │ Firstname │ Lastname │ Expires ─────────────────────────────────────┼──────────┼───────────┼──────────┼──────────────────────── c403dd65-93da-42c5-a06c-598e6d91d6cd │ bpcadmin │ Timo │ Virt │ 2020-10-15 11:42:30.009 a9602f8a-f9b6-49ba-9411-6e16665cf5a3 │ of │ Oliver │ Fürniß │ 2020-10-15 12:44:04.162 dec79e6f-12a5-43a8-82aa-2d5aa5b7548b │ bpcadmin │ Timo │ Virt │ 2020-10-15 11:42:50.672
Backups / Snapshots
Die vom BPC angelegten Backups können über die Karaf-Konsole aufgelistet, gelöscht und auch wieder eingespielt werden.
Nachfolgend die Befehle und Beispiele
Auflistung der Backup-Gruppen
bpc:backup-list Indices Group ────────────────────────── bpc-analysis-queries bpc-auditlog bpc-configuration of-test-child,of-test-main
Auflistung der Backups einer Gruppe
bpc:backup-list bpc-configuration Date │ State │ Name ─────────────────────────┼─────────┼─────────────────────────────────────────── 2020-11-05T10:53:21.190Z │ SUCCESS │ snapshot-bpc-configuration-20201105-115321 2020-11-06T12:44:20.585Z │ SUCCESS │ snapshot-bpc-configuration-20201106-134420 2021-02-01T07:15:55.821Z │ SUCCESS │ snapshot-bpc-configuration-20210201-081555 2021-02-02T08:30:45.624Z │ SUCCESS │ snapshot-bpc-configuration-20210202-093045
Backup Jobs
Vom BPC werden periodisch Backups von OpenSearch Indices durchgeführt. Diese Backup Jobs können auch über die Karaf-Konsole aufgelistet und manuell gestartet werden.
Nachfolgend die Befehle und Beispiele
Auflistung der Backup Jobs
bpc:backupjob-list Backup Job Identifier │ Enabled │ State │ Runs Every │ Next Check In │ Latest Backup │ Next Backup │ Indices ──────────────────────────────────────────────────┼─────────┼────────┼───────────────┼───────────────┼─────────────────────────┼─────────────────────────┼─────────────────────────────────────────────────────────── core:audit-logger │ X │ active │ 86400 seconds │ 49 seconds │ 2022-07-26T13:42:47.999 │ 2022-07-27T13:42:47.999 │ [bpc-auditlog] core:bpc-configuration │ X │ active │ 86400 seconds │ 49 seconds │ 2022-07-26T13:11:44.932 │ 2022-07-27T13:11:44.932 │ [bpc-configuration] core:logservice:monitor-test-grid-header-filter │ - │ - │ - │ 49 seconds │ <none> │ - │ [monitor-test-grid-header-filter] core:logservice:monitor-test-module-jump-column │ - │ - │ - │ 49 seconds │ <none> │ - │ [monitor-test-module-jump-column] core:storageservice:bpc-store-datalock │ X │ active │ 86400 seconds │ 49 seconds │ 2022-07-26T06:09:34.774 │ 2022-07-27T06:09:34.774 │ [bpc-store-datalock] core:storageservice:bpc-store-monitor-view-states │ X │ active │ 86400 seconds │ 49 seconds │ 2022-07-26T06:09:35.975 │ 2022-07-27T06:09:35.975 │ [bpc-store-monitor-view-states] core:storageservice:bpc-store-state │ X │ active │ 86400 seconds │ 49 seconds │ 2022-07-26T06:09:35.775 │ 2022-07-27T06:09:35.775 │ [bpc-store-state] weather │ X │ active │ 600 seconds │ 49 seconds │ 2022-07-26T13:35:35.695 │ 2022-07-26T13:45:35.695 │ [weather-child, weather-parent]
Database Connection Pool
Infos über den Database Connection Pool (dbcp2) können abgefragt werden.
Kompakte Auflistung der Database Connection Pool Einträge
bpc:db-connection-pool-list Name │ Active │ Waiters │ Idle │ Max Total │ Borrowed │ Returned │ Mean Borrow Wait Time (ms) │ Max Borrow Wait Time (ms) │ DB URL │ DB Username │ DB Name ──────┼────────┼─────────┼──────┼───────────┼──────────┼──────────┼────────────────────────────┼───────────────────────────┼─────────────────────────────────────────────┼─────────────┼───────────────────────────────────────── pool3 │ 0 │ 0 │ 5 │ 10 │ 10254 │ 10254 │ 0 │ 42243 │ jdbc:oracle:thin:@localhost:1521:XE │ OLFUERNISS │ Oracle JDBC driver pool4 │ 0 │ 0 │ 1 │ 10 │ 4 │ 4 │ 9 │ 38 │ jdbc:mysql://127.0.0.1:3306/bpc │ olfuerniss │ MariaDB Connector/J pool5 │ 0 │ 0 │ 1 │ 10 │ 4 │ 4 │ 28 │ 113 │ jdbc:postgresql://localhost:5432/postgre... │ postgres │ PostgreSQL JDBC Driver pool2 │ 0 │ 0 │ 1 │ 10 │ 802 │ 802 │ 0 │ 746 │ jdbc:oracle:thin:@dev03.virtimo.net:1521... │ VPMA_PM │ Oracle JDBC driver pool │ 0 │ 0 │ 1 │ 10 │ 4 │ 4 │ 210 │ 843 │ jdbc:sqlserver://dev05.virtimo.net:1433;... │ DEV05_EBIX │ Microsoft JDBC Driver 7.4 for SQL Server
|
Über den Befehl |
OpenSearch Index kopieren
Über das Deployment kann ein Index von einem System zum anderen kopiert werden. Dazu gibt es die folgenden drei Befehle.
Auflistung der Deployment Ziele
Die IDs der Deployment Systeme werden für die folgenden beiden Befehle benötigt. Die Deployment Systeme werden über die BPC Oberfläche als Backend Connection vom Typ 'deployment_system' angelegt.
bpc:deployment-list-systems ID │ Name │ Sort Priority ──────────────┼──────────────────────────────┼────────────── ds_local │ Local BPC │ 100 1632738353151 │ Develop Stage │ 1000 1644918332765 │ Test Stage │ 2000 1644998745328 │ Prod Stage │ 2000 @@@JSON@@@ │ [JSON] │ 2147483647
Auflistung der Indices eines Deployment Systems
Im folgenden Aufrufbeispiel ist 1632738353151 die ID der Develop Stage von welcher die vorhandenen Indices aufgelistet werden sollen.
Der Index Name wird dann beim eigentlichen Kopierbefehl benötigt.
bpc:deployment-list-indices 1632738353151 Health │ State │ Index │ Alias │ Docs Count │ Docs Count (Lucene) │ Docs Deleted (Lucene) ───────┼────────┼───────────────────────────────────────┼───────────────────────────┼────────────┼─────────────────────┼────────────────────── close │ yellow │ bpc-auditlog_1638439270124 │ [] │ │ │ open │ yellow │ bpc-auditlog_1645622599914 │ [bpc-auditlog] │ 2608 │ 2608 │ 17 open │ yellow │ bpc-configuration_1638439267666 │ [bpc-configuration] │ 638 │ 638 │ 9 open │ yellow │ bpc-forms_1641883263224 │ [bpc-forms] │ 0 │ 0 │ 0 close │ yellow │ bpc-metrics_1638439285764 │ [] │ │ │ open │ yellow │ bpc-metrics_1645622622387 │ [bpc-metrics] │ 29325 │ 29325 │ 0 open │ yellow │ bpc-notification_1638439270752 │ [bpc-notification] │ 9251 │ 9251 │ 0 open │ yellow │ bpc-performance_1638530235746 │ [bpc-performance] │ 10655 │ 10655 │ 240 open │ yellow │ bpc-replicationjobs-log_1638439266291 │ [bpc-replicationjobs-log] │ 6 │ 6 │ 0 open │ yellow │ bpc-store-datalock_1638439266963 │ [bpc-store-datalock] │ 0 │ 0 │ 0 open │ yellow │ units_1631702902240 │ [units] │ 34 │ 0 │ 0
Index kopieren
Im folgenden Aufrufbeispiel wird der Index units_1631702902240 von der Develop Stage mit der ID 1632738353151 zur Test Stage mit der ID 1644918332765 kopiert.
Wenn der Index auf dem Zielsystem bereits existiert, dann wird der Vorgang abgebrochen und eine Fehlermeldung angezeigt.
bpc:deployment-copy-index --source 1632738353151 --target 1644918332765 units_1631702902240
Cluster-Betrieb
Für die Überprüfung/Überwachung im Cluster-Betrieb stehen folgende Befehle zur Verfügung. Diese Befehle können von irgendeinem der Server aus aufgerufen werden.
Auflistung der beteiligten BPC Server
bpc:server-list
Bei diesem Beispiel bilden gerade 3 BPC Server einen Cluster.
Name │ UUID │ Hostname │ Address │ Master │ Maintenance │ Available for Replication │ Loaded Modules │ Connected To OpenSearch Node ──────┼──────────────────────────────────────┼───────────┼─────────────┼────────┼─────────────┼───────────────────────────┼────────────────┼───────────────────────────── BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ - │ - │ X │ 10 │ ofs-um690 BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ X │ - │ X │ 11 │ ofs-um690 BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ - │ - │ X │ 10 │ ofs-um690 Not all servers have the same modules loaded, please double check those by using the command 'bpc:server-modules-list'.
Auflistung der installierten Backend-Module
Auf den BPC-Servern sollten jeweils die gleichen Module und mit der gleichen Modul-Version installiert sein.
bpc:server-modules-list
In der folgenden Beispielausgabe sieht man, dass das forms-Modul nicht auf den Servern mit den Namen BPC-2 und BPC-3 installiert ist.
Das ist an den Pfeilen in der ersten Spalte zu erkennen.
│ Module Name │ Module Version │ Name │ UUID │ Hostname │ Address ───┼───────────────────┼────────────────┼───────┼──────────────────────────────────────┼───────────┼──────────── │ _core │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ analysis │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ backendconnection │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ dashboard │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ externalContent │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ flow │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 -> │ forms │ - │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 -> │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 -> │ │ - │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ htmlcontent │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ logservice │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ monitor │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ replication │ 4.2.0.SNAPSHOT │ BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ │ 4.2.0.SNAPSHOT │ BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 Not all servers have the same modules loaded, please double check those with the arrow in the first column.
Auflistung der Replikationsjobs und deren Verteilung
Die einzelnen Replikationsjobs müssen zur Ausführung, gleichmäßig auf die beteiligten BPC-Server verteilt werden.
bpc:replicationjobs-orchestration-details
In der ersten Tabelle werden alle Replikationsjobs aufgelistet, auch die welche gerade deaktiviert sind. In der zweiten Tabelle die Server auf denen gerade die Replikationsjobs ausgeführt werden.
List of replication jobs registered to the OpenSearch plugin: Replication Job ID │ Enabled │ State │ Server UUID │ Server Name │ Server Hostname │ Server Address ───────────────────┼─────────┼─────────┼──────────────────────────────────────┼─────────────┼─────────────────┼─────────────── 1620638959732 │ - │ STOPPED │ - │ - │ - │ - 1633589629410 │ X │ RUNNING │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ BPC-3 │ ofs-um690 │ 172.20.10.6 1636536592010 │ - │ STOPPED │ - │ - │ - │ - 1644563497179 │ X │ RUNNING │ b391fee9-a86d-49be-90e3-918df78e3b35 │ BPC-2 │ ofs-um690 │ 172.20.10.6 1676360785745 │ X │ RUNNING │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ BPC │ ofs-um690 │ 172.20.10.6 1678426455645 │ - │ STOPPED │ - │ - │ - │ - (enabled=3, disabled=3, total=6) List of servers executing the replication jobs: Name │ UUID │ Hostname │ Address │ Available for Replication │ Assigned Replication Jobs │ Connected To OpenSearch Node ──────┼──────────────────────────────────────┼───────────┼─────────────┼───────────────────────────┼───────────────────────────┼───────────────────────────── BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ ofs-um690 │ 172.20.10.6 │ X │ 1 │ ofs-um690 BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ ofs-um690 │ 172.20.10.6 │ X │ 1 │ ofs-um690 BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ ofs-um690 │ 172.20.10.6 │ X │ 1 │ ofs-um690 Great, the replication jobs are equally distributed!
Laufzeitinformationen der Replikationsjobs
Hier werden nur die Replikationsjobs aufgelistet, welche auf den beteiligten Servern ausgeführt werden.
bpc:replicationjobs-runtime-stats
In der folgenden Beispielausgabe wurden 3 Replikationsjobs auf die 3 BPC-Server des Clusters verteilt. Unter 'Runs' sind die bereits durchgeführten Replikationsläufe aufgelistet. Und unter 'Errors' die Anzahl derer die auf einen Fehler gelaufen sind.
Server Name │ Server UUID │ Replication Job ID │ Replication Job Name │ Runs │ Errors │ Last Run Start │ Last Run End ────────────┼──────────────────────────────────────┼────────────────────┼──────────────────────┼──────┼────────┼─────────────────────────┼──────────────────────── BPC-2 │ b391fee9-a86d-49be-90e3-918df78e3b35 │ 1644563497179 │ bpc-6362 │ 100 │ 0 │ 2023-06-12 14:03:00.255 │ 2023-06-12 14:03:00.261 BPC │ 685484bc-aec5-4895-aa95-48ca5b9f2015 │ 1676360785745 │ BPC-7765 │ 123 │ 0 │ 2023-06-12 14:03:04.484 │ 2023-06-12 14:03:04.491 BPC-3 │ a47c8eb7-a5d6-4f0d-80d3-17be9e3f946c │ 1633589629410 │ mariadb-test_table │ 98 │ 0 │ 2023-06-12 14:03:05.308 │ 2023-06-12 14:03:05.314
OpenSearch
Ein paar administrative Aktionen können gegen das momentan verwendete OpenSearch abgesetzt werden. Nachfolgend die Befehle und Beispiele.
Auflistung der Indices
os:list
Health │ State │ Index │ Alias │ Shards │ Replicas │ Docs Count │ Docs Count (Lucene) │ Docs Deleted (Lucene) │ Store Size │ Primary Store Size ───────┼────────┼───────────────────────────────────────────────────────┼───────────────────────────────────────────┼────────┼──────────┼────────────┼─────────────────────┼───────────────────────┼────────────┼─────────────────── open │ green │ .tasks │ [] │ 1 │ 0 │ 25 │ 25 │ 0 │ 58,94 KB │ 58,94 KB open │ yellow │ bpc-analysis-queries_1647495911203 │ [bpc-analysis-queries] │ 1 │ 1 │ 0 │ 0 │ 0 │ 208 B │ 208 B open │ yellow │ bpc-auditlog_1696930053134 │ [bpc-auditlog] │ 5 │ 1 │ 27647 │ 27647 │ 13 │ 8,34 MB │ 8,34 MB close │ yellow │ bpc-configuration_1684738165295 │ [] │ 1 │ 1 │ │ │ │ │ open │ yellow │ bpc-configuration_1697110020805 │ [bpc-configuration] │ 10 │ 1 │ 5271 │ 5271 │ 1 │ 1,59 MB │ 1,59 MB ...
Inhalt eines Index anzeigen
os:cat <name of index>
ID │ p_processid (long) │ processname (text) │ timestamp (date) ───┼────────────────────┼────────────────────┼──────────────────────────── 7 │ 7 │ Prozess 7 │ 2023-06-13T06:53:53.043545Z 5 │ 5 │ Prozess 5 │ 2023-06-13T06:06:38.364433Z 2 │ 2 │ Prozess 2 │ 2023-06-13T05:56:20.782316Z 3 │ 3 │ Prozess 3 │ 2023-06-13T05:56:29.98964Z 4 │ 4 │ Prozess 4 │ 2023-06-13T06:06:38.349114Z 8 │ 8 │ Prozess 8 │ 2023-06-13T06:55:29.956788Z 1 │ 1 │ Prozess 1 │ 2023-06-13T05:56:09.718081Z 6 │ 6 │ Prozess 6 │ 2023-06-13T06:06:38.377993Z ...
Einstellungen und Mapping eines Index anzeigen
os:mapping <name of index>
{
"settings" : {
"creation_date" : "1695804537997",
"number_of_shards" : "5",
"number_of_replicas" : "1",
...
},
"mappings" : {
"properties" : {
"p_processid" : {
"type" : "long"
},
"processname" : {
"type" : "text",
"fields" : {
"lowercase" : {
"normalizer" : "lowercaseNormalizer",
"type" : "keyword"
},
"raw" : {
"type" : "keyword"
}
}
},
"timestamp" : {
"type" : "date"
}
},
...
}
}
Alle Read-Only Flags entfernen
OpenSearch setzt Indizes automatisch in den Read-Only-Modus, wenn der Speicherplatz knapp wird. In diesem Fall erhalten alle Indizes das Read-Only Flag. Der Benutzer muss diese Markierung bei jedem Index manuell entfernen, nachdem er genügend freien Speicherplatz bereitgestellt hat. Dieses Kommando entfernt die Read-Only Flags von allen Indices.
os:remove-all-read-only-flags
