Glosariusz

Ten glosariusz definiuje terminologię i pojęcia specyficzne dla projektu OpenTelemetry oraz wyjaśnia, jak używać terminów z dziedziny obserwowalności w kontekście OpenTelemetry.

Dokumentujemy również pisownię, także dotyczącą wielkości liter, gdy jest to pomocne. Przykłady: OpenTelemetry i OTel.

Terminy

Agregacja

Proces łączenia wielu pomiarów w dokładne lub szacunkowe statystyki dotyczące pomiarów wykonanych w określonym przedziale czasowym podczas działania programu. Stosowana przez źródło danych typu metryka.

API

Application Programming Interface. W projekcie OpenTelemetry używane do definiowania sposobu generowania danych telemetrycznych dla każdego źródła danych.

Aplikacja

Jedna lub więcej usług zaprojektowanych dla użytkowników końcowych lub dla innych aplikacji.

APM

Monitorowanie Wydajności Aplikacji (ang. Application Performance Monitoring) obejmuje monitorowanie aplikacji, ich wydajności (szybkości, niezawodności, dostępności itp.) w celu wykrywania problemów, ostrzeganie o nich oraz narzędzia do znajdowania pierwotnych przyczyn problemów

Atrybut

Termin OpenTelemetry oznaczający metadane. Dodaje pary klucz-wartość do encji wytwarzającej telemetrię. Stosowany we wszystkich sygnałach i zasobach. Zobacz specyfikację atrybutów.

Automatyczna instrumentacja

Odnosi się do metod zbierania telemetrii, które nie wymagają od użytkownika końcowego modyfikacji kodu źródłowego aplikacji. Metody różnią się w zależności od języka programowania; przykłady obejmują wstrzykiwanie kodu bajtowego lub dynamiczną modyfikację kodu wykonywanego, tzw. “monkey patching”.

Bagaż

Mechanizm propagacji metadanych ułatwiający ustalenie związku przyczynowego między zdarzeniami i usługami. Zobacz specyfikację bagażu.

Liczebność

Liczba unikalnych wartości dla danego atrybutu lub zestawu atrybutów. Wysoka liczebność oznacza wiele unikalnych wartości, co może wpływać na wydajność i wymagania magazynowe backendów telemetrii oraz na pamięć używaną przez SDK metryk. Na przykład atrybut user_id miałby wysoką liczebność, natomiast atrybut status_code z wartościami takimi jak “200”, “404”, “500” miałby niską liczebność.

Limit liczebności

Konfigurowalny limit liczby unikalnych kombinacji atrybutów śledzonych przez SDK metryk. Ogranicza zużycie pamięci i obowiązuje dla każdego strumienia metryki osobno. Po osiągnięciu limitu kolejne kombinacje są agregowane w jeden punkt danych sygnalizujący przepełnienie i oznaczony atrybutem otel.metric.overflow=true. Zobacz Limity liczebności.

Biblioteka kliencka

Zobacz bibliotekę instrumentowaną.

Aplikacja po stronie klienta

Komponent aplikacji, który nie działa wewnątrz prywatnej infrastruktury i jest zazwyczaj używany bezpośrednio przez użytkowników końcowych. Przykłady: aplikacje przeglądarkowe, aplikacje mobilne oraz aplikacje działające na urządzeniach IoT.

Kolektor

OpenTelemetry Collector (w skrócie: Kolektor) to implementacja niezależna od dostawcy, która odbiera, przetwarza i eksportuje dane telemetryczne. Pojedynczy plik binarny, który można wdrożyć jako agenta lub bramę.

Pisownia: Odnosząc się do OpenTelemetry Collector, zawsze pisz Kolektor z wielkiej litery. Użycie samego “Kolektor” również jest dopuszczalne — np. “konfiguracja Kolektora”.

Contrib

Biblioteki instrumentacji oraz Kolektor oferują zestaw podstawowych funkcji, a także dedykowane repozytorium contrib z funkcjami dodatkowymi, w tym Eksportery różnych dostawców.

Propagacja kontekstu

Umożliwia wszystkim źródłom danych współdzielenie mechanizmu kontekstu do przechowywania stanu i dostępu do danych w całym cyklu życia transakcji. Zobacz specyfikację propagacji kontekstu.

DAG

Skierowany graf acykliczny (ang. Directed Acyclic Graph).

Źródło danych

Zobacz Sygnał.

Wymiar

Termin używany wyłącznie w kontekście metryk. Zobacz Atrybut.

Trasowanie rozproszone

Trasowanie rozproszone śledzi przebieg pojedynczego żądania, zwanego trasą, w miarę jak jest obsługiwane przez usługi składające się na aplikację. Przekracza granice procesów, sieci i zabezpieczeń.

Zobacz Trasowanie rozproszone.

Dystrybucja

Dystrybucja to dostosowana wersja repozytorium nadrzędnego OpenTelemetry. Zobacz Dystrybucje.

Encja

Zbiór atrybutów identyfikujących i opisujących obiekt fizyczny lub logiczny. Encje są zazwyczaj powiązane z telemetrią. Na przykład encja CPU opisuje fizyczny procesor, podczas gdy encja usługi opisuje logiczną grupę procesów składających się na usługę HTTP lub inną.

Zdarzenie

Zdarzenie to rekord logu z nazwą zdarzenia i dobrze znaną strukturą. Na przykład zdarzenia przeglądarki w OpenTelemetry stosują określoną konwencję nazewnictwa i są nośnikiem zestawu danych w określonej strukturze.

Eksporter

Zapewnia funkcjonalność wysyłania telemetrii do odbiorców. Eksportery mogą działać w trybie wysyłania (push) lub udostępniania (pull).

Pole

Termin używany specyficznie przez rekordy logów. Metadane można dodać przez zdefiniowane pola, w tym atrybuty i zasób. Inne pola również mogą być traktowane jako metadane, w tym stopień ważności i informacje o trasie. Zobacz specyfikację pól.

gRPC

Wydajny, otwartoźródłowy uniwersalny framework RPC. Zobacz gRPC.

HTTP

Skrót od Hypertext Transfer Protocol.

Biblioteka instrumentowana

Oznacza bibliotekę, dla której zbierane są sygnały telemetryczne (trasy, metryki, logi). Zobacz bibliotekę instrumentowaną.

Biblioteka instrumentacji

Oznacza bibliotekę, która dostarcza instrumentację dla danej biblioteki instrumentowanej. Biblioteka instrumentowana i biblioteka instrumentacji mogą być tą samą biblioteką, jeśli ma wbudowaną instrumentację OpenTelemetry. Zobacz specyfikację biblioteki.

JSON

Skrót od JavaScript Object Notation.

Etykieta

Termin używany wyłącznie w kontekście metryk. Zobacz Metadane.

Język

Język programowania.

Biblioteka

Specyficzna dla języka kolekcja zachowań wywoływanych przez interfejs.

Log

Czasami używany w odniesieniu do zbioru rekordów logów. Może być niejednoznaczny, ponieważ ludzie czasami używają Log także w odniesieniu do pojedynczego rekordu logu. Gdy możliwa jest niejednoznaczność, użyj dodatkowych określeń, na przykład rekord logu. Zobacz Log.

Rekord logu

Zapis danych ze znacznikiem czasu i stopniem ważności. Może również zawierać identyfikatory trasy i odcinka, gdy jest skorelowany z trasą. Zobacz rekord logu.

Metadane

Para klucz-wartość, na przykład foo="bar", dodana do encji wytwarzającej telemetrię. OpenTelemetry nazywa te pary atrybutami. Ponadto metryki mają wymiary i etykiety, a logi mają pola.

Metryka

Rejestruje punkt danych — surowe pomiary lub wstępnie zdefiniowaną agregację — jako szereg czasowy z metadanymi. Zobacz Metryka.

OC

Skrót od OpenCensus.

Backend obserwowalności

Komponent platformy obserwowalności odpowiedzialny za odbieranie, przetwarzanie, przechowywanie i wykonywanie zapytań na danych telemetrycznych. Przykłady obejmują narzędzia otwartoźródłowe takie jak Jaeger i Prometheus, a także rozwiązania komercyjne. OpenTelemetry nie jest backendem obserwowalności.

Frontend obserwowalności

Komponent platformy obserwowalności dostarczający interfejsy użytkownika do wizualizacji i analizy danych telemetrycznych. Często może być częścią backendu obserwowalności, szczególnie w przypadku rozwiązań komercyjnych.

OpAMP

Skrót od Open Agent Management Protocol.

Pisownia: Pisz OpAMP, nie OPAMP ani opamp w opisach lub instrukcjach.

OpenCensus

Poprzednik OpenTelemetry. Szczegóły w sekcji Historia.

OpenTelemetry

Projekt OpenTelemetry, powstały w wyniku połączenia projektów OpenTracing i OpenCensus — który jest tematyką tej witryny — to zbiór API, SDK i narzędzi, których można użyć do instrumentacji, generowania, zbierania i eksportowania danych telemetrycznych takich jak metryki, logi i trasy.

Pisownia: OpenTelemetry powinno być zawsze jednym słowem bez łącznika i pisane z wielkiej litery.

OpenTracing

Poprzednik OpenTelemetry. Szczegóły w sekcji Historia.

OT

Skrót od OpenTracing.

OTel

Skrót od OpenTelemetry.

Pisownia: Pisz OTel, nie OTEL.

OTelCol

Skrót od OpenTelemetry Collector.

OTEP

Skrót od OpenTelemetry Enhancement Proposal.

Pisownia: Pisz “OTEPy” w liczbie mnogiej. Nie pisz OTep ani otep w opisach.

OTLP

Skrót od OpenTelemetry Protocol.

Propagatory

Służą do serializacji i deserializacji określonych części danych telemetrycznych, takich jak kontekst odcinka i bagaż w odcinkach. Zobacz Propagatory.

Proto

Niezależne od języka typy interfejsów. Zobacz opentelemetry-proto.

Odbiornik

Termin używany przez Kolektor do określenia sposobu odbierania danych telemetrycznych. Odbiorniki mogą działać w trybie wysyłania (push) lub udostępniania (pull). Zobacz Receiver.

Żądanie

Zobacz Trasowanie rozproszone.

Zasób

Zbiór encji lub atrybutów identyfikujących lub opisujących obiekt fizyczny lub logiczny wytwarzający telemetrię.

REST

Skrót od Representational State Transfer.

RPC

Skrót od Remote Procedure Call.

Próbkowanie

Mechanizm kontroli ilości eksportowanych danych. Najczęściej używany ze źródłem danych typu trasa. Zobacz Próbkowanie.

SDK

Skrót od Software Development Kit. Oznacza SDK telemetrii — bibliotekę implementującą API OpenTelemetry.

Konwencje semantyczne

Definiują standardowe nazwy i wartości metadanych w celu dostarczenia danych telemetrycznych niezależnych od dostawcy.

Usługa

Komponent aplikacji. Zazwyczaj wdraża się wiele instancji usługi dla wysokiej dostępności i skalowalności. Usługa może być wdrożona w wielu lokalizacjach.

Sygnał

Sygnałem jest trasa, metryka lub log. Zobacz Sygnały.

Odcinek

Reprezentuje pojedynczą operację w ramach trasy. Zobacz Odcinek.

Powiązanie między odcinkami

Powiązanie między odcinkami to powiązanie między przyczynowo związanymi odcinkami. Szczegóły w Linkach między odcinkami oraz Określaniu linków.

Specyfikacja

Opisuje wymagania i oczekiwania międzyjęzykowe dla wszystkich implementacji. Zobacz Specyfikacja.

Status

Wynik operacji. Zazwyczaj używany do wskazania, czy wystąpił błąd. Zobacz Status.

Tag

Zobacz Metadane.

Trasa

DAG odcinków, gdzie krawędzie między odcinkami są zdefiniowane jako relacja rodzic-dziecko. Zobacz Trasy.

Traser

Odpowiedzialny za tworzenie odcinków. Zobacz Tracer.

Transakcja

Zobacz Trasowanie rozproszone.

zPages

Alternatywa wewnątrzprocesowa dla zewnętrznych Eksporterów. Po dołączeniu zbierają i agregują informacje o trasowaniu i metrykach w tle; dane te są serwowane na stronach internetowych na żądanie. Zobacz zPages.