Docs

Tämä sivu on konekäännös virallisesta dokumentaatiosta, joka löytyy osoitteesta https://vaadin.com/docs. Se saattaa sisältää virheitä, epätarkkuuksia tai virheellisiä väittämiä. Vaadin ei takaa eikä anna mitään vakuutusta käännöksen tarkkuudesta, luotettavuudesta tai ajantasaisuudesta.

Docs

Aloitus Observability Kitin kanssa

Vaiheittainen opas Observability Kitin käyttämiseen sovelluksessa.

Observability tarkoittaa kykyä vastata kysymyksiin sovelluksesta ja sen infrastruktuurista. Vaadin Observability Kit voi auttaa tämän kyvyn toteuttamisessa Flow-pohjaisissa sovelluksissa, jotta tuotantoympäristössä toimivista sovelluksista saadaan jäljitettävää ja toimenpiteisiin johtavaa tietoa.

Jotta pääset alkuun Observability Kitin kanssa, tällä sivulla käsitellään seuraavat aiheet:

  • Observability Kitin lataaminen ja konfigurointi tiedon viemiseksi infrastruktuuriin;

  • Infrastruktuurin määrittäminen observability-tietojen, kuten jälkien ja mittareiden, keräämistä ja tarkastelua varten; sekä

  • Vaadin-sovelluksen ajaminen Observability Kitin kanssa.

Lataa & Konfiguroi

Observability Kit koostuu kahdesta osasta: Starter dependency ja Agent. Ne selitetään näissä alaluvuissa.

Starter Dependency

Starter dependency voidaan lisätä projektiisi lisäämällä seuraava pom.xml-tiedostoon:

Source code
pom.xml
<dependency>
  <groupId>com.vaadin</groupId>
  <artifactId>observability-kit-starter</artifactId>
</dependency>

Agent

Agent perustuu OpenTelemetry-standardiin ja on pakattu .jar-tiedostoksi. Katso lisätietoja Observability Kit Reference -dokumentaatiosivulta.

Important
Lataa Agent JAR -tiedosto
Agentia ei voi käyttää riippuvuutena. Se täytyy ladata erikseen.

Lataa Observability Kit Agent

Kun Agent on ladattu projektihakemistoon, se täytyy konfiguroida viemään telemetriaa yhteen tai useampaan observability-työkaluun. Tässä oppaassa jäljet viedään Jaegerille; mittarit lähetetään Prometheukselle. Tee tämä luomalla agent.properties-tiedosto projektihakemistoon seuraavalla sisällöllä:

Source code
agent.properties
otel.traces.exporter=jaeger
otel.exporter.jaeger.endpoint=http://localhost:14250
otel.metrics.exporter=prometheus
otel.exporter.prometheus.host=0.0.0.0
otel.exporter.prometheus.port=9464

Infrastruktuurin määrittäminen

Tässä oppaassa käytetään Jaegeria jälkien käsittelyyn ja Prometheusta mittareiden käsittelyyn. Molemmat ajetaan paikallisesti ja soveltuvat kehitys- ja testikäyttöön. Muiden toimittajien integrointia varten katso Integrations -sivu.

Jaeger on jäljitysten keräämiseen tarkoitettu työkalu. Lataa se napsauttamalla tätä painiketta:

Download Jaeger

Pura ladatun arkiston (eli tar.gz) sisältö. Tämän jälkeen avaa pääte Jaeger-hakemistoon ja käynnistä Jaeger:

Source code
terminal
./jaeger-all-in-one

Prometheus on mittareiden keräämiseen tarkoitettu työkalu.

Download Prometheus

Pura ladatun arkiston sisältö (eli tar.gz tiedosto). Luo Prometheukselle konfiguraatio scrapperilla, joka lukee mittaritietoja OpenTelemetry exporterilta:

Source code
config.yml
global:
  scrape_interval: 15s # Oletusarvo on joka 1. minuutti.

scrape_configs:
  - job_name: 'opentelemetry'
    # metrics_path oletuksena '/metrics'
    # scheme oletuksena 'http'.
    static_configs:
      - targets: ['localhost:9464']
    # Isäntänimi ja portti tulee vastata
    # OpenTelemetry prometheus exporter -asetusta

Avaa pääte Prometheus-hakemistoon ja käynnistä Prometheus konfiguraatiotiedostolla:

Source code
terminal
./prometheus --config.file=/PATH/TO/config.yml

Muista korvata oikea polku config.yml tiedostolle.

Frontend-paketin asennus (Hilla)

Jotta asennusprosessi saadaan päätökseen, sinun täytyy asentaa ja alustaa kitin client-side-komponentti.

Suorita seuraava komento terminaalissa paketin asentamiseksi:

Source code
terminal
npm install @hilla/observability-kit-client

Seuraavaksi avaa frontend/index.ts-tiedosto ja lisää seuraava koodi:

Source code
TypeScript
import { init } from '@hilla/observability-kit-client';
import { ObservabilityEndpoint } from 'Frontend/generated/endpoints.js'

init(ObservabilityEndpoint.export);

Sovelluksen ajaminen

Nyt olet valmis ajamaan sovelluksesi. Jos sinulla ei kuitenkaan ole sellaista, voit ladata sovelluksen osoitteesta Vaadin Start ja luoda tuotantorakenteen seuraavalla komennolla:

Source code
terminal
./mvnw package

Aja sitten pakattu JAR-tiedosto target-kansiosta:

Suorita sovellus käyttämällä Java-binääriä ja anna tarvittavat argumentit Agentille ja asetuksille seuraavasti:

Source code
terminal
java -javaagent:PATH/TO/observability-kit-agent-VERSION.jar \
     -Dotel.javaagent.configuration-file=PATH/TO/agent.properties \
     -jar myapp.jar
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
Note
Korvaa Paikkamerkkipolut ja Versio
Muista tarkistaa polku agent.properties-tiedostoon sekä Agentin .jar-tiedoston polku ja versio.

Jäljitysten tarkastelu Jaegerissa

Jaegerin käyttöliittymän oletusosoite on http://localhost:16686. Voit valita palvelun nimen — oletuksena vaadin — kentästä Service ja napsauttaa Find Traces -painiketta.

Oletusarvoinen aikaväli hakua varten on viimeisen tunnin sisällä. Voit hakea pidemmälle taaksepäin valitsemalla aikavälin kentästä Lookback.

Oletusarvoinen tulosten määrä on 20. Näet lisää tuloksia suurentamalla arvoa kentässä Limit Results.

Oikealla näkyy nyt kuvaaja, jossa aikajana ja kesto esitetään. Sieltä näet tapahtumat, jotka aiheuttavat viiveitä, esitettyinä suurempina ympyröinä, tai virheet, esitettyinä punaisina ympyröinä. Yhtä ympyrää napsauttamalla avautuu jäljitysdetalisivu.

Lista juurispaneista on myös saatavilla. Jokainen span näyttää keston suhteessa muihin juurispaneihin, sisältämien sisäkkäisten spanien määrän sekä virheiden määrän. Jälleen kerran, kohdetta napsauttamalla avautuu jäljitysdetalisivu.

Jäljityksen yksityiskohdat

Jäljityksen yksityiskohtasivulla näkyy puulistaus, jossa on juurispan ja kaikki sisäkkäiset spanit. Jos jokin spaneista sisältää virheen, se merkitään punaisella huutomerkki (!) -kuvakkeella.

Kullekin spanille voi tarkastella lisätietoja napsauttamalla riviä. Spanin tiedoissa voit laajentaa Tags nähdäksesi spanin attribuutit. Vaadin-spesifiset attribuutit on kuvattu tarkemmin sivulla reference page. Jos virhe on ilmennyt, löydät asiaan liittyvät pinot jäljitykset kohdasta Logs.

Mittarien tarkastelu Prometheuksessa

Prometheus-käyttöliittymän oletusosoite on http://localhost:9090. Syötä mittarin nimi hakukenttään ja napsauta Execute.

Ellet tiedä mittarin nimeä, voit käyttää metrics exploreria napsauttamalla maapallokuvaketta kentän Execute vieressä. Tämä antaa aakkosellisen listan käytettävissä olevista mittareista.

Voit tarkastella tuloksia graafina napsauttamalla Graph -välilehteä.