Mikroteenuste logifailid

19. veebruar 2024


Mis on mikroteenuste logifailid?

Erply mikroteenuseid kasutatakse riistvara integreerimiseks, et võimaldada kassa veebipõhisel rakendusel suhelda seadmega (makseterminal, printer, kaardilugeja jne).

Need mikroteenused annavad võimaluse salvestada kassa veebirakenduse ja seadme vahel vahetatud sõnumite logid. See on eriti kasulik riistvaraintegratsiooniga seotud probleemide tõrkeotsinguks. Logid salvestatakse faili, mis salvestatakse arvutisse, kus riistvara on konfigureeritud (nt arvutisse, kuhu printer on ühendatud).

Kuidas logimist lubada

Logimine on lubatud, määrates parameetri mikroteenuse konfiguratsioonifailis.

Seda saab määrata Erply POS Wizard'ist: https://posow.erply.com

Juurdepääs mikroteenuse konfiguratsioonifailile ErplyWizard'is

  • Avage Erply viisard ja logige sisse oma Erply mandaatidega
  • Avage Installirakendus -> Installimine ja veenduge, et installirakendus on installitud ja tuvastatud, et see töötab
  • Minge mikroteenuste haldurisse. Valige jaotises Olemasoleva mikroteenuse värskendamine integratsioon, mille jaoks soovite logid lubada (nt Cayan)
  • Järgmisel ekraanil kuvatakse kaks tekstiplokki
    • Vasakul on praegune konfiguratsioonifail, nagu see on kohalikus masinas
    • Paremal on tekstiredaktor, mis võimaldab teil selles konfiguratsioonifailis muudatusi teha

Määra logimise sihtmärk

Logifailide arvutisse salvestamiseks tuleb mikroteenuse installikaustas määrata parameetri logTarget väärtuseks FILE.

"logTarget": "FILE"

Logimise taseme määramine

Logimisel on 4 taset:: "info", "warn", "error", "debug"

Vaikimisi on logi väärtuseks seatud "error".

Kui proovite integratsiooniprobleemi tõrkeotsingut teha, annab "debug" teile kõige rohkem teavet:

"logLevel": "DEBUG"

Lükake muudatused konfiguratsioonifaili Erply Wizard'is

  • Otsige konfiguratsioonifaili redaktoris (parempoolses tekstiplokis) üles parameetrid "logTarget" ja "logLevel" ning määrake väärtused vastavalt.
  • Pärast väärtuste muutmist veenduge, et parempoolse tekstiploki all olev nupp oleks roheline ja kirjas "Valid JSON". Kui konfiguratsioonifaili muudetud versioon on vale, muutub nupp punaseks ja kuvatakse teade „Invalide JSON”
  • Vajutage vasakpoolse tekstiploki all nuppu "Salvesta uus konfiguratsioon", et lükata muudatused kohalikku konfiguratsioonifaili (salvestatud arvutisse).
  • Vajutage lehe allosas nuppu Stopp, seejärel klõpsake uuesti, kuna see on lülitunud nupule Start. Seda tehakse mikroteenuse taaskäivitamiseks, et see laadiks uue konfiguratsiooni.

⚠️ Changing logging parameters is not retroactive. 
If you are changing the log level to capture more comprehensive information (eg from INFO to DEBUG), the change will only affect future usages of the integration/microservice.

Kuhu mikroteenuste logifailid salvestatakse?

See on siis, kui "logTarget": "FILE"

Windows'i peal

Erply installeri ja mikroteenuste installimisel installitakse need vaikimisi alla: C -> Program Files -> Erply

Erply kausta all on igal mikroteenusel ja versioonil oma alamkaust.

Nt: C -> Program Files -> Erply -> cayan-integration -> v1.5.15

MacOS'i peal

Erply kaust luuakse juurkausta alla.

Kuidas MacOS-is logifailidele juurde pääseda?

  • Avage Finder
  • Vajutage Go ülemisel menüüribal ja seejärel Go to Folder
  • Sisestage /Library/Erply ja vajutage Go
  • Ava mikroteenuse nimi (nt swedbank-ingenico), seejärel ava mikroteenuse versiooni järgi nime saanud kaust
  • Kui logid on lubatud, on olemas logide kaust. Te ei saa seda avada, kui mikroteenus töötab.

Kuidas MacOS-i toega jagada logifaile?

  • Paremklõps logide kaustale ja valige kopeeri “logid”
  • Minge kausta, kust saate logid meiliga saata, näiteks "Allalaadimised"
  • Kleepige logide kaust (käsk + V või Redigeerimine -> Kleebi üksused ülemiselt menüüribalt)
  • Saate hoiatuse: „Teil võib olla vaja sisestada selle arvuti administraatori nimi ja parool, et muuta üksust nimega „logid”.
  • Vajutage nuppu “Jätka”
  • Sisestage arvuti parool (mitte appleID parool)
  • Nimetage kleebitud logide kaust ümber ja edastage see tugimeeskonnale

Mis on logi pööramine?

Kui logid salvestatakse arvutisse (​logTarget: FILES), ei säilitata logisid lõputult. Et arvutit mitte segamini ajada, on failide suurus ja arv piiratud. Arvestatakse ainult kõige värskemaid logisid.

Näiteks kui logi pööramine on seatud nii, et see säilitab ainult 2 faili ja iga fail on seatud sisaldama ainult 2 päeva teavet, siis 5. päeval säilitatakse 2. kuni 5. päeva logifailid, kuid 1. päeva logifail. kustutatakse.

Kuidas logide pööramise reegleid muuta?

Logide pööramise reegleid saab määrata mikroteenuse konfiguratsioonifailis:
logRotateBytes: määrab maksimaalse suuruse, mida logifail võib enne selle pööramist suurendada
logRotateDuration: määrab aja päevades, millal logifaili pöörata (maksimaalne vanus)
logRotateMaxFiles: määrab säilitatavate logifailide arvu