Autogenerowana dokumentacja do aplikacji mikroserwisowej

Autogenerowana dokumentacja do aplikacji mikroserwisowej
marian pazdzioch
  • Rejestracja:ponad 6 lat
  • Ostatnio:3 dni
  • Postów:707
0

Autogenerowana dokumentacja do aplikacji mikroserwisowej - spotkał się ktoś?

Marzy mi się programik/skrypt który przejdzie się po repo i mi wygeneruje obrazek/graf wszystkich kilkudziesięciu mikroserwisów które mam w mojej korporacyjnej apce. Wraz ze wszystkimi połączeniami do zewnętrznych systemów, baz danych, remisów, rabbitów, kafek, SOA etc.

Zacząłem to robić ręcznie ale wiadomo, że zajmie mi to pewnie z miesiąc. A po miesiącu od razu będzie pewnie nieaktualny, stąd pytam o autogenerowanie.

Ktoś się spotkal z takim pomysłem albo nie daj boże z realizacją?

edytowany 1x, ostatnio: marian pazdzioch
KE
  • Rejestracja:około 6 lat
  • Ostatnio:około 4 godziny
  • Postów:658
0

Nie spotkałem się z czymś, co statycznie analizuje kod, ale narzędzia typu AppDynamics fajnie rysują (z tym że na żywo) połączenia między serwisami. Wiadomo, rysuje tylko to, co aktualnie się dzieje w systemie.

marian pazdzioch
Popatrzyłem co to jest ten appdynamics i w sumie to mamy podpięte coś podobnego a mianowicie Dynatrace
somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:dzień
  • Lokalizacja:Wrocław
2
marian pazdzioch napisał(a):

Zacząłem to robić ręcznie ale wiadomo, że zajmie mi to pewnie z miesiąc. A po miesiącu od razu będzie pewnie nieaktualny, stąd pytam o autogenerowanie.

Czemu miałby być nieaktualny?
Wrzucacie najpierw serwis, a potem się zastanawiacie, do czego ma służyć?


Po dopracowaniu rozwiązania każdy będzie mógł założyć własny drzewiasty wątek.
Zobacz pozostałe 2 komentarze
marian pazdzioch
Pracownicy zmieniają rzeczy ale w pompie mają dokumentację. I nie znam przykładu gdzie tak to się nie kończy w ciągu tygodnia, miesiąca albo w ciągu roku. Kiedyś ktoś przestaje dbać i dokumentację.
Miang
ale same założenia do zmiany powinny być dokumentacją, współpraca między mikroserwisami powinna być opisana przez kogoś kto ją projektował, chyba ze januszex i niejebywalny kierownik/wdrożeniowiec
marian pazdzioch
W januszexie pardoxalnie spodziewał bym się dokumentacji. Tu mowa o dużym banku.
Miang
dużym januszbanku. właśnie tam są takie leśne dziadki na stanowiskach średniego menażera
marian pazdzioch
Prawda, tu na około same leśne dziady, staram się jakoś ich omijać żeby nie przesiąknąć zapachem moczu.
piotrpo
  • Rejestracja:ponad 7 lat
  • Ostatnio:około godziny
  • Postów:3277
0

Nie wyobrażam sobie automatu, który wygeneruje połączenia pomiędzy mikroserwisami.
Do robienia z ręki polecam https://structurizr.com/

Riddle
Administrator
  • Rejestracja:ponad 14 lat
  • Ostatnio:36 minut
  • Lokalizacja:Laska, z Polski
  • Postów:10032
1

Kwestionowałbym zasadność takiego rozwiązania 😕

Rozumiem że taka dokumentacja miałby pełnić rolę informacyjną - żeby czytając ją, byłbyś w stanie stwierdzić jakie są relacje pomiędzy usługami. Ta dokumentacja miałaby być generowana rozumiem na podstawie czegoś - jakiegoś kodu zapewne. Pytanie za milion punktów - czemu ten kod nie mógłby być napisany w taki sposób żeby był na tyle czytelny że dałoby się go rozczytać i z niego wywnioskować relacji usług? 🤔

KE
  • Rejestracja:około 6 lat
  • Ostatnio:około 4 godziny
  • Postów:658
0

To ja bym jeszcze odbił piłeczkę:

Zacząłem to robić ręcznie

Czyli jak? Bo może to, co robisz ręcznie, da się zautomatyzować. Szukasz wszystkich odwołań do klienta HTTP czy publishera Kafki? Albo może masz to owrapowane w jakiś osobny komponent, który da się znaleźć statycznie?

Dodam tylko jeszcze, że nawet jeśli uda ci się stworzyć statycznie takie coś, to jest jeden poważny problem - skąd wiesz, czy dane połączenie jest używane? :) Dlatego jestem raczej za observability na prodzie, tracingi powiedzą ci, gdzie faktycznie są połączenia.

edytowany 1x, ostatnio: kelog
PA
  • Rejestracja:ponad rok
  • Ostatnio:dzień
  • Postów:31
0

Na podstawie analizy kodu to raczej trudno będzie. Może w oparciu o magię użytego frameworka, ale teoretycznie każdy mikroserwis to może być inny stack.
Spotkałem się natomiast z generowaniem na podstawie serwisów zdefiniowanych w Dockerze: https://github.com/pmsipilot/docker-compose-viz#image-renderer

SM
  • Rejestracja:ponad 3 lata
  • Ostatnio:około 12 godzin
  • Postów:277
0

Takie obrazki to sztuka dla sztuki żeby zaprezentować infre do biznesu a nie dla devów. Ja osobiście wole wyczytać wszystko z jakichś helmchartów, dockerfilów czy jakie tam akurat configi są akurat w projekcie. Takie obrazki raczej nie pomagają w pracy.

marian pazdzioch
No właśnie nie jesteś targetem. Targetem jest właśnie a) biznes b) całe otoczenie tego projektu które nie będzie czytać kodu bo nie ma dostępu bądź nie umie tego Frameworka c) nowe mięso - takie rzeczy robi się dla onboardingu.
piotrpo
  • Rejestracja:ponad 7 lat
  • Ostatnio:około godziny
  • Postów:3277
3

Płyniecie z tym dogmatycznym podejściem "dokumentacja jest zła, bo trzeba ją utrzymywać". Kiedyś mieliśmy poplątany kod, teraz mamy mikroserwisy, czyli kod sam w sobie jest c.a. ok, bo ciężko zrobić duży burdel w małym, izolowanym kawałku. Tylko złożoność, która powodowała to poplątanie kodu nie zniknęła, zwyczajnie przeniosła się wyżej.
Klient składa w banku wniosek o kredyt, kiedyś leciało to przez kilkanaście niby-modułów w "modularnym monolicie", a teraz leci przez kilkanaście mikroswerwisów. Co z tego, że są one proste, skoro sam proces się nie zmienił. Dokumentacja jest nawet bardziej potrzebna, bo przez kod można było się przy sporej dozie cierpliwości przeklikać, a przez poplątane mikroserwisy jest już dużo trudniej.

marian pazdzioch
  • Rejestracja:ponad 6 lat
  • Ostatnio:3 dni
  • Postów:707
0

@kelog

Dlatego jestem raczej za observability na prodzie, tracingi powiedzą ci, gdzie faktycznie są połączenia

No i to jest jeden ze sposobów do których doszedłem. Być może nawet łatwiej jest zdjąć odcisk z tracingu i wygenerować graf kto z kim.

Jedyne czego tam nie będzie widać to rury które istnieją ale nie są używane. I powinny zostać zdemontowane.

KE
Z tym też da się poradzić częściowo, nie wiem w jakiej technologii masz system, ale powinno dać się w takim Springu wymusić tworzenie metryk na wszystkie kolejki, albo na wszystkie endpointy HTTP. I patrzysz po miesiącu gdzie np. masz 0 wiadomości, te punkty musisz przeanalizować. Pytanie czy taka robota się opłaca - oczyścisz kod, ale w sumie zysk niewielki.
piotrpo
  • Rejestracja:ponad 7 lat
  • Ostatnio:około godziny
  • Postów:3277
1

Wrzuć jakieś Istio, czy podobne zarządzanie ruchem, zdefiniuj explicit dozwolone połączenia, sprawdź co nie działa. Jak już wszystko zacznie działać masz definicję wszystkich połączeń, które są faktycznie potrzebne, a wszystkie nadmiarowe powycinane.

KE
+1, bolesne ale na pewno zadziała. Plus wiadomo dla messagingu jakieś uprawnienia na kolejki etc.
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)