Version 2.1, 2019-07-12
Indholdsfortegnelse
Indholdsfortegnelse
1 Formål
2 Komponenter og funktionalitet
3 Daglig drift
4 Konfiguration
4.1 Tilføjelse af CVR-numre og typer
5 Overvågning
5.1 Fortolkning af HTML overvågningsside
5.2 Overvågningstyper
5.3 Logfiler og fortolkning af disse
5.4 Konfiguration af overvågning
5.5 Eksempler på status-sider
6 Standard fejlsøgning
7 Krav til backup m.m.
8 Ændringslog
Dokument målrettet systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af komponenten.
Driftsvejledningen indeholder information om komponentens version, standard placering af logfiler og konfigurationsfiler, eksterne afhængigheder, og evt. krav til genstart af applikationer hvis komponenten ikke er responsiv.
Start/stop vejledning for komponenten beskrives, herunder hvilke andre applikationer der evt. skal genstartes. En generel læsevejledning til logfiler vedlægges.
Dette dokument dækker følgende komponenter på NSP og Backoffice:
Komponenterne og deres funktionalitet ses vist i nedenstående diagram:
BRS kræver ingen daglig vedligeholdelse udover sædvanlig systemovervågning.
Al konfiguration på hhv. NSP og Backoffice foregår ved redigering i hhv. brs-frontend.properties og brs-backend.properties, der placeres i "configuration"-folderen under Wildfly.
Bemærk at brs-frontend.properties og brs-backend.properties i visse situationer "overlapper", dvs. indeholder ens properties. Det skyldes fx at man forsøger at skabe evidens både i frontend og backend.
Nedenstående tabel giver en beskrivelse af hver property der kan sættes i filerne og dens default værdier.
Property | Beskrivelse | Default |
---|---|---|
dk.nsi.db.type | Angiver hvilken type database der bruges, værdier kan være "hsqldb" til udvikling og "mysqldb" til test og produktion. | hsqldb |
dk.nsi.validation.mode | Bruges til at bestemme hvordan SAML ID kort skal valideres, kan have 3 værdier "devel", "test" og "prod". bruges "devel" og "test" vil ID kort blive valideret mod seals SosiTestFactory, bruges "prod" vil ID kort blive valideret imod SOSI STS'en | devel |
dk.nsi.auth.whitelistservice.type | Hvilken whitelistservice bruges der. Kan enten være "property" eller "database" | property |
dk.nsi.auth.create.type.cvr.list | Bruges kun hvis "dk.nsi.auth.whitelistservice.type" er sat til "property" | <tom> |
dk.nsi.auth.query.type.type.cvr.list | Bruges kun hvis "dk.nsi.auth.whitelistservice.type" er sat til "property" | <tom> |
dk.nsi.auth.brs.cvr.list | Bruges kun hvis "dk.nsi.auth.whitelistservice.type" er sat til "property" | |
dk.nsi.db.{navn}.url | Database URL - se tabel med miljøspecifikke oplysninger for databaser for detaljer om {navn} | |
dk.nsi.db.{navn}.driverclass | Database driver - se tabel med miljøspecifikke oplysninger for databaser for detaljer om {navn} | |
dk.nsi.db.{navn}.user | Database brugernavn - se tabel med miljøspecifikke oplysninger for databaser for detaljer om {navn} | |
dk.nsi.db.{navn}.pwd | Database adgangskode - se tabel med miljøspecifikke oplysninger for databaser for detaljer om {navn} | |
dk.nsi.db.{navn}.database | Database navn - se tabel med miljøspecifikke oplysninger for databaser for detaljer om {navn} | |
dk.nsi.replicationjob.enabled | Angiver om jobbet er enablet. Er obligatorisk | |
dk.nsi.replicationjob.schedule | CRON-udtryk der afgør hvornår jobbet kører. Se evt. denne beskrivelse. Er obligatorisk. | |
dk.nsi.replicationjob.wsdlurl | Bruges af ReplicationJob til at replikere opfølgninger til backendens replication service. | |
dk.nsi.replicationjob.transferWindow | Definerer det maksimale antal opfølgninger der må sendes ad gangen til backend. | 1000 |
dk.nsi.replicationjob.maxtime | Max tid i minutter en replikering må tage før der laves en alarm. | 120 |
dk.nsi.followupjob.enabled | Angiver om jobbet er enablet. Er obligatorisk | |
dk.nsi.followupjob.schedule | CRON-udtryk der afgør hvornår jobbet kører. Se evt. denne beskrivelse. Er obligatorisk. | |
dk.nsi.followupjob.processingWindow | Definerer antallet af opfølgninger som behandles af gangen i én transaktion | 1000 |
dk.nsi.followupjob.maxtime | Max tid i minutter en behandling af opfølgninger må tage før der laves en alarm. Det er tiden for een batchbehandling der måles imod og ikke den fulde kørsel. | 120 |
dk.nsi.days.to.postpone.next.check | Bruges af FollowupJob: definerer tidsrummet for hvornår næste check af en opfølgning skal laves. Værdien er defineret i dage | 2 |
dk.nsi.notificationcleanupjob.enabled | Angiver om jobbet er enablet. Er obligatorisk | |
dk.nsi.notificationcleanupjob.schedule | CRON-udtryk der afgør hvornår jobbet kører. Se evt. denne beskrivelse. Er obligatorisk. | |
dk.nsi.notificationcleanupjob.olderThanDays | Fjern alarmer som er ældre end denne værdi. Værdien er defineret i dage | 75 |
dk.nsi.notificationcleanupjob.maxtime | Max tid i minutter en oprydning må tage før der laves en alarm. | 120 |
dk.nsi.relation.assigneddoctor.update.frequency | Bruges af brs-nsp til at udregne hvilken relation der er mellem patient og læge. | 10 |
dk.nsi.relation.refhost.update.frequency | Bruges af brs-nsp til at udregne hvilken relation der er mellem patient og læge. | 2 |
dk.nsi.relation.ssr.update.frequency | Bruges af brs-nsp til at udregne hvilken relation der er mellem patient og læge. | 62 |
Følgende databaser kan refereres via {navn} ovenfor:
Miljø | Navn | Beskrivelse |
---|---|---|
BRS-Frontend | stamdata | AssignedDoctor-stamdata |
followup | Data der afventer afsendelse til BRS-Backend | |
register_notifications | Notifikationer til klienter samt SSR/LPR/REFHOST-stamdata. MySQL-replikeres fra backend | |
BRS-Backend | stamdata | AssignedDoctor-stamdata |
register_notifications | Notifikationer til klienter samt SSR/LPR/REFHOST-stamdata. MySQL-replikeres til frontends | |
treatment_releation_followup | Data der modtages fra frontends |
Tilføjelse af CVR numre og typer på NSP'erne foregår i MySQL i tabellen whitelist_config i databasen register_notification. Når en ny af disse tilføjes replikeres opsætningen ud til de øvrige NSP'er automatisk. Der kræves ingen opdatering af brs-frontend/brs-backend.properties i den forbindelse.
BRS-frontend og BRS-backend udstiller overvågningssider, som findes i listen af komponenter i afsnit 2.
På overvågningssiderne fremgår komponentens version og build-dato, opstartstidspunkt samt tidspunkt for testudførsel. Desuden vises udvalgte metrikker angående kaldmængder/antal processeringer (se eksempler i afsnit 5.5).
BRS-overvågningssider returnerer enten:
Grunden til at der returneres HTTP 202 hvis der ikke er forbindelse til backend er, at BRS-frontend stadig kan modtage data, og derfor ikke skal tages ud af load-balanceren. Dog kan fejlen ikke ignoreres på længere sigt.
Der overvåges databaseadgang for de enkelte datasources ved et simpelt "SELECT 1" statement.
For batchjob overvåges der seneste succesfulde kørsel. Hvis denne ikke er udført inden for det forventede tidsrum giver dette anledning til en fejl.
Enhver tilgang til en overvågningsside giver anledning til en mere detaljeret log-indgang hvis den giver fejl.
Alle logfiler er at finde i "log" under Wildfly. Herunder findes en liste over alle logfiler med en beskrivelse af hvilke komponenter der skriver til dem. De enkelte filnavne er konfigureret i logging-profiles i configuration/standalone.xml. Alle logs benytter en rolling file appender, og indeholder derfor et postfix i filnavnet (fx brs-frontend.log.1) der ikke er præsenteret i nedenstående liste.
Logfilnavn | Komponenter der skriver til denne |
---|---|
brs-frontend.log | brs-frontend.war. Diverse logninger af komponentens opførsel, inklusiv fejllogninger. |
brs-frontend-audit.log | brs-frontend.war, audit-logning af requests |
brs-metrics.log | Indeholder udvalgte logninger om svartider, antal behandlede records osv. Skrives både af frontend og backend. |
brs-backend.log | brs-backend.war. Diverse logninger af komponentens opførsel, inklusiv fejllogninger. |
Ved en fejl på en overvågningsside skrives der til den relevante brs-frontend/brs-backend.log. Alle logs indekseres med Splunk.
Følgende settings påvirker overvågningssnitfladen
dk.nsi.followupjob.maxtime=120
dk.nsi.notificationcleanupjob.maxtime=120
dk.nsi.replicationjob.maxtime=120
Her angiver man i minutter hvor langt tid de enkelte jobs max må tage at udføre inden overvågningssnitfladen vil begynde at returnerer HTTP 500.
BRS-frontend OK:
BRS-frontend med warning om manglende forbindelse til backend (HTTP 202):
BRS-backend OK:
BRS-backend med fejl pga. MySQL (HTTP 500):
BRS-backend med fejl pga. at behandlingstiden for en opfølgning er for langt. Fejlen opstår når et batch til opfølgning tager for lang tid. Og status viser både hvorhvornår en kørsel er kørt helt færdig, og hvornår et batch er blevet kørt færdig.
Status-siderne er også i stand til at trække yderligere informationer om køstørrelser osv. fra MySQL. Disse oplysninger inkluderes dog ikke i de normalt responses, da de genererer et vist load på MySQL, men de kan trækkes ved at tilføje en "?detailed"-parameter på URLen til status-siden (fx http://host:port/brs-nsp/status?detailed).
Nedenfor ses eksempler på hvilke oplysninger der inkluderes på hhv. frontend og backend. På frontend ses det at der ligger 5 records der afventer overførsel til backend, samt 1 notification der kan hentes af klienter:
På backend rapporteres det, at followup-jobbet har 5 records der afventer behandling, 85 records der er udsat til senere check, samt en notifikation der kan hentes af klienter:
Data fra eksterne registre vil løbende blive slettet. Der bør derfor foretages backup af indkomne registerdata på en forsvarlig måde, i tilfælde af behovet for en genetablering af data på register_alarm i tilfælde af nedbrud. Disse skal opbevares på en forsvarlig måde da der er tale om personhenførbare data.
Version | Dato | Ændring | Ansvarlig |
---|---|---|---|
0.1 | 2011-06-15 | Initielt Dokument | Trifork |
0.2 | 2011-07-27 | Opdatering af dokumentation jf. implementation af generelle notifikationer | Trifork |
0.3 | 2011-08-10 | Opsplitning af dokumentation jf. opsplitning af BRS og GOS | Trifork |
0.4 | 2011-10-05 | Mindre tilretninger jf. Stamdatas replikering af Sikrede data | Trifork |
1.0 | 2012-06-08 | Tilføjet SQL til oprydning på BRS tabeller | Trifork |
1.1 | 2013-10-21 | Opdateret SVN link | Trifork |
2.0 | 2017-03-10 | Diverse opdateringer ifm. BRS2 | Trifork |
2.1 | 2019-07-12 | Indsat status eksempel på behandlingstid for opfølgning er for lang | KvalitetsIT |