Autonomy dokumentatsioon
Integratsioonid

Datadog

Saada Autonomy käivituste trace'id Datadog APM-i, uuri ebaõnnestunud samme ja seosta need oma rakenduse trace'idega.

Ühenda Autonomy Datadogiga selle OTLP/HTTP trace'ide vastuvõtu kaudu. Iga käivitus loob autonomy.run span'i, pesastatud autonomy.step span'id ja autonomy.action.* alamspan'id. Integratsioon on runner-labsiga tehtud käivitustele juba saadaval jaotises Settings → Observability.

Enne alustamist

Vajalik ligipääs

  • Autonomy tööruumi administraatori konto ja testjuhtum, mis käivitatakse runner-labsis.
  • Datadogi organisatsioon, millel on lubatud APM-i andmete vastuvõtt, ja ligipääs selle Trace Explorerile.
  • Selle organisatsiooni Datadogi API võti jaotisest Organization Settings → API Keys.
  • Sinu Datadogi sait, mille tuvastad sisselogimiseks kasutatava domeeni järgi.

Vastuvõtu mandaat on Datadogi API võti. Rakenduse võtmed ja Autonomy aut_ võtmed ei autendi Datadogi päringuid. Hoia seda väljal Headers, kus Autonomy salvestab selle krüpteeritult ega tagasta seda kunagi töölauale.

Vali oma Datadogi endpoint

Sisesta oma Datadogi saidi baas-URL väljale OTLP Endpoint. Autonomy lisab /v1/traces ja saadab JSON-i HTTPS-i kaudu. Datadog toetab seda http/json kodeeringut.

Datadogi saitSisselogimise domeenOTLP Endpoint
US1app.datadoghq.comhttps://otlp.datadoghq.com
US3us3.datadoghq.comhttps://otlp.us3.datadoghq.com
US5us5.datadoghq.comhttps://otlp.us5.datadoghq.com
EUapp.datadoghq.euhttps://otlp.datadoghq.eu
AP1ap1.datadoghq.comhttps://otlp.ap1.datadoghq.com
AP2ap2.datadoghq.comhttps://otlp.ap2.datadoghq.com
UK1uk1.datadoghq.comhttps://otlp.uk1.datadoghq.com
US1-FEDapp.ddog-gov.comhttps://otlp.ddog-gov.com
US2-FEDus2.ddog-gov.comhttps://otlp.us2.ddog-gov.com

Need URL-id vastavad Datadogi praegusele OTLP trace'ide vastuvõtu saidivalijale. Ühe saidi võti ei autendi teise saidi vastuvõtu päringuid.

Ühenda ja kontrolli

  1. Ava Autonomys Settings → Observability ja vali Datadog.

  2. Kleebi oma saidi baas-URL väljale OTLP Endpoint. Sisesta see ise ka siis, kui kohatäitetekst näitab õiget aadressi.

  3. Sisesta väljale Headers järgmine väärtus, asendades YOUR_DATADOG_API_KEY oma API võtmega:

    dd-api-key=YOUR_DATADOG_API_KEY
  4. Vajuta Send Test Span. Edukas HTTP vastus kinnitab, et vastuvõtt võttis päringu vastu; see ei tõesta veel, et span on otsitav.

  5. Ava Datadogis APM → Trace Explorer, vali hiljutine ajavahemik ja otsi service:autonomy-runner-labs. Leia span autonomy.test_connection.

  6. Lülita sisse Trace Export ja vajuta Save Configuration. Alusta uut testjuhtumi käivitust, et selle runner saaks salvestatud seadistuse.

  7. Pärast käivituse lõppu otsi selle ID-d alloleva päringuga. Asenda RUN_ID Autonomy käivituse URL-is oleva ID-ga. Ava trace ja kontrolli, et käivituse ning sammude span'id jõudsid kohale.

service:autonomy-runner-labs @test.run_id:"RUN_ID"

Datadogi APM-i trace'ide mõõdikute jaoks võid lisada väljale Headers ,compute_stats=true. Otsene vastuvõtt neid mõõdikuid vaikimisi ei arvuta. Muutmise või võtme roteerimise korral salvesta päise kogu väärtus koos dd-api-key osaga.

Uuri ebaõnnestunud sammu APM-is

Käivita testkeskkonnas testjuhtum, mille üks kontroll teadaolevalt ebaõnnestub. Määra Trace Exploreri ajavahemik sellele käivitusele ja otsi:

service:autonomy-runner-labs status:error @test.status:failed @test.step_index:*

Ebaõnnestunud autonomy.step kannab OTLP veastaatust (code: 2). Uuri atribuute test.step_action, test.step_target, autonomy.recovery_count ja olemasolu korral autonomy.diagnosis.category. Ava trace'i ajajoon, et näha tegevuste kestusi. Need on APM-i span'id, mitte eraldi Datadogi testihalduse integratsioon.

Käivituse ja sammu span'id sisaldavad autonomy.run_url; ava see URL, et naasta käivituse tõendite juurde Autonomys. Tegevuste span'id sisaldavad autonomy.action.success ja pärivad oma koha trace'is, kuid ei sisalda ise käivituse URL-i. Testjuhtumite nimed (test.plan_name) on käivituse span'il. See integratsioon ei ekspordi mudelite üksikasju, prompte, ekraanipilte ega töötlemata veateateid.

Datadog võib vastendada span'ide nimed oma operatsiooni- ja ressursiväljadega. Kindlaks filtreerimiseks kasuta eksporditud atribuute; Datadogi trace'ide otsingusüntaks selgitab atribuudipäringuid.

Liigu rakenduse trace'i juurde

Autonomy loob igale käivitusele eraldi trace'i ID. See ei süsti seda ID-d ega traceparent päist sinu veebi- või mobiilirakendusse. Autonomy trace ja rakenduse päringu trace on seetõttu eraldi ning käivituse ID otsimine ei leia automaatselt tootmiskeskkonna päringuid.

  1. Instrumenteeri rakendus ja selle taustateenused nii, et need saadaksid oma trace'id Datadogi. Need peavad salvestama vastava teenuse, keskkonna ja päringu ressursi; päringu või tellimuse identifikaatorid aitavad vastet täpsustada.

  2. Märgi üles ebaõnnestunud Autonomy sammu ajavahemik ja sihtmärk. Kasuta autonomy.run_url linki, et otsida käivituse tõenditest rakenduse päringu ID-d või muud identifikaatorit, kui rakendus seda kuvab.

  3. Ava teine Trace Exploreri vahekaart sama ajavahemikuga. Otsi rakenduse teenust ja keskkonda, seejärel täpsusta tegeliku ressursi või päringu identifikaatoriga. Näiteks kohanda need väärtused oma rakenduse siltidele:

    service:checkout-api env:production resource_name:"POST /orders"
  4. Ava võimalik päringu trace ning kontrolli enne vea omistamist, et selle identifikaatorid ja ajastus sobivad. Kui käivitus oli suunatud eelvaatele, kasuta selle eelvaate keskkonda; sarnasel ajal toimunud tootmiskeskkonna trace üksi ei tõesta vastet.

See on käsitsi seostamine. Ilma rakenduse instrumenteerimise või päringut eristavate tõenditeta ei saa integratsioon tuvastada üht kindlat tootmiskeskkonna trace'i.

Veaotsing

  • HTTP 401 või 403: kontrolli Datadogi saiti ja API võtit. Kasuta dd-api-key päist, mitte rakenduse või Autonomy võtit.
  • HTTP 404: kopeeri tabelist baas-URL. Tekkinud päringu rada peab olema /v1/traces.
  • Testspan saabub, käivituse span'id mitte: kontrolli, et Trace Export on sisse lülitatud ja salvestatud, käivitus algas pärast seda ning toimus runner-labsis. Ise majutatud runner'id saavad teenuse nime muuta muutuja OTEL_SERVICE_NAME abil.
  • Span'id kaovad otsingutest: kontrolli valitud ajavahemikku ja Datadogi trace'ide säilitusseadeid. Vastuvõetud eksport ei taga, et iga span indekseeritakse hilisemate otsingute jaoks.
  • Käivitus õnnestub Datadogi katkestuse ajal: trace'ide eksport püüab need kohale toimetada, kuid ei muuda käivituse tulemust. CI jätkamise otsustamiseks kasuta Autonomy käivituse tulemust.

Ise majutatud runner'ite keskkonnamuutujate ja mandaatide eemaldamise kohta vaata Vaadeldavus (OTLP).

On this page