Metryki i ślady OpenTelemetry
Portal i serwis WEBCON udostępniają dane telemetryczne w standardzie OpenTelemetry – metryki i ślady (spany), a Portal także logi. Dane można przesyłać do narzędzi zgodnych ze standardem, np. Prometheus, Grafana, Grafana Tempo, Jaeger czy Azure Application Insights, i na ich podstawie budować raporty oraz alerty.
Poniższe zestawienie obejmuje metryki i spany specyficzne dla WEBCON w wersji 2026 R1. Standardowe instrumentacje (ASP.NET Core, HttpClient, SqlClient, klient WCF, metryki procesu i środowiska uruchomieniowego .NET) generują dane zgodnie z konwencjami semantycznymi OpenTelemetry i nie są tu opisywane.
Konfiguracja
Od wersji 2026 R1 telemetria jest konfigurowana w pliku appsettings.json, osobno w katalogu instalacyjnym Portalu i serwisu, w sekcji OpenTelemetry. Plik otlpsettings.json z wcześniejszych wersji nie jest już używany.
"OpenTelemetry": {
"Metrics": {
"Enabled": false,
"Prometheus": { "Enabled": true, "Endpoint": "/metrics", "CacheDuration": 100 },
"Exporters": {}
},
"Tracing": {
"Enabled": false,
"ShowExceptions": true,
"HttpTracing": true,
"SqlTracing": { "Enabled": true, "ShowDbStatements": true },
"Exporters": {}
},
"Logs": { "Enabled": false, "Exporters": {} }
}
| Węzeł | Znaczenie |
|---|
Metrics | Włącza zbieranie metryk. Po włączeniu działają wszystkie dostępne instrumentacje – nie można ich włączać osobno. Węzeł Prometheus udostępnia metryki pod adresem Endpoint (domyślnie /metrics). |
Tracing | Włącza zbieranie śladów. SqlTracing > ShowDbStatements decyduje, czy treść zapytań SQL jest zapisywana w śladach. Ślady zawierają wtedy także connection string bazy danych, z którego przed zapisaniem usuwane jest hasło. |
Logs | Włącza eksport logów Portalu przez protokół OTLP. Serwis nie eksportuje logów. |
Exporters | Lista eksporterów OTLP danego rodzaju danych, np. "Otlp": { "Enabled": true, "Endpoint": "", "Headers": "", "Protocol": "http" }. |
Aby eksporter działał, węzeł eksportera i jego węzeł nadrzędny (Metrics, Tracing lub Logs) muszą mieć wartość "Enabled": true.
Połączenie z Azure Application Insights konfiguruje się poza sekcją OpenTelemetry, w węźle ApplicationInsights > ConnectionString. Ustawienie samego connection stringa powoduje wysyłanie śladów, metryk i logów do Application Insights niezależnie od ustawień sekcji OpenTelemetry.
Serwis działa jako kilka procesów, z których każdy udostępnia metryki pod osobnym adresem:
| Proces serwisu | Adres metryk |
|---|
WebCon.WorkFlow.Bootstrapper | Brak domyślnego portu – można go określić w węźle Kestrel pliku appsettings.production.json. |
Webcon.WorkFlow.Module.ServiceModuleRunner | Port 48450, zmieniany w pliku modulesettings.modulesOrchestration.Production.json (węzeł serviceModuleRunnerPort). |
Webcon.WorkFlow.Service | http://localhost:9464, zmieniany w pliku modulesettings.service.Production.json w katalogu OldService. Nowy adres musi być zarejestrowany dla konta, na którym działa serwis. |
Metryki
Kolektory, np. Prometheus, zamieniają łączniki w nazwach metryk na podkreślenia i w zależności od typu metryki dodają przyrostki, np. _total, _bucket, _sum lub _count.
| Metryka | Opis |
|---|
webcon-workflow-portal-open | Liczba otwarć strony głównej Portalu w przeglądarce (każde nowe okno przeglądarki). |
webcon-workflow-form-open | Liczba otwarć elementu obiegu w przeglądarce. |
webcon-workflow-form-elements-cache | Liczba modeli elementów przechowywanych w pamięci podręcznej. Model jest dodawany przy otwarciu formularza i usuwany po przejściu ścieżką. |
webcon-workflow-form-path-transitions | Liczba wszystkich rozpoczętych przejść ścieżką, łącznie z zakończonymi błędem. |
webcon-workflow-form-success-path-transitions | Liczba przejść ścieżką zakończonych powodzeniem. |
webcon-workflow-form-path-transitions-in-progress | Liczba przejść ścieżką wykonywanych w danej chwili. Poprawne przejście trwa zwykle kilkaset milisekund, więc wzrost wartości wskazuje na obciążenie systemu. |
webcon-workflow-form-path-transition-times | Rozkład (histogram) czasów wykonania przejść ścieżką. |
webcon-workflow-portal-ticket-store-cache | Liczba obiektów w pamięci podręcznej ticketów uwierzytelniania użytkowników. |
webcon-workflow-portal-token-store-cache | Liczba obiektów w pamięci podręcznej tokenów. |
webcon-workflow-ocr-finereader-license-remaining-pages | Liczba stron, które można jeszcze przetworzyć w ramach licencji FineReader. |
webcon-workflow-solr-elements-queue | Liczba pozycji dodanych do kolejki indeksowania elementów (SolrElementIndexer). |
webcon-workflow-solr-attachments-queue | Liczba pozycji dodanych do kolejki indeksowania załączników (SolrAttachmentIndexer). |
webcon-workflow-solr-activities-queue | Liczba pozycji dodanych do kolejki indeksowania aktywności (SolrActivityIndexer). |
webcon-workflow-solr-utilities-queue | Liczba pozycji dodanych do kolejki indeksowania pomocniczego (SolrUtilityIndexer). |
webcon-workflow-solr-elements-processed | Liczba pozycji usuniętych z kolejki indeksowania elementów po przetworzeniu. |
webcon-workflow-solr-attachments-processed | Liczba pozycji usuniętych z kolejki indeksowania załączników po przetworzeniu. |
webcon-workflow-solr-activities-processed | Liczba pozycji usuniętych z kolejki indeksowania aktywności po przetworzeniu. |
webcon-workflow-solr-utilities-processed | Liczba pozycji usuniętych z kolejki indeksowania pomocniczego po przetworzeniu. |
uda-endpoint-automation | Liczba wywołań punktów końcowych User Defined API (UDA) uruchamiających automatyzacje. |
uda-endpoint-data-source | Liczba wywołań punktów końcowych UDA dla źródeł danych. |
uda-endpoint-element-data | Liczba wywołań punktów końcowych UDA zwracających dane elementu. |
uda-endpoint-element-transition | Liczba wywołań punktów końcowych UDA wykonujących przejście ścieżką, zapis lub rejestrację elementu. |
Ślady (spany)
Od wersji 2026 R1 wszystkie ślady Portalu i serwisu zawierają atrybut db.id – identyfikator bazy danych zawartości. Atrybuty spanów opisuje tabela Opis atrybutów śladów.
Obsługa żądań w Portalu
| Span | Opis | Atrybuty |
|---|
| Create controller | Utworzenie kontrolera obsługującego żądanie. | ControllerName |
| Controller endpoint action | Wykonanie metody kontrolera obsługującej żądanie. | – |
| Bind model | Powiązanie danych żądania z modelem. | – |
| Deserialize commands model | Odczytanie modelu poleceń przesłanego w żądaniu (także na etapie autoryzacji). | – |
| Input JSON Formatter - ReadAsync | Konwersja parametru wejściowego z formatu JSON na obiekt. | – |
| Output JSON Formatter - WriteAsync | Konwersja wyniku do formatu JSON. | – |
| DetermineProviderCultureResult | Ustalenie języka użytkownika i kontekstu jego użycia. | – |
| Filters context | Wykonanie filtrów żądania (span nadrzędny dla poszczególnych etapów). | – |
| Authorization filters | Etap autoryzacji żądania. | – |
| RequireApplicationFilter | Sprawdzenie dostępu do aplikacji na etapie autoryzacji. | – |
| Resource filters | Etap zasobów. | – |
| Resource filters OnResourceExecuting | Etap zasobów przed obsługą żądania. | – |
| Resource filters OnResourceExecuted | Etap zasobów po obsłudze żądania. | – |
| Action filters | Etap akcji. | – |
| Action filters OnActionExecuting | Etap akcji przed obsługą żądania. | – |
| Action filters OnActionExecuted | Etap akcji po obsłudze żądania. | – |
| RequireReportViewFilter | Sprawdzenie uprawnień do widoku raportu. | – |
| Exception filters | Etap obsługi wyjątków. | – |
| Result filters | Etap wyniku. | – |
| Result filters OnResultExecuting | Etap wyniku przed zwróceniem odpowiedzi. | – |
| Result filters OnResultExecuted | Etap wyniku po zwróceniu odpowiedzi. | – |
| Action result execution | Wygenerowanie wyniku zwracanego w odpowiedzi na żądanie. | – |
| HeartBeat | Pojedynczy sygnał aktywności (heartbeat) Portalu. | – |
| Span | Opis | Atrybuty |
|---|
| GetElementFormAsync | Utworzenie modelu nowego lub istniejącego elementu (opcjonalnie na podstawie pamięci podręcznej). | – |
| LoadExistingElementFormAsync | Utworzenie pełnego, aktualnego modelu formularza elementu. | – |
| LoadJsModelAsync | Utworzenie modelu JS elementu. | – |
| Nazwa etapu budowania modelu JS | Etap budowania modelu JS elementu (lista etapów poniżej). | – |
| GetElementInfoAsync | Pobranie szczegółowych informacji o elemencie. | – |
| GetDesktopAsync | Pobranie informacji o elemencie wraz z jego statusem. | – |
| Apply business rules and set default values | Wykonanie reguł biznesowych i ustawienie wartości domyślnych. | – |
| UpdateFormFieldsAsync | Aktualizacja wartości pól formularza. | – |
| FillEntityDataAsync | Pobranie danych dla pola wyboru. | Field ID, Field name, Data source ID |
| Get form field report data | Wczytanie danych raportu SQL wyświetlanego w polu formularza. | ReportId |
| Nazwa polecenia listy pozycji | Przekazanie polecenia do listy pozycji (lista poleceń poniżej). | – |
| MoveElementToNextStepAsync | Wykonanie przejścia ścieżką dla elementu (bez zapisu). | Path id, Element id |
| Move to next step | Czas wykonania przejścia ścieżką lub zapisu elementu. | Path Id |
| FormsController.ExecuteBusinessRule | Wykonanie reguły biznesowej wywołanej z formularza. | – |
| FormsController.GenerateBarcode | Wygenerowanie kodu kreskowego 1D formularza. | – |
| FormsController.GenerateBarcode2D | Wygenerowanie kodu kreskowego 2D formularza. | – |
| FormsController.GenerateDoc | Wygenerowanie dokumentu DOC na podstawie szablonu formularza. | – |
| FormsController.GenerateHtmlAsync | Wygenerowanie dokumentu HTML na podstawie szablonu formularza. | – |
| FormsController.GeneratePdfAsync | Wygenerowanie dokumentu PDF na podstawie szablonu formularza. | – |
| FormsController.GetMobileChart | Pobranie modelu wykresu. | – |
| FormsController.GetSqlGrid | Pobranie modelu pola Tabela danych. | – |
| FormsController.GetSqlRow | Pobranie modelu pola Wiersz danych. | – |
| FormsController.GetWidgetData | Pobranie modelu widżetu. | – |
| FormsController.GetVacationsChartData | Pobranie danych wykresu urlopowego. | – |
Polecenia listy pozycji: CloneSubelementsRow, InitializeSubelements, ImportSubelementsFromExcel, AddSubelementsRow, ChangeCellValue, PickerResolve, RemoveSelectedSubelementsRows, RecalculateRow, RecalculateSubelements, RestoreValue.
Etapy budowania modelu JS: InsertControlsForOcrVerificationStep, InsertOcrModeButtonStep, SetIsOcrVerificationViewStep, CheckCheckoutStep, DeskInsertPathsStep, ExecuteOnLoadActionsStep, InsertAttachmentsStep, InsertClientInfoStep, InsertClientJsForLiteStep, InsertClientJsForMobileStep, InsertControlsStep, InsertDeskScreenshotDataStep, InsertGeneralFormDataStep, InsertInitialDataStep, InsertLicenseInfoStep, InsertMenuActionsStep, InsertPathsStep, InsertToModelStep, MutateMobileModelStep, RecoverMultilinePrimaryStep, SetIsCompactModelStep.
Lista pozycji
| Span | Opis | Atrybuty |
|---|
| Update client value | Aktualizacja listy pozycji. | – |
| Commands deserialization | Odczytanie poleceń aktualizacji listy pozycji. | – |
| Run commands | Wykonanie poleceń aktualizacji listy pozycji. | – |
| NewRowAsync | Utworzenie nowego wiersza listy pozycji. | Form field, Form field id, Row id |
| CreateSubelementsReadViewModelAsync | Utworzenie modelu listy pozycji w trybie odczytu. | – |
| CreateSubelementsWriteViewModelAsync | Utworzenie modelu listy pozycji w trybie edycji. | – |
| RecalculateAsync | Przeliczenie wartości listy pozycji. | – |
| RecalculateRowAsync | Przeliczenie wiersza listy pozycji. | Row Id |
| CheckSaveRestrictions | Sprawdzenie ograniczeń zapisu listy pozycji. | – |
| ValidateAsync | Walidacja listy pozycji. | – |
| ResolveAsync | Przetworzenie listy pozycji. | – |
| RecalculateRestrictionsAsync | Przeliczenie ograniczeń listy pozycji. | – |
| ApplySpecificRestrictionsAsync | Zastosowanie ograniczeń listy pozycji. | – |
| SaveAsync | Zapis listy pozycji. | – |
| SaveHistory | Zapis historii listy pozycji. | – |
| LoadData | Wczytanie danych listy pozycji. | – |
Raporty
| Span | Opis | Atrybuty |
|---|
| Get report data | Wczytanie danych raportu SQL. | ReportId |
| Prepare report view | Przygotowanie widoku raportu SQL. | – |
| SweController.GetViewData | Pobranie danych widoku raportu dla bieżącego użytkownika. | – |
| Data repository - Get report engine | Etap wczytywania raportu SQL – przygotowanie mechanizmu raportu. | – |
| Data repository - Apply visibility restrictions | Etap wczytywania raportu SQL – zastosowanie ograniczeń widoczności. | – |
| Data repository - Create columns | Etap wczytywania raportu SQL – utworzenie kolumn. | – |
| Data repository - Get search columns | Etap wczytywania raportu SQL – utworzenie kolumn wyszukiwania. | – |
| Data repository - Get data | Etap wczytywania raportu SQL – pobranie danych. | – |
| Data repository - Create summary | Etap wczytywania raportu SQL – utworzenie podsumowania. | – |
| Get Summaries Row | Wykonanie zapytania zwracającego wiersz podsumowania raportu. | – |
Reguły, akcje i znaczniki
| Span | Opis | Atrybuty |
|---|
| EvaluateRuleAsync | Wykonanie reguły biznesowej. | Rule id, Rule name |
| Evaluate business rule | Obliczenie węzła reguły biznesowej. | Id |
| Ux rule execution | Wykonanie kodu JavaScript reguły formularza. | Rule id, Rule name |
| Execute action | Wykonanie akcji. | Id, Name |
| Execute attachment action | Wykonanie akcji uruchamianej przy dodaniu załącznika. | Id, Name |
| Replace tags | Zastąpienie znaczników wartościami. | Mode |
| Replace attachment tags | Zastąpienie znaczników w kontekście załącznika. | FileName |
Załączniki
| Span | Opis | Atrybuty |
|---|
| Upload file to OneDrive | Przesłanie pliku do OneDrive. | File name, Environment Application ID, Environment Tenant ID |
| Update permissions for OneDrive file | Aktualizacja uprawnień do pliku w OneDrive. | File name, Environment Application ID, Environment Tenant ID |
| OneDrive - Add permissions | Nadanie uprawnień do pliku w OneDrive. | Read, Write |
| Text extraction | Wyodrębnienie tekstu z załącznika na potrzeby indeksu SOLR. | FileName, FileSize |
Źródła danych i zapytania SQL
| Span | Opis | Atrybuty |
|---|
| Nazwa zapytania SQL | Zapytanie SQL wykonywane przez system. Nazwa spanu zależy od zapytania. | Query, db.id |
| Load data from datasource | Wczytanie danych ze źródła danych. | Data source id, Data source type |
| Establish ldap connection | Nawiązanie połączenia z katalogiem LDAP. | Host name, Port, Use ssl, Trust server certificate |
| Perform LDAP search | Wyszukiwanie w katalogu LDAP. | DN, Filter, Count limit |
Pamięć podręczna i transakcje
| Span | Opis | Atrybuty |
|---|
| Load cache | Wczytanie pamięci podręcznej. | DbId, Cache groups, Cache version, SnapshotIsolationSqlException |
| Refresh cache | Odświeżenie pamięci podręcznej. | DbId, Cache groups, Cache version, Business objects to load, SnapshotIsolationSqlException |
| Mark cache to refresh | Oznaczenie pamięci podręcznej konfiguracji do odświeżenia. | Cache groups, Reason |
| Mark data cache to refresh | Oznaczenie pamięci podręcznej danych do odświeżenia. | Data cache groups |
| CacheStore LoadAll | Pobranie pełnej konfiguracji z bazy danych. | DbId, Cache groups |
| SetUpCache | Pobranie i inicjalizacja pamięci podręcznej serwisu. | – |
| Refresh config db cache | Odświeżenie pamięci podręcznej bazy konfiguracyjnej. | Cache groups, Cache version |
| Transaction: nazwa zakresu | Zakres transakcji bazodanowej. | Element id |
| Nazwa zakresu wewnętrznego | Wykonanie nazwanego zakresu wewnętrznego. | – |
Użytkownicy i uwierzytelnianie
| Span | Opis | Atrybuty |
|---|
| Converting NetBIOS name to principal name | Konwersja nazwy NetBIOS na nazwę UPN. | – |
| Active Directory bind | Operacja bind w Active Directory podczas synchronizacji użytkowników. | Domain |
| Active Directory request | Wyszukiwanie w Active Directory podczas synchronizacji użytkowników. | Url |
| Clear substitutions cache | Wyczyszczenie pamięci podręcznej zastępstw. | – |
| TokenStore - Store | Zapisanie tokenu w pamięci podręcznej. | – |
| TokenStore - TryFind | Wyszukanie tokenu w pamięci podręcznej. | – |
| TicketStore - Store | Zapisanie ticketu uwierzytelniania w pamięci podręcznej. | – |
| TicketStore - Renew | Odnowienie ticketu uwierzytelniania. | – |
| TicketStore - Retrieve | Pobranie ticketu uwierzytelniania. | – |
| TicketStore - Remove | Usunięcie ticketu uwierzytelniania. | – |
Serwis
| Span | Opis | Atrybuty |
|---|
| Service start | Uruchomienie serwisu. | – |
| Service stop | Zatrzymanie serwisu. | – |
| Emergency service stop | Awaryjne zatrzymanie serwisu. | – |
| Service reload | Wczytanie konfiguracji serwisu. | – |
| RoleKeeper start | Inicjalizacja modułów serwisu. | – |
| RoleKeeper CheckRoles | Cykliczne sprawdzenie modułów serwisu. | – |
| Update heartbeat | Sygnał aktywności (heartbeat) serwisu. | – |
| Check health | Sprawdzenie stanu serwisu. | – |
| Service activity: nazwa działania | Wykonanie pojedynczej aktywności serwisu. | Connection string |
| Thread processing | Zakres przetwarzania dowolnego wątku kolejki serwisu. | Role, ThreadId, ThreadGuid |
| Thread action | Przetwarzanie pojedynczej pozycji kolejki bazy danych zawartości w wątku serwisu. | Role, ThreadId, ThreadGuid |
| LabelPrintImplementation | Wydruk etykiety. | Printer name |
| PowerShell Action | Wykonanie akcji Uruchom skrypt PowerShell. | – |
Indeksowanie SOLR
| Span | Opis | Atrybuty |
|---|
| QueryWithPerformanceLogAsync | Wykonanie zapytania do SOLR. | – |
| SOLR - Batch elements index | Etap zbiorczego indeksowania elementów w SOLR. | – |
| SOLR - Batch element index | Etap indeksowania pojedynczego elementu w SOLR. | WFD_ID |
| SOLR - Batch element index step | Krok indeksowania pojedynczego elementu w SOLR. | StepName |
Opis atrybutów śladów
| Atrybut | Znaczenie |
|---|
db.id | Identyfikator bazy danych zawartości, dodawany automatycznie na podstawie kontekstu żądania (Portal) lub zadania (serwis). W nielicznych przypadkach może wskazywać inną bazę niż ta, w której wykonano operację. |
| DbId | Identyfikator bazy danych, której dotyczy operacja na pamięci podręcznej. |
| Query | Treść zapytania SQL. |
| Connection string | Connection string bazy danych, z której korzysta działanie serwisu. Hasło jest usuwane z connection stringa przed zapisaniem w śladzie. |
| Cache groups, Data cache groups | Grupy pamięci podręcznej objęte operacją. |
| Cache version | Wersja pamięci podręcznej. |
| Business objects to load | Obiekty biznesowe wczytywane podczas odświeżania. |
| Reason | Powód oznaczenia pamięci podręcznej do odświeżenia. |
| SnapshotIsolationSqlException | Informacja o błędzie izolacji migawki (snapshot isolation) podczas wczytywania danych. |
| ControllerName | Nazwa kontrolera obsługującego żądanie. |
| ReportId | Identyfikator raportu. |
| Path id, Path Id | Identyfikator ścieżki. |
| Element id, WFD_ID | Identyfikator elementu obiegu. |
| Form field | Nazwa wyświetlana pola formularza. |
| Form field id, Field ID | Identyfikator pola formularza. |
| Field name | Nazwa pola formularza. |
| Row id, Row Id | Identyfikator wiersza listy pozycji. |
| Id | Identyfikator akcji (spany akcji) lub węzła reguły biznesowej (span Evaluate business rule). |
| Name | Nazwa akcji. |
| Rule id | Identyfikator reguły. |
| Rule name | Nazwa reguły. |
| Mode | Tryb zastępowania znaczników. |
| File name, FileName | Nazwa pliku załącznika. |
| FileSize | Rozmiar pliku załącznika. |
| Environment Application ID | Identyfikator aplikacji (Application ID) połączenia z OneDrive. |
| Environment Tenant ID | Identyfikator dzierżawy (Tenant ID) połączenia z OneDrive. |
| Read | Określa, czy nadano uprawnienie do odczytu. |
| Write | Określa, czy nadano uprawnienie do zapisu. |
| Data source ID, Data source id | Identyfikator źródła danych. |
| Data source type | Typ źródła danych. |
| Host name | Nazwa hosta serwera LDAP. |
| Port | Port serwera LDAP. |
| Use ssl | Określa, czy połączenie używa SSL. |
| Trust server certificate | Określa, czy certyfikat serwera jest zaufany bez weryfikacji. |
| DN | Nazwa wyróżniająca (DN), od której rozpoczyna się wyszukiwanie. |
| Filter | Filtr wyszukiwania LDAP. |
| Count limit | Maksymalna liczba zwracanych wyników. |
| Domain | Domena Active Directory. |
| Url | Adres zapytania do Active Directory. |
| Role | Rola (moduł) serwisu. |
| ThreadId | Identyfikator wątku serwisu. |
| ThreadGuid | Identyfikator GUID wątku serwisu. |
| StepName | Nazwa kroku indeksowania elementu. |
| Printer name | Nazwa drukarki etykiet. |