Tärkeä

We are currently a small number of developers active on the project. As such, we cannot answer and tag all of the opened issues immediately, but we do notice and read them. Good bug reports provide us important feedback, which we thank you for and always appreciate.

Käsittelijä

Tässä oppaassa on ohjeet sammakohtaista virheiden ja ongelmien raportointia varten Jami:ssä.

Aseta ympäristösi

  • Varmista, että tiedot menettävät, varmista tiliesi varmuuskopiointi ja yhdistä tili mahdollisimman monen laitteen kanssa.

  • Jos on olemassa jo uusi versio, on todennäköistä, että se on korjattu uusemmilla versioilla.

Miten raportoida hyönteinen

  1. Luo tili [Jami GitLab]https://git.jami.net/users/sign_up) jos sinulla ei ole jo.

  2. Valitse oikea projekti julkaistaaksesi numerosi:

    • Se on Android-klienti.

    • Qt-asiakas

    • (GITLAB-projektti)

    • (tähdentää )

    • [Jos tiedät mitä teet, voit valita yhden muista hankkeista]

  3. Jos sinulla on useita ongelmia, toimita erilliset virta-ilmoitukset.

  4. Otsikko on virheen selkeä yhteenveto (esim. otsikonpiste on liian iso ikonin koon vuoksi)

  5. Kertokaa virheen palauttamista varten tehtävät:

    • Jos sinulla on täsmällisiä askeleita sen toistamiseen (hyvä!) olet matkalla luomaan hyödyllisen virkapäivityksen.

    • Jos voit toistaa toistuvasti, mutta et sitten, kun olet noudattanut tiettyjä askeleita, anna lisätietoja aiheesta, jotta muut ymmärtävät ja yrittävät toistaa sitä.

    • If you can not reproduce the problem, there may be little chance of it being reasonably fixable. If you do report it, please try your best to provide as much information/clues about its occurrence as possible.

  6. Tarkista, onko ohjelmisto ajan tasalla.

  7. Yritä erottaa ympäristöstä ja lisääntyä (eli testaus useilla laitteilla).

  8. Kuvaile ympäristösi määrittelemällä seuraavat:

    • Käyttöjärjestelmäversio

    • tarkka laitteen malli (vaikuttava mobiililaitteille)

    • jos käytät beta-versioita

    • what build you are using (F-Droid, Play Store, App Store, from dl.jami.net, your own build, etc.). If you have built your own version of Jami, please specify the exact Jami Daemon version and client version (you can obtain it using jamid -v and jami -v; but note that our packages are updated quite often) and the Git commit.

    • network conditions:

      • are both devices on the same local network?

      • Different networks?

      • Is one or both behind NAT?

      • Are you using LTE?

      • Are you using WiFi?

    • other elements if needed:

      • SIP provider,

      • hardware,

      • etc.

Kirjoittaminen selkeää yhteenvetoa

Miten kuvailisit virheen noin 10 sanalla? Tämä on ensimmäinen osa virheen raporttia, jonka kehittäjä näkee.

Hyvä yhteenveto tulee tunnistaa virheen raportin nopeasti ja ainutlaatuisesti.

Good: "Cancelling a file transfer crashes Jami"
Bad: "Software crashes"

Good: "All calls hang up after 32 seconds"
Bad: "Not able to call my friends"

Kirjoittaminen tarkkaista reprodukttiohjeita

  • Miten kehittäjä voi tuottaa virheen omalle laitteelleen?

    Jos kehittäjä pystyy toistamaan virheen, virheen korjaaminen on todennäköistä. Jos vaiheet ovat epäselviä, ei ehkä edes ole mahdollista tietää, onko virhe korjattu. Tiedämme täysin, että jotkut virheet voivat näyttää ilmeisiltä sinulle, mutta ne liittyvät todennäköisesti ympäristöön. Mitä tarkempia olet, sitä nopeammin virhe voidaan korjata.

  • Mitä pitäisi sisällyttää virta-ilmoitukseen?

    Kirjoita, voisitkoko toistaa virheen halutesi mukaan, silloin tällöin vai ei ollenkaan. Kuvaile tapaasi toimia Jamiin kanssa jokaisen askeleen tarkoituksen lisäksi.

Good

Voin aina lisääntyä seuraavan askeleen avulla:

1. Start Jami by clicking on the desktop icon
2. Start a new conversation with anyone
3. Click the file transfer icon

Expected results: A window opens and asks me to choose a file to send.
Actual results: When I click the file transfer icon, nothing happens.

Bad

Try to transfer a file.
It doesn't work.

Saatu tulos

Lisää seuraavat tiedot:

  • Jami daemon (jamid tai libjami tai libring) ja asiakas debug logit.

  • The core dump if one was produced.

Odotettu tulos

Se on kuvaus odotetusta tai haluttuasta käyttäytymisestä.

Lisätietojen antaminen

Useimpien virkapäiväilmoitusten osalta pyydetään seuraavat tiedot. Voit säästää aikaa antamalla nämä tiedot odotettujen tulosten alapuolella.

Pöytäkirjat

Qt-pohjainen Jami-klienti (GNU/Linux, Windows, macOS)

Go to the General settings. In the Troubleshoot section, you can click on ”Open logs”, where you will be able to get statistics (”Show stats”) or start recording information via ”Receive logs”. Then you can just copy the result and explain your scenario.

GNU/Linux:ssa

Klassikko-ilmoitukset (erikoisesti vain >= varoitusilmoitukset kirjautuvat):

journalctl --since "24h ago" | grep jami

Täyspäiväkirja: Koska Jami-asiakas (GUI) ja daemon ovat erillisiä prosesseja, helpoin tapa saada päiväkirjat molemmista on käynnistää ne yksi kerrallaan, manuaalisesti.

  1. Varmista, ettei Jami-asiakas tai demoni-tapahtuma ole käynnissä: tarkista käyttämällä ps aux ‧ grap jami terminaalissa.

    • Jami saattaa yhä toimia, vaikka ikkunat eivät ole auki.

    • Jos joko asiakas tai demoni on käynnissä, lopeta ne käyttämällä kill PID.

  2. Yksi terminaali alkaa daemon kanssa jamid -d -c

    • Tämä suoritettavissa oleva ei yleensä ole PATH, ja Debian/Trisquel/Ubuntu-paketteissa se sijaitsee /usr/lib/x86_64-linux-gnu/jamid -d -c tai /usr/libexec/jamid -d -c.

  3. In another terminal, start the client, using jami -d.

Jotta löydät jäljet, voit käyttää ohjelmaa GDB:ssä:

gdb -ex run --args jami -d, or gdb -ex run --args /usr/libexec/jamid -cd, depending on the component you need to debug.

Kun se hajoaa, voit kirjoittaa bt (tai vielä parempi, thread soveltaa kaikki bt) ja painaa Enter.

MacOS: ssa

  • Käytä /Applications/Jami.app/Contents/MacOS/.

  • Jos klikkaa kaksi kertaa Jamiä, se käynnistää Jamiä ja tulostaa login terminaaliin.

  • Kopioida päiväkirja terminaalista tiedostoon.

Vaihtoehtoisesti voit käyttää /<tie Jami>/Jami.app/Contents/MacOS/Jami -d terminaalista.

Android-käyttö

Jos haluat kerätä tiedot puhelimestasi Jami:

  • Tap `Suhde

  • Napsauta kolme pisteen menuu yläkerrassa oikealla

  • Käänny asetukset

  • Napsauta Tiagnostic logs

Kerääminen tietokannalla Android Debug Bridge (adb) -ohjelman avulla:

  • Sinun täytyy saada ADB tietokoneellesi.

  • Laita Jami älypuhelimellasi ja teloita

  • Se on vain yksi asia, joka on tärkeä.

  • Sinulla on nyt tiedosto, jossa on asiakkaan kirjaus.

Windows-laitteiden käyttö

Avaa terminaali (cmd.exe) ja käynnistä Jami.exe seuraavilla vaihtoehdoilla:

  • -d avata erillinen kontolin ikkuna vastaanottamaan logit

  • -f kirjoittaa logit %localappdata%\jami\jami.log