Konfiguracja
Ta strona opisuje konfigurację, którą przygotowują administratorzy, żeby konsument RabbitMQ odbierał wiadomości. Wiadomości z kolejek odbiera aplikacja lowcode-queue-consumer. Dla każdej kolejki z jej konfiguracji rejestruje listenera, a każdą odebraną z tej kolejki wiadomość przekazuje do przypisanego do niej konsumenta.
Do konfiguracji potrzebujesz danych, które projektant procesu ustalił z administratorami i przesłał w zgłoszeniu (przykład zgłoszenia): nazwy kolejki, nazwy konsumenta, nazwy kolejki DLQ i nazwy połączenia.
Przykład konfiguracji
Wszystkie zmienne ustawiasz w pliku env.yaml (ConfigMap) aplikacji lowcode-queue-consumer. Pełny przykład konfiguracji z jednym połączeniem i jedną kolejką:
# Repozytorium artefaktów: z niego aplikacja pobiera skrypty konsumentów
EXIMEE_REPOSITORY_USER: '<uzytkownik>'
EXIMEE_REPOSITORY_PASSWORD: '<haslo>'
# Eximee BPMS: do niego skrypty wysyłają wiadomości wznawiające procesy
EXIMEE_ROUTER_ENGINE_USER: '<uzytkownik>'
EXIMEE_ROUTER_ENGINE_PASSWORD: '<haslo>'
# Dane brokera RabbitMQ, wspólne dla wszystkich połączeń
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_HOST: 'rabbitmq.bank.local'
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_PORT: '5671'
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_SSL_ENABLED: 'true'
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_SSL_VALIDATE_SERVER_CERTIFICATE: 'true'
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_SSL_VERIFY_HOSTNAME: 'true'
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_VIRTUAL_HOST: 'eximee'
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_USERNAME: '<uzytkownik>'
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_PASSWORD: '<haslo>'
# Połączenie "integration": kolejka -> konsument oraz kolejka -> DLQ
SCRIPT_QUEUE_INTEGRATION_QUEUE_MAPPING: 'eximee_demo_integration=message_consumer_demo'
SCRIPT_QUEUE_INTEGRATION_QUEUE_DLQ_MAPPING: 'eximee_demo_integration=eximee_demo_integration.dlq'Kolejne sekcje opisują, skąd wziąć wartości do tego przykładu, jak przygotować broker, a potem połączenia, segment COMMON i każdą zmienną.
Dane ze zgłoszenia
Nazwa połączenia, na przykład integration
Projektant procesu może zaproponować nazwę. Potwierdź ją albo wskaż istniejące połączenie, do którego dopiszesz mapowanie kolejki. Użyj jej wielkimi literami w nazwach zmiennych, na przykład SCRIPT_QUEUE_INTEGRATION_QUEUE_MAPPING. Nazwa nie może zawierać znaku _ (sekcja Nazwa połączenia).
Kolejka
Załóż kolejkę na brokerze (sekcja Przygotowanie brokera) i wpisz ją po lewej stronie QUEUE_MAPPING.
Nazwa konsumenta
Wpisz ją po prawej stronie QUEUE_MAPPING, na przykład eximee_demo_integration=message_consumer_demo. Nazwa musi być identyczna z nazwą konsumenta w Eximee Designer.
Kolejka DLQ
Załóż kolejkę na brokerze i wpisz ją w QUEUE_DLQ_MAPPING, na przykład eximee_demo_integration=eximee_demo_integration.dlq (sekcja Obsługa błędów: DLX i DLQ).
Przygotowanie brokera
Platforma nie tworzy kolejek, exchange'y ani bindingów na brokerze. Przed zmianą konfiguracji Eximee administrator RabbitMQ zakłada na brokerze kolejkę, z której konsument ma czytać, oraz kolejkę DLQ. Sposób przygotowania DLQ opisuje sekcja Obsługa błędów: DLX i DLQ.
Połączenia i segment COMMON
Konfiguracja składa się z nazwanych połączeń. Połączenie to dane brokera (adres, virtual host, użytkownik, TLS) oraz mapowanie kolejek na konsumentów. Dla każdego połączenia aplikacja otwiera osobne połączenie z brokerem.
COMMON nie jest połączeniem. To zestaw wartości domyślnych, które aplikacja dołącza do każdego połączenia. Połączenie może nadpisać dowolną z nich własną wartością. Konfiguracja, która zawiera tylko zmienne COMMON, nie tworzy żadnego połączenia i nie odbiera wiadomości.
Typowa konfiguracja: jeden broker
Jeśli wszystkie kolejki leżą na jednym brokerze, w jednym virtual hoście. Wtedy:
dane brokera ustaw raz, w zmiennych
SCRIPT_QUEUE_COMMON_CONSUMER_CLIENT_*,utwórz jedno połączenie, na przykład
INTEGRATION, i ustaw w nim tylko mapowanie kolejek,każdą kolejną kolejkę dopisz do mapowania tego samego połączenia, po przecinku.
Tak wygląda przykład konfiguracji na początku strony. Z dwiema kolejkami mapowanie połączenia INTEGRATION ma postać:
Jeden konsument może być przypisany do kilku kolejek. Jedna instancja aplikacji przetwarza wiadomości z danej kolejki pojedynczo, jedną po drugiej.
Kilka połączeń: inny broker, virtual host albo użytkownik
Dodaj kolejne połączenie, gdy część kolejek leży na innym brokerze, w innym virtual hoście albo wymaga innego użytkownika. W nowym połączeniu ustaw tylko te dane, które różnią się od COMMON, oraz jego własne mapowanie.
Przykład: kolejki partnera leżą na tym samym brokerze, ale w virtual hoście partner. Połączenie PARTNER nadpisuje virtual host, a adres, port, TLS i dane logowania bierze z COMMON:
Nazwa połączenia
Nazwa połączenia to fragment nazwy zmiennej pomiędzy SCRIPT_QUEUE_ a _QUEUE_MAPPING. W przykładzie SCRIPT_QUEUE_INTEGRATION_QUEUE_MAPPING połączenie nazywa się INTEGRATION, a w logach aplikacji występuje jako integration.
Nazwa połączenia to jedno słowo, bez znaku
_. Aplikacja traktuje znak_w nazwie zmiennej jako separator. Ze zmiennejSCRIPT_QUEUE_BANK_CENTRALNY_QUEUE_MAPPINGnie powstanie połączenieBANK_CENTRALNY, a listener nie zostanie zarejestrowany. Użyj na przykładBANKCENTRALNY.Nazwa
COMMONjest zarezerwowana dla wartości domyślnych i nie tworzy połączenia.
Zmienne aplikacji lowcode-queue-consumer
Repozytorium artefaktów i Eximee BPMS
EXIMEE_REPOSITORY_URL
Adres repozytorium artefaktów.
http://eximee-repository:8080
EXIMEE_REPOSITORY_USER
Użytkownik repozytorium artefaktów.
Brak (wymagane)
EXIMEE_REPOSITORY_PASSWORD
Hasło użytkownika repozytorium artefaktów.
Brak (wymagane)
EXIMEE_ROUTER_ENGINE_URL
Adres API Eximee BPMS.
http://eximee-router-engine:8080/engine-rest
EXIMEE_ROUTER_ENGINE_USER
Użytkownik Eximee BPMS.
Brak (wymagane)
EXIMEE_ROUTER_ENGINE_PASSWORD
Hasło użytkownika Eximee BPMS.
Brak (wymagane)
Połączenie z brokerem
Zamiast <POLACZENIE> wpisz COMMON (wartość dla wszystkich połączeń) albo nazwę połączenia (wartość tylko dla niego). Wartość domyślna obowiązuje, gdy zmiennej nie ustawiono ani dla połączenia, ani w COMMON.
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_HOST
Adres brokera.
localhost
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_PORT
Port brokera.
5671 przy włączonym TLS, w przeciwnym razie 5672
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_VIRTUAL_HOST
Virtual host RabbitMQ.
/
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_USERNAME
Użytkownik brokera.
guest
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_PASSWORD
Hasło użytkownika brokera.
guest
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_SSL_ENABLED
true włącza szyfrowanie połączenia (TLS).
false
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_SSL_VALIDATE_SERVER_CERTIFICATE
true włącza weryfikację certyfikatu brokera. Opis w sekcji Połączenie szyfrowane (TLS).
false
SCRIPT_QUEUE_<POLACZENIE>_CONSUMER_CLIENT_SSL_VERIFY_HOSTNAME
true włącza sprawdzanie, czy certyfikat brokera został wystawiony dla jego adresu.
false
Mapowanie kolejek
Zamiast <POLACZENIE> wpisz nazwę połączenia. Nie ustawiaj tych zmiennych w COMMON.
SCRIPT_QUEUE_<POLACZENIE>_QUEUE_MAPPING
Mapowanie kolejki na konsumenta w postaci <nazwa-kolejki>=<nazwa-konsumenta>. Kilka par rozdziel przecinkami.
Brak: połączenie bez mapowania nie odbiera wiadomości
SCRIPT_QUEUE_<POLACZENIE>_QUEUE_DLQ_MAPPING
Mapowanie kolejki na kolejkę DLQ w postaci <nazwa-kolejki>=<nazwa-kolejki-dlq>. Kilka par rozdziel przecinkami. Po lewej stronie może stać tylko kolejka, która występuje w QUEUE_MAPPING tego samego połączenia. W przeciwnym razie aplikacja nie wystartuje.
Brak: o losie odrzuconych wiadomości decyduje DLX kolejki
Cache konsumentów
LOWCODE_QUEUE_CONSUMER_FETCH_CACHE_TTL
Jak długo aplikacja przechowuje konsumenta pobranego z repozytorium, na przykład 30s.
1s
LOWCODE_QUEUE_CONSUMER_COMPILE_CACHE_TTL
Jak długo aplikacja przechowuje skompilowany skrypt konsumenta, na przykład 30s.
1s
Zmiana konsumenta zapisana w Eximee Designer zaczyna obowiązywać po upływie tych TTL. Cache możesz też wyczyścić od razu:
Połączenie szyfrowane (TLS)
Do połączenia szyfrowanego z weryfikacją certyfikatu brokera ustaw wszystkie trzy zmienne:
Certyfikat brokera jest wtedy sprawdzany domyślnym truststore Javy w obrazie aplikacji. Certyfikat samopodpisany albo wystawiony przez wewnętrzne CA zostanie odrzucony, jeżeli tego CA nie ma w truststore.
Obsługa błędów: DLX i DLQ
Wiadomość, której konsument nie przetworzył (skrypt zgłosił wyjątek), jest odrzucana i nie wraca na kolejkę. Dalszą drogę takiej wiadomości wyznacza jeden z dwóch wariantów opisanych niżej. Wybierz jeden wariant dla każdej kolejki.
DLQ (Dead Letter Queue) to kolejka, w której odrzucone wiadomości czekają na analizę.
DLX (Dead Letter Exchange) to exchange, do którego broker przekazuje wiadomości odrzucone z kolejki.
Wariant A: DLQ wskazana w konfiguracji Eximee (zalecany)
Administrator RabbitMQ zakłada zwykłą kolejkę DLQ, na przykład eximee_demo_integration.dlq. Administrator Eximee wskazuje ją w zmiennej QUEUE_DLQ_MAPPING:
Aplikacja publikuje nieprzetworzoną wiadomość na tę kolejkę z niezmienioną treścią i nagłówkami. Dodaje trzy nagłówki pomocne w analizie:
x-original-exchange
Exchange, z którego wiadomość trafiła na kolejkę. Pusty przy exchange domyślnym.
x-original-routingKey
Routing key, z którym wiadomość trafiła na kolejkę.
x-exception-class
Rodzaj błędu, na przykład com.consdata.eximee.script.runtime.api.ScriptRuntimeException, gdy skrypt zgłosił wyjątek, albo com.consdata.eximee.lowcode.core.exception.ScriptCodeNotFoundException, gdy nie istnieje konsument o nazwie z mapowania.
Treść błędu nie trafia do wiadomości. Szczegóły błędu znajdziesz w logach aplikacji lowcode-queue-consumer.
Wariant A ma pierwszeństwo: dla kolejki z wpisem w QUEUE_DLQ_MAPPING aplikacja nie korzysta z DLX ustawionego na kolejce.
Wariant B: DLX ustawiony na kolejce przez administratora RabbitMQ
Administrator RabbitMQ ustawia na kolejce argumenty, które wskazują DLX, oraz wiąże z tym exchange'em kolejkę DLQ. Przykład dla kolejki eximee_demo_integration:
W tym wariancie w konfiguracji Eximee nie ustawiasz QUEUE_DLQ_MAPPING. Broker dodaje do odrzuconej wiadomości nagłówek x-death z nazwą kolejki źródłowej i przyczyną rejected.
Wiadomości w DLQ
Wiadomość z DLQ nie jest automatycznie przetwarzana ponownie. Administrator powinien przeanalizować przyczynę błędu i zdecydować o dalszych działaniach, na przykład po poprawieniu skryptu przenieść wiadomość z powrotem na kolejkę źródłową narzędziami RabbitMQ.
Wdrożenie zmian w konfiguracji
Aplikacja czyta konfigurację przy starcie. Po zmianie env.yaml, na przykład po dodaniu nowej kolejki, uruchom aplikację lowcode-queue-consumer ponownie.
Sprawdzenie działania
Po starcie aplikacji
lowcode-queue-consumerznajdź w jej logach wpis dla każdej zmapowanej kolejki:Wartość
deadLetterQueue=dead-letter exchange of the queueoznacza, że dla kolejki nie ustawionoQUEUE_DLQ_MAPPINGi o losie odrzuconych wiadomości decyduje DLX kolejki (wariant B).Sprawdź stan połączeń z brokerem w monitoringu (np. Grafana).
W panelu RabbitMQ Management otwórz kolejkę, rozwiń sekcję Publish message i opublikuj wiadomość testową w uzgodnionym formacie, z identyfikatorem instancji procesu, który czeka na kroku oczekiwania. Format wiadomości projektant procesu uzgadnia z zespołem systemu zewnętrznego.
W logach aplikacji znajdź wpis o odebraniu wiadomości:
a po nim wpisy z
Loggerw skrypcie konsumenta.Sprawdź, czy proces przeszedł dalej i czy kolejka DLQ jest pusta.
Rozwiązywanie problemów
Aplikacja lowcode-queue-consumer nie startuje, w logu Queue <nazwa> does not exist on the broker
Kolejka z QUEUE_MAPPING albo QUEUE_DLQ_MAPPING nie istnieje na brokerze. Log wskazuje kolejkę i zmienną, w której ją wpisano.
Załóż kolejkę na brokerze albo popraw nazwę w mapowaniu.
Aplikacja nie startuje, w logu is not mapped to a script
QUEUE_DLQ_MAPPING zawiera kolejkę, której nie ma w QUEUE_MAPPING tego samego połączenia.
Dodaj kolejkę do QUEUE_MAPPING albo usuń ją z QUEUE_DLQ_MAPPING.
Wiadomości zostają na kolejce, w logu brak Registering queue listener dla tej kolejki
Brak mapowania, literówka w nazwie zmiennej albo znak _ w nazwie połączenia.
Popraw nazwę zmiennej zgodnie z sekcją Nazwa połączenia i uruchom aplikację ponownie.
Aplikacja nie startuje, w logu AmqpConnectException, AmqpAuthenticationException albo AmqpIOException
Aplikacja łączy się z brokerem przy starcie. AmqpConnectException: broker jest niedostępny albo adres lub port są błędne. AmqpAuthenticationException: błędne dane logowania. AmqpIOException z vhost ... not found: virtual host nie istnieje.
Sprawdź zmienne CONSUMER_CLIENT_* i dostępność brokera z aplikacji. Przy porcie 5671 sprawdź, czy ustawiono SSL_ENABLED.
Każda wiadomość trafia do DLQ z x-exception-class = ...ScriptCodeNotFoundException
Nazwa konsumenta w QUEUE_MAPPING różni się od nazwy w Eximee Designer.
Popraw nazwę w mapowaniu.
Wiadomość z błędem znika i nie ma jej w żadnej kolejce
Dla kolejki nie skonfigurowano DLQ ani DLX.
Skonfiguruj DLQ według sekcji Obsługa błędów: DLX i DLQ.
Powiązane strony
Konsumenci RabbitMQ — przygotowanie procesu i pisanie konsumenta.
Lowcode do RabbitMQ — wysyłka wiadomości na kolejkę ze skryptów i zadań skryptowych.
Ostatnia aktualizacja
Czy to było pomocne?
