Publikujesz zredagowaną konfigurację, wspominasz, że VPN nie działa, i dostajesz sześć odpowiedzi o sześciu różnych rzeczach. Problemem jest zwykle prośba, nie czytelnicy. Pomagający nie może z konfiguracji wywnioskować, czy tunel się nie buduje, buduje się, ale gubi ruch, czy działa dobrze, podczas gdy usługa plików za nim odrzuca połączenie. Opisz zamiast tego jeden przepływ, z trzema właścicielami i jedną zaobserwowaną awarią, a odpowiedzi natychmiast się poprawią.

Dlaczego prośba dostaje nieprzydatne odpowiedzi

Konfiguracja opisuje, co jest ustawione. Nie opisuje, czego próbowałeś, co się stało ani która z kilku maszyn ma wykonywać jaką pracę. Bez tego każdy czytelnik zgaduje inny etap.

Przykładem jest podróżujący laptop, który powinien dotrzeć do usługi plików na serwerze domowym przez bramę domową. Wskaż, czy brama, serwer VPN i serwer plików to ta sama maszyna, czy trzy maszyny, bo ten jeden fakt zmienia prawie każdą odpowiedź.

Wypełnij ten rekord przed publikacją


Goal: the one resource or operation that should work
Path: client -> access network -> VPN endpoint -> resource
Owners: who controls the client, the gateway and the resource
Software: product, version and protocol in use
Expected: what success would look like
Observed: exact non-secret error or response
Time and change: when it started and what changed
Control: one comparable operation that still works


Osiem linii, i większość próśb staje się odpowiadalna. Linia kontrolna to ta, którą ludzie pomijają: jeśli przeglądanie z tego samego laptopa działa, a udostępnianie plików nie, zawęża to problem do tras tunelu albo do usługi, i nikt nie musi pytać.

Zachowaj spójne etykiety podczas redagowania. Zachowaj różnicę między publicznym punktem końcowym, adresem tunelu i podsiecią domową. Jeśli dwa zakresy się nakładają, pozostaw tę relację widoczną, zamiast zastępować każdą sieć tym samym symbolem zastępczym, bo nakładanie się jest często odpowiedzią.

Nazwij etap, który zawodzi, a nie cały log

Warto rozdzielić pięć etapów: rozwiązywanie nazw, próba połączenia, uwierzytelnianie, zestawienie tunelu i dostęp do zasobu. Powiedz, który według ciebie zawiódł i co tam zobaczyłeś.

Wklej mały fragment wokół zdarzenia zamiast każdego pliku debugowania, jaki klient potrafi utworzyć. Sto linii szumu uścisku dłoni ukrywa tę jedną linię, która mówi, że nazwa certyfikatu się nie zgadzała.

Trzymaj obserwację i wyjaśnienie osobno. „Klient zgłasza przekroczenie czasu uścisku dłoni po 30 sekundach” to obserwacja; „uważam, że dostawca blokuje UDP” to teoria. Oba są przydatne, a ich mieszanie sprawia, że pomagający nie wie, któremu wierzyć. Oznacz je, a otrzymana odpowiedź zajmie się właściwą.

Wyślij ją do właściciela, który może działać

W przypadku laptopa zarządzanego przez pracodawcę zacznij od wspieranego kanału pracodawcy, bo forum społeczności nie może zmienić jego polityki. W przypadku komercyjnej usługi VPN podaj produkt i konto prywatnie, a nie publicznie. W przypadku własnej bramy podaj role routera i serwera, które kontrolujesz.

Jeśli korzystasz z publicznej społeczności, wybierz taką, której obecny zakres pasuje do zadania. Stary wątek o zasadach forum nie jest umową wsparcia, a pięcioletnia odpowiedź o wersji protokołu, której nie uruchamiasz, też nie.

Zasłoń sekrety bez spłaszczania topologii

Usuń klucze prywatne, hasła, tokeny i linki zawierające poświadczenia, zanim cokolwiek opuści twoją maszynę. Eksport diagnostyczny i pełna konfiguracja to różne artefakty, nawet gdy nazwy plików wyglądają podobnie, a wklejony fragment może zawierać klucz współdzielony z góry.

Potem zachowaj relacje, które czynią przepływ zrozumiałym. RFC 6973 traktuje niepotrzebne zbieranie i korelację jako kwestie prywatności, i ta sama zasada działa tutaj: udostępniaj dowody, których potrzebuje odbiorca, a nie całą maszynę.

Zakończ jednym pytaniem o zaobserwowaną niezgodność, na które można odpowiedzieć, na przykład dlaczego klient kończy uwierzytelnianie i potem nigdy nie otrzymuje trasy. Konkretne pytanie dostaje konkretną odpowiedź, a zbudowany przez ciebie rekord jest tym, co pozwala komuś jej udzielić bez pytania o twoje sekrety.

Powiązane artykuły