Dashboard

W tej sekcji opisane są endpointy do generowania dashboardu dla konkektora

Endpointy

Met
Endpoint
Opis
Source
Target
Requires config helper

GET

dashboard/{connector_name}/is_debezium

Czy konnektor jest konektorem debezium

GET

dashboard/{connector_name}/data_sources

Include i exclude schema, table, column list dla konektora

GET

dashboard/{connector_name}/metric_categories

Lista kategorii metryk dostępna dla podanego konektora

GET

dashboard/{connector_name}/graph

Pobierz całą historię monitorowań dla connectora

GET

dashboard/{connector_name}/dashboard

Podstawowe informacje o konektorze

GET

dashboard/{connector_name}/dashboard_debezium?fetchDatabaseTables=true

Podstawowe informacje o konektorze debezium

GET

dashboard/{connector_name}/info

Podstawowe statystki konektora

GET

dashboard/{connector_name}/topics_info

Informacje o topickach - ilość wiadomości, rozmiar, ilość segmentów

GET

dashboard/{connector_name}/tables

Informacje o topickach i powiązanych tabelach + informacje o sygnałach

Opis dla GET dashboard/{connector_name}/graph:

Parametry:

  • query: [LATEST , RANGE] - typ zwracanych danych, najnowsze, lub z określonego przedziału. Przy opcji RANGE konieczne jest podanie parametrów

  • categories: kategorie metryk, które chcemy pobrać. Na tę chwile dostępne opcje to: 

    SNAPSHOT, SCHEMA, STREAMING, LOGMINER, STREAMING_HIGHLIGHTS, SOURCE_CONNECTOR_INFO, TARGET_CONNECTOR_INFO, KAFKA_LOG

  • start - (wymagane dla RANGE) czas początkowy, jako timestamp np. 2024-07-18T11:43:13%2B02:00

  • end- (wymagane dla RANGE) czas końcowy, jako timestamp np. 2024-07-18T11:43:13%2B02:00

  • step- (wymagane dla RANGE) odstęp między punkami czasowymi wyrażony w formacie: 

    *          ms - milliseconds
*          s - seconds
*          m - minutes
*          h - hours
*          d - days - assuming a day has always 24h
*          w - weeks - assuming a week has always 7d
*          y - years - assuming a year has always 365d
*          e.g.
*             - 5m
*             - 1m15s

Opis dla GET dashboard/{connector_name}/dashboard_debezium:

Parametry:

  • fetchDatabaseTables: [false , true] - jeśli ustawione na true obliczana jest liczba monitorowanych tabel na podstawie konfiguracji co wymaga pobierania z bazy listy schematów i tabel. W trakcie obliczania sprawdzane jest czy podane w konfiguracji tabele i schematy istnieją.

Reponse:

  • connected -> aktualna wartość metryki debezium streaming Connected

  • snapshotRunning -> aktualna wartość metryki debezium snapshot SnapshotRunning

  • snapshotTablesCount -> aktualna wartość metryki debezium snapshot TotalTableCount

  • monitoredTablesCount -> liczba tabel istniejących w bazie danych, które powinny być monitorowane zgodnie z konfiguracją konektora

  • timeSinceLastEvent -> czas od ostatniego eventu typu streaming

"topicsCount": 1,
"tasksCount": 1,
"state": "RUNNING",
"type": "SOURCE",
"connectorClass": "io.debezium.connector.postgresql.PostgresConnector",
"workerId": "localhost:8083",
"config": {...},
"connected": false,
"snapshotRunning": false,
"monitoredTablesCount": 1,
"snapshotTablesCount": 1,
"snapshotMode": "ALWAYS",
"timeSinceLastEvent": 1:23:11

PreviousConnectorsNextMetryki

Last updated