Skip to content

Commit a8cf8ce

Browse files
Bemerkungen zum Betriebshandbuch eingearbeitet
1 parent 503ba66 commit a8cf8ce

File tree

2 files changed

+195
-2
lines changed

2 files changed

+195
-2
lines changed

de.bitctrl.dav.rest.client/Betriebshandbuch.md

Lines changed: 195 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export PATH=$PATH:/pfad_zu_java/bin
3232
```
3333

3434
Unter Windows muss der Pfad im Dialog "Systemsteuerung/System/Erweitert/Umgebungsvariablen"
35-
angepasst werden. Der Wert der Variablen **PFAD** muss um den Text `;/pfad_zu_java/bin` ergänzt
35+
angepasst werden. Der Wert der Variablen **PATH** muss um den Text `;/pfad_zu_java/bin` ergänzt
3636
werden.
3737

3838
#### Erstinstalltion
@@ -80,7 +80,14 @@ Folgende Konfigurationsbereiche müssen im Datenverteiler, mit dem sich die SWE
8080
Die SWE benötigt zum Betrieb folgende Parameter:
8181
* ''atg.archiv'' an einem Objekt vom Typ ''typ.archiv''
8282

83-
Über die Parametrierung der ''atg.archiv'' wird festgelegt, auf welche Datenidentifikationen sich die SWE anmeldet. Die Empfangenen Daten werden dann transformiert und via REST API an einen REST Server versandt (vgl. [Archivparameterierung](https://gitlab.nerz-ev.de/ERZ/SPEZ_de.bsvrz.ars/blob/master/06-BetrInf/BetrInf_ArS_FREI_V15.0_D2018-02-14.pdf)).
83+
Über diese Parameterattributgruppe wird dem Archivsystem mitgeteilt, welche Datenidentifikationen (d.h. Tripel aus Objekt, Attributgruppe und Aspekt) zu einem REST Server übertragen werden sollen. Die Einstellungen für Sichern, Nachfordern und dem Vorhaltezeitraum haben keine Wirkung.
84+
85+
Über die Parametrierung der ''atg.archiv'' wird festgelegt, auf welche Datenidentifikationen sich die SWE anmeldet. Die Empfangenen Daten werden dann transformiert und via REST API an einen REST Server versandt.
86+
87+
![Beispiel-Parameter](src/main/resources/docs/images/ParameterEditor.png)
88+
89+
Im dargestellten Beispiel werden die Daten der Attributgruppen `atg.anzeigeEigenschaftIst`, `atg.verkehrsDatenKurzZeitFs`, `atg.verkehrsDatenKurzZeitIntervall`, `atg.verkehrsDatenKurzZeitMq`, `atg.tlsUfdErgebnisMeldungHelligkeitHK`, `atg.gmaUmfelddaten` und `atg.anzeigeQuerschnittEigenschaftIst` versandt.
90+
8491

8592
### Aufnahme des Betriebs
8693

@@ -91,3 +98,189 @@ Die SWE verwendet die Datenverteiler - Applikationsfunktionen zur Kommunikation
9198
* `-url=http://localhost` : Die URL des REST Servers, der Standardwert ist `http://localhost`.
9299
* `-port=80` : Der Port des REST Servers, der Standardwert ist `9998`.
93100

101+
#### Unterstützte Datenspezifikationen
102+
103+
Folgende Datenspezifikationen werden durch den Client Unterstützt:
104+
105+
<table border="1">
106+
<tr>
107+
<th scope="col">Objekt Typ</th>
108+
<th scope="col">Attributgruppen</th>
109+
</tr>
110+
<tr>
111+
<td>typ.anzeige</td>
112+
<td>atg.anzeigeEigenschaftIst</td>
113+
</tr>
114+
<tr>
115+
<td>typ.anzeigeQuerschnitt</td>
116+
<td>atg.anzeigeQuerschnittEigenschaftIst</td>
117+
</tr>
118+
<tr>
119+
<td>typ.fahrStreifen</td>
120+
<td>atg.verkehrsDatenKurzZeitFs, atg.verkehrsDatenKurzZeitIntervall</td>
121+
</tr>
122+
<tr>
123+
<td>typ.messQuerschnitt</td>
124+
<td>atg.verkehrsDatenKurzZeitMq</td>
125+
</tr>
126+
<tr>
127+
<td>typ.gma</td>
128+
<td>atg.gmaUmfelddaten</td>
129+
</tr>
130+
<tr>
131+
<td>typ.deUfd</td>
132+
<td>atg.tlsUfdErgebnisMeldungHelligkeitHK</td>
133+
</tr>
134+
</table>
135+
136+
Wird die SWE so parametriert, dass nicht unterstützte Datenspezifikationen konvertiert und versendet werden sollen, dann gibt es entsprechende Fehlermeldungen im Logfile, die SWE arbeitet jedoch weiter.
137+
138+
139+
## Diagnosehandbuch
140+
### Benötigte Werkzeuge
141+
142+
Folgende Werkzeuge werden für eine Diagnose benötigt:
143+
144+
* Generischer Testmonitor (GTM) für die Überprüfung der Parametrierung
145+
* Texteditor/Textviewer für die Analyse der Logdateien
146+
147+
### Allgemeine Meldungen (Startmeldungen)
148+
149+
Folgende Ausgaben werden im Regelfall beim Start der SWE ausgegeben (Auszug aus dem Debug-Log) und stellen einen korrekten Start und Betrieb dar (die Ausgaben der konkret eingestellten Parameter sowie insbesondere die Werte am Ende des Auszugs weichen im konkreten System ggf. hiervon ab!).
150+
151+
```
152+
153+
#000000 29.04.2019 14:49:48,916:+0200 (TID:000001) ----------------------
154+
INFO : Client
155+
Aktuelle Debugeinstellungen
156+
----------------------------------------------
157+
Registrierte DebugLogger:
158+
Name: DEFAULT-DEBUG Level: ALL
159+
Name: global Level: null
160+
Name: Client Level: ALL
161+
Name: Level: INFO
162+
163+
164+
#000001 29.04.2019 14:49:48,920:+0200 (TID:000001) ----------------------
165+
INFO : Client
166+
Aufrufargumente von Client: ArgumentList[-benutzer=vrz, -authentifizierung=passwd, -datenverteiler=192.168.1.169:8083, -verschluesselung=nein, -erlaubeHmacAuthentifizierung=ja, -puffer=50000000:50000000:100000000, -debugLevelStdErrText=INFO, -debugLevelFileText=INFO, -url=https://ts.dlr.de/backend/VMZDataExchangeService/, -port=443]
167+
168+
#000002 29.04.2019 14:49:49,035:+0200 (TID:000001) ----------------------
169+
INFO : Client.de.bsvrz.dav.daf.main.ClientDavConnection
170+
Datenverteiler-Applikationsfunktionen 'de.bsvrz.dav.daf', Release: Kernsoftware 3.11.0, Version: , Stand: 08.06.18 15:52:53
171+
172+
#000005 29.04.2019 14:49:49,118:+0200 (TID:000001) ----------------------
173+
INFO : Client.de.bsvrz.dav.daf.communication.tcpCommunication.TCP_IP_Communication
174+
TCP-Verbindung aktiv aufgebaut, /192.168.1.169:49218 --> /192.168.1.169:8083
175+
176+
#000010 29.04.2019 14:49:50,450:+0200 (TID:000001) ----------------------
177+
INFO : Client.de.bsvrz.dav.daf.communication.protocol.ClientHighLevelCommunication
178+
Verschlüsselte Verbindung aufgebaut mit: AES_128/GCM/NoPadding
179+
180+
#000011 29.04.2019 14:49:50,608:+0200 (TID:000001) ----------------------
181+
INFO : Client.de.bsvrz.dav.daf.communication.protocol.ClientHighLevelCommunication
182+
Verschlüsselung der Verbindung wird deaktiviert
183+
184+
#000016 29.04.2019 14:49:50,647:+0200 (TID:000017) ----------------------
185+
INFO : Client.de.bsvrz.dav.daf.main.impl.SubscriptionManager
186+
Die Konfiguration ist für Anfragen bereit
187+
188+
#000017 29.04.2019 14:49:52,126:+0200 (TID:000001) ----------------------
189+
INFO : Client.de.bsvrz.dav.daf.main.impl.config.DafDataModel
190+
Protokollversion für Konfigurationsanfragen: 2
191+
192+
#000064 29.04.2019 14:49:52,928:+0200 (TID:000001) ----------------------
193+
INFO : Client.de.bitctrl.dav.rest.client.Dav2RestSender
194+
Folgende Objekt-Converter wurden via Reflection gefunden: [class de.bitctrl.dav.rest.client.converter.AnzeigeJsonConverter, class de.bitctrl.dav.rest.client.converter.GlaetteMeldeAnlageJsonConverter, class de.bitctrl.dav.rest.client.converter.AnzeigeQuerschnittJsonConverter, class de.bitctrl.dav.rest.client.converter.FahrstreifenJsonConverter, class de.bitctrl.dav.rest.client.converter.SystemObjectJsonConverter, class de.bitctrl.dav.rest.client.converter.MessQuerschnittJsonConverter]
195+
196+
#000066 29.04.2019 14:49:52,943:+0200 (TID:000001) ----------------------
197+
INFO : Client.de.bitctrl.dav.rest.client.Dav2RestSender
198+
Anmeldung am Datenverteiler abgeschlossen, jetzt gehts los...
199+
200+
#001027 29.04.2019 14:50:24,613:+0200 (TID:000024) ----------------------
201+
INFO : Client.de.bitctrl.dav.rest.client.Dav2RestSender
202+
Neue Archivparameter eingelesen - Beginne mit Anmeldung/Ummeldung für Archivparameter. Es werden 35785 Anmeldungen und 0 Abmeldungen vorgenommen.
203+
204+
#001028 29.04.2019 14:50:25,678:+0200 (TID:000024) ----------------------
205+
INFO : Client.de.bitctrl.dav.rest.client.Dav2RestSender
206+
An- und Abmeldung für Archivdatensaetze abgeschlossen - 1029 ms
207+
208+
```
209+
210+
Mit Erreichen der Meldung `Anmeldung am Datenverteiler abgeschlossen, jetzt gehts los...` ist die SWE betriebsbereit.
211+
212+
### Allgemeine Meldungen (Info/ Konfig)
213+
214+
Die Meldungen im Debug-Level INFO/KONFIG erlauben die Überprüfung der korrekten Funktion der SWE zur Laufzeit.
215+
Einträge, die im Logfile als „INFO“ gekennzeichnet sind, dienen zur Information und können dem Anwender Aufschluss über die aktuellen Aktivitäten der SWE geben.
216+
217+
### Warnmeldungen (WARNING)
218+
219+
Log-Einträge mit dem Level WARNING behindern zwar den Betrieb, verhindern ihn jedoch nicht. Es stehen jedoch nicht alle Funktionen der SWE zur Verfügung. Die Ursache einer Warnung sollte behoben werden, damit die SWE voll funktionstüchtig ist.
220+
221+
222+
<table border="1">
223+
<tr>
224+
<th scope="col">Meldung</th>
225+
<th scope="col">Beschreibung</th>
226+
</tr>
227+
<tr>
228+
<td><code>Der Heap ist zu mehr als 90% belegt, es werden X Elemente aus der Warteschlange entfernt.</code></td>
229+
<td>Der von der SWE verwendete Speicher ist fast vollständig belegt. Damit die SWE nicht durch einen OutOfMemory Error beendet wird, werden 10% der Daten gelöscht, die bisher trotz mehrmaligem Versuch nicht versendet werden konnten.</td>
230+
</tr>
231+
</table>
232+
233+
### Fehlermeldungen (ERROR)
234+
235+
Log-Einträge mit dem Level ERROR verhindern den korrekten Betrieb. Die Funktionen der SWE stehen nicht oder nur eingeschränkt zur Verfügung. Die Ursache eines Fehlers muss umgehend behoben werden, damit die SWE funktionstüchtig ist und die wichtigsten Funktionen erfüllt werden.
236+
Einträge, die im Logfile als „FEHLER“ gekennzeichnet sind, bedürfen somit einer dringenden Analyse/Beseitigung. Ein Fehler der Kategorie „FEHLER“ bedeutet jedoch nicht automatisch, dass die SWE keine Daten mehr versendet. In der Regel können solche Fehler nicht vom Operator beseitigt werden.
237+
238+
239+
<table border="1">
240+
<tr>
241+
<th scope="col">Meldung</th>
242+
<th scope="col">Beschreibung</th>
243+
</tr>
244+
<tr>
245+
<td><code>Instanziierung der Klasse X fehlgeschlagen.</code></td>
246+
<td>Ein Objekt der Konverter-Klasse X (ERZ Datenformat nach JSON) konnte nicht instanziiert werden. Es gibt eine Vielzahl möglicher Fehlerursachen. Es könnten z.B. Bibliotheken im Klassenpfad fehlen.Nachfolgend wird der Text der Excpetion mit weiteren Informationen angezeigt.</td>
247+
</tr>
248+
<td><code>DAV Objekte konnten nicht versendet werden.</code></td>
249+
<td>Es liegt ein allgemeines Kommunikationsproblem zum REST Server vor.</td>
250+
</tr>
251+
<tr>
252+
<td><code>Objekttyp-X konnten nicht versendet werden.</code></td>
253+
<td>Die statischen Informationen zu Objekten konnten nicht an den REST Server versandt werden. Jedoch ist eine prinzipielle Kommunikation möglich. REST Client und/oder Server sind nicht vollständig implementiert oder verwenden verschiedene Protokollversionen (RAML Schnittstellenbeschreibung). Nachfolgend wird der Text der Excpetion mit weiteren Informationen angezeigt.</td>
254+
</tr>
255+
<tr>
256+
<td><code>OnlineDaten konnten nicht für den Versand vorbereitet werden, es erfolgt kein Nachversand.</code></td>
257+
<td>Die Konvertierung der ERZ Daten in JSON Objekte ist fehlgeschlagen. Nachfolgend wird der Text der Excpetion mit weiteren Informationen angezeigt.</td>
258+
</tr>
259+
<tr>
260+
<td><code>Instanziierung und Konvertierung der Klasse X fehlgeschlagen (ResultData: resultData ).</code></td>
261+
<td>Ein Objekt der Konverter-Klasse X (ERZ Datenformat nach JSON) konnte nicht instanziiert werden. Es gibt eine Vielzahl möglicher Fehlerursachen. Es könnten z.B. Bibliotheken im Klassenpfad fehlen. Nachfolgend wird der Text der Excpetion mit weiteren Informationen angezeigt.</td>
262+
</tr>
263+
<tr>
264+
<td><code>Ermittlung des freien Heaps und das Verkürzen der Warteschlage ist fehlgeschlagen.</code></td>
265+
<td>Die Überwachung des freien Heap Speichers wurde mit einem Fehler abgebrochen.</td>
266+
</tr>
267+
<tr>
268+
<td><code>OnlineDaten konnten nicht (nach)versendet werden.</code></td>
269+
<td>Allgemeines Problem beim Nachversandt der Onlinedaten. Es besteht ein allgemeines Kommunikationsproblem zum REST Server.</td>
270+
</tr>
271+
<tr>
272+
<td><code>Archiv kann Datensatz nicht der Warteschlange hinzufügen.</code></td>
273+
<td>Vom ERZ Datenverteiler empfange Daten können nicht für eine Weiterverarbeitung zwischengespeichert werden. Nachfolgend wird der Text der Excpetion mit weiteren Informationen angezeigt.</td>
274+
</tr>
275+
<tr>
276+
<td><code>Der Versand von Datenart-X ist fehlgeschlagen und wird per Nachversand erneut versucht.</code></td>
277+
<td>Für ein bestimmtes Onlinedatum (dynamische Daten) ist der Versand zum REST Server fehlgeschlagen. Es wird versucht die Informationen später erneut zu versenden. Nachfolgend wird die HTTP Response des REST Servers angezeigt.</td>
278+
</tr>
279+
<tr>
280+
<td><code>Fehler beim Versand von Datenart-X es wird per Nachversand erneut versucht.</code></td>
281+
<td>Für ein bestimmtes Onlinedatum (dynamische Daten) ist der Versand zum REST Server fehlgeschlagen. Es wird versucht die Informationen später erneut zu versenden. Nachfolgend wird der Text der Excpetion mit weiteren Informationen angezeigt.</td>
282+
</tr>
283+
</table>
284+
285+
286+
56.4 KB
Loading

0 commit comments

Comments
 (0)