Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootBackend For Frontend (GM-BFFDigital Post Adapter (DPA) - Leverancebeskrivelse



Indholdsfortegnelse

...

Driftsvejledningen indeholder information om GM-BFF DPA med hensyn til eksterne afhængigheder, standard placering af logfiler og konfigurationsfiler, og evt. krav til genstart af applikationer hvis komponenten ikke er responsiv.

I afsnit 3 (Komponenter) er beskrevet hvilke komponenter, der indgår i GM-BFF DPA og deres forventede placering med hensyn til platform.

Afsnit 5 (Konfiguration) beskriver aktuelle konfigurationsparametre for GM-BFF henholdsvis RepositoryDPA, samt eksempler på konfigurationsparameter-filer.

Afsnit 6.1, 6.2 og 6.3 (Overvågning) beskriver hvorledes GM-BFF DPA komponenterne overvåges.

I afsnit 6.4 er GMDPA-BFF-relaterede logfiler beskrevet, så disse evt. kan overvåges, og tillige danne baggrund for fejlsøgning.

...

Læseren forventes at have kendskab til ...NSP miljøet.

Definitioner og referencer

...

Dette dokument dækker følgende komponenter:

  • Digital Post Adapter
    • Type: Webservice
    • Filnavn: digital-post-adapter.war
    • Statusurl: <serverurl>/digitalpost/status
    • Alarmurl: <serverurl>/digitalpost/alarm
    • Endpoint for SendDigitalPost:
      • Url: <serverurl>/digitalpost/2024/05/29/send
  • Operations
    • Type: Webservice
    • Filnavn: operations.war
    • Statusurl: <serverurl>/digitalpostOperations/status
    • Alarmurl: <serverurl>/digitalpostOperations/alarm
    • Joburl: <serverurl>/digitalpostOperations/sendDigitalPost

Daglig drift

Dette afsnit beskriver den daglige drift af systemet.

Relaterede services

DPA afhænger af tilstedeværelsen af en række andre services, og ved fejl i nogle af disse vil DPA fejle tilsvarende. Disse services er:

  • STS
  • PersonInformationService
  • DigitalPostKomponent
    • Her vil fejl i servicen ikke resultere i fejl i DPA, men vil blot resultere i genudsendelse af kald på et senere tidspunkt

Aktivering af job

DPA forventer at modtage et kald til <serverurl>/digitalpostOperations/sendDigitalPost med jævne mellemrum.  Når jobbet aktiveres køres det i op mod digitalpost.send.desired.execution.duration tid. Propertien er som udgangspunkt sat til 20 sekunder.

Dette kald vil føre til afsendelse af de breve der ved kald til SOAP-endpointed er skrevet i databasen, og de breve der ved tidligere aktiveringer af dette job er fejlet.

Jobbet vil logge hvor lang tid der er brugt, og hvor mange operationer der er tilbage (svarende nogenlunde til hvor mange breve der ikke er afsendt).

Hvis jobbet aktiveres mens der allerede er en kørsel i gang vil den nye kørsel gå i gang efter første kørsel er færdig (synchronized metode i java). Den vil dog tælle sin kørsels-tid fra punktet hvor kaldet blev foretaget, ikke fra punktet hvor første kørsel var færdig, og der vil derfor ikke blive en uendelig obhobning af jobs.

Hvor ofte jobbet bør aktiveres afhænger af, hvor mange breve der sendes, og kan evt. tilpasses ud fra log-beskeder og antal usendte beskeder i alarm-endpoint.

Konfiguration

Komponenterne afvikles i et ??? docker-compo3 setup, som ligger under ??? https://git.nspop.dk/projects/COM/repos/digital-post-adapter/browse/compose.

log4j konfiguration

Log4j konfiguration findes i (hvis ovenstående format anvendes): compose/configuration/log4j.properties filen

Se yderligere opsætning i installationsvejledningen.

...

Konfiguration af SLA-log findes i: compose/configuration/nspslalog-dpa.properties filen

Service konfiguration

Konfigurationen af servicen findes i:

Whitelist konfiguration

Der foretages whitelisting ...

Monitorering

Til statuscheck af GM-BFF

Overvågning

GM-BFF overvåges ...

Placering af HTML overvågningsside

...

Fortolkning af HTML overvågningsside

compose/configuration/dpa.properties filen

PropertyBeskrivelsePåkrævet
dpk.urlURL til Digital Post KomponentJa
person_information.urlURL til Person InformationJa
datasource.jndiNavn på jboss datasource (defineret i dpa-ds.xml)Ja
digitalpost.send.limitMaksimalt antal breve der skal behandles i 1 aktivering af send-jobbetJa
digitalpost.send.error.limitMaksimalt antal gange et brev må have fejlet og stadig udsendesJa
digitalpost.send.desired.execution.durationØnsket varighed af send-jobbetJa
service.contract.endpointURL som skrives ind i WSDLJa


Monitorering

Til statuscheck af DPA udstilles <serverurl>/digitalpost/status som returnerer HTTP 200 hvis servicen i øjeblikket kører fint og HTTP 503 hvis der er opstået en fejl der kræver indgriben.

Overvågning

DPA overvåges på <serverurl>/digitalpost/alarm.

Fortolkning af HTML overvågningsside

Overvågningssiden Alle overvågningssider returnerer enten status 200 hvis de i øjeblikket kører fint, status 404 hvis servicen ikke er deployeret , .... og status 500, hvis der er opstået en fejl, og komponenten derfor ikke virker korrekt.

Derudover returneres evt. følgende fejlbeskeder hvis de er opfyldt:

  • "Database tabellen digitalpost har flere records med error_counter højere end tilladt. Det nuværende antal er: %d."
  • "Database tabellen digitalpost har breve som er usendte i en længere periode en tilladt. Perioden er: %s.

...

  • Det nuværende antal er: %d."
  • "Følgende fejl er forekommet for letter %s og %d andre: %s"
  • "Følgende fejl er forekommet for letter %s: %s"

Fejlbeskederne med fejl angiver altid den seneste fejl for et givet brev.

Audit log

Hvert servicekald medfører en ny indgang i auditloggen, som kan være udfyldt med følgende komponenter:

KomponentKontekstTypeNøgleInformation
DPAUUID for kaldetFølsomrequestIndhold af kald mod DPK
DPAUUID for kaldetFølsomresponseIndhold af svar fra DPK
DPAUUID for kaldetFølsommodtager-cprModtagerens CPR
DPAUUID for kaldetIkke personligmessageIdBesked ID for kaldet. Samme som Kontekst.
DPAUUID for kaldetIkke personligskabelonNavn på skabelonen. Ikke nødvendigvis samme som hos DPK

Overvågningstype

Som udgangspunkt overvåges følgende:

Audit log

Auditlogning foretages med ...

...

Standard fejlsøgning

  • Ved problemer med indlæsning af servicens konfigurationsfiler (...) bør man verificere at ...alle påkrævede properties er sat
  • Ved manglende logning hvor der forventes fejlbeskeder bør konfigurationsfilen (log4j...) properties checkes, da logindstillingerne sættes herigennem.
  • En service eller et job kan stoppes og startes gennem docker.

Krav til backup m.m.

Det anbefales at aktuelle konfigurationsfiler til GM-BFF DPA er under versionskontrol og back up.

...

Dokument Historik

3/4 2025Martin Henriksen/SDSEtablering af dokumentation
4/6 2025Markus Andreassen/TriforkUdfyldelse af dokumentation
28/7 2025Markus Andreassen/TriforkUdvidelse af dokumentation ifbm. QA