# Konfiguracja

Strona opisuje wszystkie ustawienia `tcp-service` i `admin` oraz sposoby ich zmiany. Jest dla programistów, testerów i osób wdrażających aplikację, które muszą dostosować porty, limity albo zachowanie panelu. Sposób uruchomienia opisuje strona [Uruchamianie i testowanie](<https://docs.logintegra.com/weight-gateway/uruchamianie/index.md>).

## Gdzie jest konfiguracja

Każda aplikacja czyta plik `grails-app/conf/application.yml` swojego modułu. Moduły `weight-protocol` i `mock` nie mają własnej konfiguracji. Mock dostaje adres i port jako argumenty, a parser dostaje limit długości rekordu od `tcp-service`.

| Plik | Znaczenie |
| --- | --- |
| `tcp-service/grails-app/conf/application.yml` | ustawienia nasłuchu TCP i endpointu `GET /weight` |
| `admin/grails-app/conf/application.yml` | ustawienia panelu, symulatora i bazy danych |
| `<moduł>/grails-app/conf/application-development.yml` | dodatkowe ustawienia środowiska `development` |
| `<moduł>/grails-app/conf/logback-spring.xml` | poziomy logowania |

## tcp-service

| Klucz | Domyślnie | Znaczenie |
| --- | --- | --- |
| `weight.port` | `14002` | port TCP, na którym bramka przyjmuje połączenie od MOXA |
| `weight.max-record-bytes` | `512` | maksymalna długość jednej linii przed CRLF |
| `weight.read-timeout-ms` | `60000` | czas ciszy od wagi, po którym bramka zamyka połączenie |
| `weight.max-age-ms` | `5000` | maksymalny wiek odczytu serwowanego przez `GET /weight` |
| `server.port` | `8080` | port HTTP, domyślny port Grails |

W środowisku `test` `weight.port` ma wartość `0`, więc system operacyjny wybiera wolny port.

### weight.max-age-ms

Po tym czasie od odebrania rekordu `GET /weight` zwraca status 503 z kodem `STALE`. Wartość musi być większa niż okres, z którym waga wysyła odczyty. Zbyt mała wartość powoduje fałszywe błędy `STALE` przy zdrowym połączeniu.

### weight.read-timeout-ms

Po przekroczeniu timeoutu bramka zamyka połączenie, a MOXA łączy się ponownie. Ustawienie `SO_KEEPALIVE` jest zawsze włączone i nie ma osobnego klucza.

### weight.max-record-bytes

Linia dłuższa niż ta wartość daje rekord `NON_DIGIT`, a reszta linii jest odrzucana do następnego CRLF. Poprawny rekord ma co najwyżej 6 znaków, więc domyślne 512 bajtów zostawia duży zapas.

## admin

| Klucz | Domyślnie | Znaczenie |
| --- | --- | --- |
| `server.port` | `8081` | port HTTP panelu |
| `mock.enabled` | `true`, w `production` `false` | włącza stronę mocka `/mockScale` |
| `mock.gateway.host` | `127.0.0.1` | adres bramki podpowiadany w formularzu mocka |
| `mock.gateway.port` | `14002` | port bramki podpowiadany w formularzu mocka |
| `gateway.status-url` | `http://127.0.0.1:8080/status` | adres `GET /status` w `tcp-service`, z którego panel czyta status połączenia |
| `gateway.timeout-ms` | `1000` | czas oczekiwania na odpowiedź `tcp-service`, po którym strona pokazuje "Gateway unreachable" |

Gdy `mock.enabled` ma wartość `false`, każda akcja `mockScale` zwraca 404.

Aktualne wartości powyższych kluczy z opisami pokazuje strona `/config` w panelu (tylko odczyt).

### Baza danych

Panel używa bazy H2 ustawionej w `dataSource`.

| Środowisko | `dbCreate` | Adres |
| --- | --- | --- |
| `development` | `create-drop` | `jdbc:h2:mem:devDb`, baza w pamięci |
| `test` | `update` | `jdbc:h2:mem:testDb`, baza w pamięci |
| `production` | `none` | `jdbc:h2:./prodDb`, plik w katalogu roboczym |

Dane w środowiskach `development` i `test` znikają po zatrzymaniu aplikacji. Symulator wagi trzyma stan w pamięci i nie zapisuje niczego w bazie.

## Zmiana ustawień bez edycji pliku

Aplikacje są oparte o Spring Boot, więc każdy klucz można nadpisać z zewnątrz. Pierwszeństwo od najwyższego mają argumenty linii poleceń, właściwości systemowe i zmienne środowiskowe, a dopiero potem plik `application.yml`.

| Sposób | Przykład |
| --- | --- |
| zmienna środowiskowa | `WEIGHT_MAX_AGE_MS=10000` |
| właściwość systemowa JVM | `-Dweight.max-age-ms=10000` |
| argument aplikacji | `--weight.max-age-ms=10000` |

Nazwa zmiennej środowiskowej powstaje z klucza przez zamianę kropek i myślników na podkreślenia i zapis wielkimi literami. Klucz `weight.max-age-ms` daje więc `WEIGHT_MAX_AGE_MS`.

```
WEIGHT_PORT=14003 SERVER_PORT=8090 ./gradlew :tcp-service:bootRun
```

## Środowiska

Gradle uruchamia aplikację w środowisku `development`, testy w środowisku `test`, a zbudowany plik wykonywalny w środowisku `production`. Wartości z sekcji `environments` w `application.yml` nadpisują wartości domyślne tylko w danym środowisku.

## Logowanie

Poziomy logowania są w `grails-app/conf/logback-spring.xml` każdego modułu. Domyślny poziom to `INFO`.

`WeightService` loguje każdy poprawny odczyt na poziomie `DEBUG`, a rekordy niepoprawne na poziomie `WARN`. Żeby zobaczyć każdy odczyt, odkomentuj w `tcp-service/grails-app/conf/logback-spring.xml` wiersz:

```
<logger name="org.logintegra" level="DEBUG"/>
```

Przy odczycie co \~230 ms ten poziom szybko wypełnia log, więc na produkcji ostrożnie.

## Konfiguracja mocka

Mock nie czyta plików konfiguracyjnych. Wszystkie ustawienia dostaje jako argumenty polecenia `./gradlew :mock:run --args="<host> <port> [periodMs] [weight]"`.

| Argument | Domyślnie | Znaczenie |
| --- | --- | --- |
| `host` | brak, wymagany | adres bramki |
| `port` | brak, wymagany | port TCP bramki, zwykle `14002` |
| `periodMs` | `1000` | odstęp między odczytami w milisekundach |
| `weight` | losowa 0 do 100000 | stała waga wysyłana w każdym odczycie |
