Introduktion

Formål

Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af servicen.

Driftsvejledningen indeholder information om Min Spærring komponenterne med hensyn til eksterne afhængigheder, standardplacering af logfiler og konfigurationsfiler, og evt. krav til genstart af applikationer hvis komponenten ikke er responsiv.

I afsnit 2 er beskrevet hvilke komponenter der indgår i Min Spærring services og deres forventede placering med hensyn til platform.

Afsnit 4 beskriver aktuelle konfigurationsparametre for Min Spærring services, samt eksempler på konfigurationsparameterfiler.

Afsnit 5.1, 5.2 og 5.3 beskriver hvorledes Min Spærring komponenterne overvåges.

I afsnit 5.4 er Min Spærring service relaterede logfiler beskrevet, så disse evt. kan overvåges, og tillige danne baggrund for fejlsøgning.

Beskrivelse af standard fejlsøgning og start/stop vejledning for komponenterne er beskrevet i afsnit 6.

Specielle krav til backup er beskrevet i afsnit 7, ligesom procedure ved reetablering af komponenten ud fra backup beskrives.

Læsevejledning

Læseren forventes at have kendskab til Sundhedsdatastyrelsens platform NSP, samt generelt kendskab til WildFly applikation server, Docker, Docker Compose samt Ubuntu Linux operativ system

Dokumenthistorik

Definitioner og referencer

Komponenter

Dette dokument dækker følgende komponenter på NSP:

• NSP komponenter

  • Consent-verification

    • Type: Webservice

    • Filnavn: consent-verification.ear

    • Url: <serverurl>/consent-verification/service

    • Servicecheckurl: <serverurl>/consent-verification/info/servicecheck

    • StatusUrl: <serverurl>/consent-verification/info/status

    • Versionsurl: <serverurl>/consent-verification/info/version

    • DKS-konfiguration: <serverurl>/consent-verification/dccconfig/dks

• DoDi – Dataopdateringkomponenter

  • Consent-administration

    • Type: Webservice

    • Filnavn: consent-administration.ear

    • Url: <serverurl>/consent-administration/service

    • Url: <serverurl>/consent-administration/servicev2

    • Servicecheckurl: <serverurl>/consent-administration/info/servicecheck

    • StatusUrl: <serverurl>/consent- administration/info/status

    • Versionsurl: <serverurl>/consent-administration/info/version

    • DKS-konfiguration: <serverurl>/consent-administration/dccconfig/dks

Consent-administration komponenten anvender desuden Min-log-registreringsservicen, som skal være tilgængelig på DoDi’en.

Daglig drift

Dette afsnit beskriver den daglige drift af systemet.

Synkronisering af consent database fra Min Spærring administrationsservice til NSP

Min Spærring administration er en central service, der opbevarer borgeres registrerede samtykker/spærringer i consent databasen.

Der skal sikres at borgernes opdateringer af registrerede samtykker/spærringer i den centrale consent database replikeres til den enkelte NSP.

Konfiguration

Min Spærring administration

Servicekonfiguration

Grundlæggende konfiguration foregår ved redigering i filen ConsentAdministration.properties, der placeres i følgende WildFly modul:

/pack/wildfly8/modules/nsi/consentadministration/config/main/

I denne skal følgende properties være definerede:

I den properties-fil, der udpeges af propertien ”client.minlog.properties”, skal følgende properties defineres:

Følgende properties skal være defineret, for at starte servicen op med DGWS-sikkerhed i forbindelse med adviseringer til NAS:

Følgende properties skal være defineret når Minspærring skal kalde SAES, SORES og SYES ifm. parametervalidering:

dk.nsi.app.name

dk.nsi.app.shortName

dk.nsi.consent.sor.service.url

dk.nsi.consent.validate.healthcare.professional.cpr

dk.nsi.consent.validate.organization

dk.nsi.consent.sor.fail.threshold

dk.nsi.consent.sor.max.total.connections

dk.nsi.consent.sor.default.max.connections.per.route

dk.nsi.consent.saes.fail.threshold

dk.nsi.consent.saes.connect.timeout.millis

dk.nsi.consent.saes.read.timeout.millis

dk.nsi.consent.saes.service.url

dk.nsi.consent.syes.fail.threshold

dk.nsi.consent.syes.connect.timeout.millis

dk.nsi.consent.syes.read.timeout.millis

dk.nsi.consent.syes.service.url

Eksempel på ”ConsentAdministration.properties” fil (bemærk at ”client.minlog.properties” udpeger filen selv, og at Min-log-klient properties derfor er defineret i samme fil):

idcard.version = 1.0.1
sts.test.mode = false

log.config.file=consentadministration.log4j.properties

client.minlog.properties = ConsentAdministration.properties
registration.wsdl.location = http://localhost:8080/minlog-registration/service?wsdl
registration.invoker.timeout = 30000
registration.log.organisation_name=(organisationsnavn blev ikke udfyldt på registreringstidspunktet)

databasecheck.statement.consent=SELECT * FROM consent.consentitem LIMIT 1;
databasecheck.statement.what=SELECT * FROM consent.whatitem LIMIT 1;
databasecheck.statement.who=SELECT * FROM consent.whoitem LIMIT 1;
whitelistds.statement=SELECT * FROM whitelist.whitelist_config LIMIT 1;

servicestatuscheck.database.failurethreshold = 1

idcard.subject.id.type = medcom:cvrnumber
idcard.subject.id = 46837428
idcard.subject.name = NETS DANID A/S - TU VOCES gyldig
idcard.level = 3
idcard.system.name = MinSpærring
sts.endpoint = http://test1-cnsp.ekstern-test.nspop.dk:8080/sts/services/SecurityTokenService
sts.keystore = Statens_Serum_Institut_VOCES.jks
sts.keystore.password = Test1234

# Kafka
kafka.producer.bootstrap.servers=kafka:9092
kafka.producer.client.id=MinSpaerringMinLog2-producer
kafka.producer.key.serializer=org.apache.kafka.common.serialization.StringSerializer
kafka.producer.value.serializer=org.apache.kafka.common.serialization.StringSerializer
kafka.topic=MIT_TOPIC

log4j konfiguration

Log4j konfiguration findes i (hvis ovenstående format anvendes) consentadministration.log4j.properties filen.

Se yderligere opsætning i installationsvejledningen.

SLA-log konfiguration

Konfiguration af SLA-log findes i filen nspslalog-consentadministration.properties.

DKS konfiguration

Indholdet, der returneres ved kald af DCC Konfiguration Service-snitfladen (DKS), indlæses af DDS Registry fra filen:

/pack/wildfly8/modules/nsi/consentadministration/config/main/dksConfiguration.xml

Filen skal overholde DKS XML-skemaet og beskriver de webservice-operationer Min Spærring administrationsservicen udstiller jf. [DKS-beskrivelse].

Test af DKS

Efter konfiguration og deployering af Min Spærring administrationsservicen, kan DKS-snitfladen testes med:

curl –i localhost:8081/consent-administration/dccconfig/dks

Succesfuldt svar giver indholdet svarende til dksConfiguration.xml nævnt ovenfor.

Test af versionsnummer

Efter konfiguration og deploy af Min Spærring administrationsservicen kan versionsnummeret hentes via en HTTP-snitflade.

curl –i http://localhost:8081/consent-administration/info/version

hvilket giver output I stil med:

version 1.1.2

I eksemplet kørte servicen på en local maskine konfigureret til port 9090.

Min Spærring verifikation

Service konfiguration

Grundlæggende konfiguration foregår ved redigering i filen ConsentVerification.properties, der placeres i følgende WildFly modul:

/pack/wildfly8/modules/nsi/consentverification/config/main/

I denne skal følgende properties være definerede:

Eksempel på properties fil:

idcard.version = 1.0.1
sts.test.mode = false

log.config.file=consentverification.log4j.properties

databasecheck.statement.consent=SELECT * FROM consent.consentitem LIMIT 1;
databasecheck.statement.what=SELECT * FROM consent.whatitem LIMIT 1;
databasecheck.statement.who=SELECT * FROM consent.whoitem LIMIT 1;
whitelistds.statement=SELECT * FROM whitelist.whitelist_config LIMIT 1;

servicestatuscheck.database.failurethreshold = 1

Log4j konfiguration

Log4j konfiguration findes i (hvis ovenstående format anvendes) consentverification.log4j.properties filen.

Se yderligere opsætning i installationsvejledningen.

SLA-log konfiguration

Konfiguration af SLA-log findes i filen nspslalog-consentverification.properties.

DKS konfiguration

Indholdet, der returneres ved kald af DCC Konfiguration Service-snitfladen (DKS), indlæses af Min Spærring verifikationsservicen fra filen:

/pack/wildfly8/modules/nsi/consentverification/config/main/dksConfiguration.xml

Filen skal overholde DKS XML-skemaet og beskriver de webservice-operationer Min Spærring verifikationsservicen udstiller jf. [DKS-beskrivelse].

Test af DKS

Efter konfiguration og deployering af Min Spærring verifikationsservicen, kan DKS-snitfladen testes med:

curl –i localhost:8080/consent-verification/dccconfig/dks

Succesfuldt svar giver indholdet svarende til dksConfiguration.xml nævnt ovenfor.

Test af versionsnummer

Efter konfiguration og deploy af Min Spærring verifikationsservicen kan versionsnummeret hentes via en HTTP-snitflade:

curl http://localhost:8080/consent-verification/info/version

hvilket giver output I stil med:

Version 1.1.2

I eksemplet kørte servicen på en lokal maskine konfigureret til port 9090.

Monitoreringssnitflader på Min Spærring services

Til monitorering af Min Spærring services findes to servicespecifikke sniflader: servicecheck og status, beskrevet i det følgende.

Servicecheck-snitfladen

Servicecheck-snitflade for Min Spærring servicen, der kaldes under opstart af servicen, kontrollerer tilgængelighed (og i et vist omfang indhold) af property-filer og afprøver aktivt forbindelsen til databaser.

Specielt vedrørende testConnection på JBoss

På grund af en kendt fejl i JBoss 6, logges en række exceptions i server loggen, hvis følgende filer ikke findes (de må gerne være tomme):

/pack/jboss/server/default/conf/props/roles.properties
/pack/jboss/server/default/conf/props/users.properties

Konfiguration af databasemonitorering

Databasemonitoreringen fungerer ved at lave en simpel query mod Min Spærring databasens tabeller. Der laves en query mod hver tabel. Disse queries er justerbare og kan ændres i hhv. ConsentAdministration.properties og ConsentVerification.properties.

databasecheck.statement.consent=SELECT * FROM consent.consentitem LIMIT 1;
databasecheck.statement.what=SELECT * FROM consent.whatitem LIMIT 1;
databasecheck.statement.who=SELECT * FROM consent.whoitem LIMIT 1;
whitelistds.statement=SELECT * FROM whitelist.whitelist_config LIMIT 1;

Test af Servicecheck-snitfladen

Til Servicecheck-snitfladen findes en servlet i Min Spærring services.

Efter konfiguration og deploy af Min Spærring servicen, kan den testes med:

curl –i localhost:8081/consent-administration/info/servicecheck
curl –i localhost:8080/consent-verification/info/servicecheck

Servicen returnerer følgende http koder:

• Der returneres http kode 200 ved normal situation.

• http fejlkode 404 returneres hvis servicen ikke er deployeret

• Hvis databasen ikke er tilgængelig eller ved intern fejl i WildFly returneres kode 500. Fejlbeskeden vil kunne ses i consentadministration-servicecheck.log eller consentverification-servicecheck.log alt efter hvilken service der er kaldt. Såfremt der ikke er nogen fejlbeskeder i loggen bør property-filen undersøges som det første, da det er herigennem logindstillingerne bestemmes.

Status-snitfladen

Status-snitfladen laver passiv opsamling af resultater ved kald af database hhv. Min Spærring administrationsservicens kald af MinLog-servicen. Status-snitfladen opsamler data på hvor mange kald til database og MinLog-service, der er fejlet, og melder fejl hvis det overstiger de threshold-værdier, der er defineret i property-filen for hhv. Min Spærring administrationsservicen og Min Spærring verifikationsservicen.

Test af monitorering af status

Efter konfiguration og deploy af Min Spærring services, kan den testes med:

curl –i localhost:8081/consent-administration/info/status
curl –i localhost:8080/consent-verification/info/status

Servicen returnerer følgende http koder:

• Der returneres http kode 200 ved normal situation.

• http fejlkode 404 returneres hvis servicen ikke er deployeret

• Hvis en eller flere af afhængighederne mangler eller ved intern fejl i WildFly returneres kode 500. Fejlbeskeden vil kunne ses i en af filerne consentadministration-status.log og consentverification-status.log. Såfremt der ikke er nogen fejlbeskeder i loggen bør property-filen undersøges som det første, da det er herigennem logindstillingerne bestemmes.

Overvågning

Min Spærring verifikations- og administrationsservices overvåges af en servicespecifik servicechecksnitflade samt en statussnitflade. Disse snitfladers url’er kan aflæses i afsnit 2.

Placering af HTML overvågningsside

Under listen af komponenter først i dette dokument, er der henvisninger til overvågningssiderne.

Fortolkning af HTML overvågningsside

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

Overvågningstype

Simpel webside deployeret på serveren. Som udgangspunkt overvåges følgende:

1. Tilstedeværelse og indhold af propertyfil

2. Forbindelse til datasources via JNDI opslag

Logfiler og fortolkning af disse

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.

For alle webservices er der en tilhørende SLA-log, der sørger for at logge udvalgte elementer fra requests til webservicen. For Min Spærring Services logges alle kald til ConsentAdministrationBean og ConsentVerificationBean til hver deres log. Loggen indeholder informationer om de kald der er lavet til webservicen, herunder hvilken serviceoperation der er kaldt og behandlingstid for kaldet.

SLA-logpunkter for indkommende kald til Min Spærring administration:

• ConsentRegistrationsGet

• ConsentAdd

• ConsentModify

• ConsentRevoke

SLA-logpunkter for udgående kald fra Min Spærring administration:

SLA-logpunkter for indkommende kald til Min Spærring verificering:

• ConsentForUserCheck

• ConsentForDataCheck

• ConsentForForeignersCheck

Auditlogning is done using the official NSP Audit Log modul.

De forskellige håndtag logges på følgende måde.

Min Spærring verificering Audit data

Standard fejlsøgning

• Ved problemer med indlæsning af servicens konfigurationsfil (ConsentVerification.properties eller ConsentAdministration.properties) bør man verificere at filen ligger korrekt i modul folderen. Vær opmærksom på at filen ikke læses, hvis den ikke er til stede ved opstart af WildFly serveren.

• Ved manglende logning hvor der forventes fejlbeskeder bør konfigurationsfiler (ConsentVerification.properties, ConsentAdministration.properties) checkes, da logindstillingerne sættes herigennem.

• Servicen kan genstartes ved at genstarte den docker container som servicen kører i. 

Krav til backup m.m.

Databasen til Min Spærring administration skal sikres med backup.

Derudover anbefales sikring af aktuelle konfigurationsfiler til Min Spærring services.