API-prosessijonon seurannan perusteet

API-prosessijono on vain luettava raportti rajapintajonon operatiiviseen seurantaan. Sen avulla näet, mitä rajapintaprosesseja ja sanomia jonossa on, miksi käsittely voi näyttää jumittuneelta ja mille riveille on tallennettu virhe. Voit tarkastella uusimpia jonorivejä, mutta et voi muuttaa, yrittää uudelleen tai poistaa rivejä raportista.

Avaa API-prosessijonon raportti

API-prosessijonon raportti avataan Raportit-keskuksesta.

1. Avaa Reports reitillä /reports.
2. Hae raportteja -kenttään API-prosessijono tai etsi raportti ryhmästä Operatiivinen toiminta.
3. Valitse raporttikortilta Aja raportti.
4. Valitse avautuvasta paneelista Esikatselu.

Raportilla ei ole omia parametreja, päivämäärärajausta tai rivisuodattimia. Esikatselu näyttää enintään 100 uusinta riviä tunnisteen mukaan laskevassa järjestyksessä. Jos tulos on katkaistu, paneeli näyttää siitä ilmoituksen.

Ymmärrä jonon rooli

API-prosessijonon rooli on erottaa rajapintatyöt omiksi tietokannan api_process_queue-riveikseen. Jonoa voidaan käyttää suurten päivitysmäärien käsittelyyn erillään alkuperäisestä pyynnöstä, jotta kaikkea työtä ei tarvitse tehdä samalla kertaa yhden pyynnön aikarajan sisällä.

Raportti ei kerro jonon käsittelynopeutta, eräkokoa tai seuraavan ajon ajankohtaa. Älä siis lupaa esimerkiksi tiettyä rivimäärää minuutissa. Uusimmat rivit näkyvät ensin, mutta yksittäisen rivin näkyminen ei yksin todista, onko työ odottamassa, parhaillaan käsittelyssä vai jäänyt virheeseen.

Tulkitse raportin sarakkeet

Raportin tekniset sarakeotsikot ovat:

Raportti ei näytä jonoon tallennettua varsinaista sanomadataa. Pelkän rivin perusteella ei myöskään pidä päätellä varmasti, onko sanoma tulossa AI Commerceen vai lähdössä siitä. Tunnista omistava integraatio api-, endpoint-, method- ja jobId-arvojen avulla.

Sisään tuleva sanoma voi syntyä, kun ulkoinen järjestelmä ilmoittaa muutoksesta tai AI Commerce hakee muutoksia. Ulospäin lähtevä sanoma voi puolestaan syntyä AI Commercessa tehdyn toiminnon seurauksena. Raportti ei nimeä suuntaa omassa sarakkeessaan, joten varmista suunta integraation dokumentaatiosta tai tekniseltä omistajalta. Älä tee uusia muutoksia ulkoisessa järjestelmässä vain saadaksesi sanomia näkymään raportissa.

Selvitä jonon virhe

API-prosessijonon virhe selvitetään ensin saman virheen toistuvuuden ja rajapintakontekstin perusteella. Kun jonossa on paljon virheitä, avaa raportti ja tarkista rivimäärä, luontiajat sekä se, liittyvätkö virheet samaan rajapintaan. Tarkista vähintään:

1. Toistuuko sama error usealla uusimmalla rivillä?
2. Ovatko api ja endpoint samoja kaikissa virheriveissä?
3. Liittyvätkö rivit samaan jobId-arvoon vai useisiin eri töihin?
4. Milloin ensimmäinen ja uusin virherivi on luotu?
5. Onko saman rajapinnan joukossa myös rivejä, joilla error on tyhjä?

Tallenna selvitystä varten rivien id, jobId, api, endpoint, method, createdAt ja koko error-arvo. Korjaa virheen varsinainen syy rajapinnan tai sitä omistavan integraation työnkulussa. Älä oleta, että koko jonon poistaminen korjaisi virheellisen sanoman tai yhteysongelman.

Jos sama virhe kertyy monelle riville, rajapinnan käsittely voi olla jumissa tai uusia virheellisiä sanomia voi syntyä jatkuvasti. Raportti ei kuitenkaan yksin todista, että koko rajapinta olisi pysähtynyt. Selvitä ensin, koskeeko ongelma sisään tulevaa vai ulospäin lähtevää työtä, korjaa virhe omistavassa järjestelmässä ja sovi mahdollinen uudelleenyritys vasta sen jälkeen.

Pieni viive sanoman syntymisen ja käsittelyn välillä voi kuulua jonotyöhön, mutta raportti ei määritä hyväksyttävää viivettä. Onnistuneen käsittelyn yhteydessä integraatiokoodi voi poistaa yksittäisiä rivejä, mutta raportti ei lupaa koko jonon automaattista nollausta tietyn ajan kuluttua.

Vie suurempi otos CSV-tiedostoon

API-prosessijonon suurempi otos viedään raporttipaneelin Vienti-toiminnolla. Käytä vientiä, kun tarvitset esikatselua suuremman aineiston tai haluat toimittaa rivit tekniseen selvitykseen. Valmistunut vienti ladataan Lataa CSV -toiminnolla. CSV sisältää samat seitsemän saraketta kuin esikatselu.

Vienti sisältää enintään 5 000 uusinta riviä. Raportissa ei ole päivämäärä-, rajapinta- tai virhesuodatinta, joten rajaa aineisto tarvittaessa CSV:n käsittelytyökalussa. Käsittele tiedostoa operatiivisena lokiaineistona ja jaa se vain selvitykseen osallistuville.

Älä tyhjennä jonoa raportista

API-prosessijonon tyhjennystä ei voi tehdä raportista, sillä siinä ei ole poistotoimintoa. Raportti on tarkoitettu havainnointiin ja vientiin.

Jos virherivit vaativat uudelleenyrityksen, karanteenin tai poiston, toimita tunnisteet integraation tekniselle omistajalle ja käytä vain kyseiselle integraatiolle hyväksyttyä palautusmenettelyä. Koko jonon tyhjentäminen voi poistaa myös käsittelemättömiä, virheettömiä töitä eikä sitä pidä käyttää yleisenä vianratkaisuna.