Навигатор по разделу:
1. Общие сведения
Документ содержит список всех поддерживаемых метрик системы Avanpost IDM.
Метрики доступны по адресу:
Адрес, по которому доступны метрики
/api/v1/metrics
Авторизация для доступа к метрикам не требуется.
Дополнительную информацию о стандартных метриках .NET можно найти в официальной документации .NET.
2. Базовые метрики
2.1. Базовые метрики Prometheus
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
process_start_time_seconds | Дата и время последнего запуска приложения в UNIX-формате | Gauge | сек |
process_virtual_memory_bytes | Размер виртуальной памяти, занимаемой приложением | Gauge | байт |
process_open_handles | Количество дескрипторов приложения | Gauge | ед |
process_working_set_bytes | Размер физической памяти, занимаемой приложением | Gauge | байт |
dotnet_collection_count_total | Количество выполненных операций сборки мусора | Counter | ед |
process_cpu_seconds_total | Затраченное процессорное время на приложение | Counter | сек |
process_private_memory_bytes | Размер физической памяти, занимаемой приложением | Gauge | байт |
dotnet_total_memory_bytes | Количество байт в управляемой куче | Gauge | байт |
3. Прикладные метрики
3.1. Метрики сервера IDM
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
role_change_queue_total | Размер очереди изменения ролей | Gauge | ед |
role_change_error_total | Количество ошибок в очереди изменения ролей | Gauge | ед |
account_lock_queue_total | Размер очереди блокировок | Gauge | ед |
account_lock_error_total | Количество ошибок в очереди блокировок | Gauge | ед |
used_licenses_total | Использовано пользовательских лицензий | Gauge | ед |
free_licenses_total | Доступно пользовательских лицензий | Gauge | ед |
roles_assigned_with_error_total | Количество ролей назначенных с ошибкой | Gauge | ед |
3.2. Метрики сервиса самообслуживания
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
processes_total | Общее количество процессов | Gauge | ед |
active_processes_total | Количество активных процессов | Gauge | ед |
processes_with_error_total | Количество процессов с ошибкой | Gauge | ед |
external_event_pending_total | Размер очереди обработки событий | Gauge | ед |
external_event_success_total | Количество успешно обработанных событий | Gauge | ед |
external_event_unsuccessful_total | Количество неуспешно обработанных событий | Gauge | ед |
user_task_total | Количество задач для пользователей | Gauge | ед |
3.3 Метрики сервиса коннекторов
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
connector_pool_size_total | Размер пула коннекторов | Gauge | ед |
operations_with_error_total | Количество операций с ошибкой | Counter | ед |
3.4. Метрики модуля ABAC
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
auth_requests_executed_total | Количество выполненных запросов авторизации | Counter | ед |
auth_requests_processed_total | Количество обрабатываемых запросов авторизации | Gauge | ед |
auth_requests_with_error_total | Количество запросов авторизации выполненных с ошибкой | Counter | ед |
average_time_auth_request_seconds | Среднее время выполнения запроса авторизации | Gauge | мс |
3.5. Метрики сборки мусора (GC)
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
| process_runtime_dotnet_gc_collections_count_total | Количество сборок мусора, выполненных с момента запуска процесса, с разбивкой по поколениям (gen0, gen1, gen2) | Counter | ед |
| process_runtime_dotnet_gc_objects_size_bytes | Объем памяти, используемый объектами в куче GC, которые еще не были собраны. Фрагментация и другие пулы памяти, выделенные GC, исключены | Gauge | байт |
| process_runtime_dotnet_gc_allocations_size_bytes_total | Общий объем памяти, выделенной в управляемой куче GC с момента запуска процесса | Counter | байт |
| process_runtime_dotnet_gc_committed_memory_size_bytes | Размер фактически зарезервированной виртуальной памяти для управляемой кучи GC, наблюдаемый во время последней сборки мусора. Зарезервированная память может быть больше размера самой кучи, так как включает память для существующих объектов и дополнительную память для новых объектов | Gauge | байт |
| process_runtime_dotnet_gc_heap_size_bytes | Размер кучи, включая фрагментацию, наблюдаемый во время последней сборки мусора. Доступен только после первой сборки мусора | Gauge | байт |
| process_runtime_dotnet_gc_heap_fragmentation_size_bytes | Фрагментация кучи, наблюдавшаяся во время последней сборки мусора. Значение будет недоступно до тех пор, пока не будет выполнена хотя бы одна сборка мусора | Gauge | байт |
| process_runtime_dotnet_gc_duration_nanoseconds_total | Общее время, затраченное на паузы с момента запуска процесса | Counter | наносекунды |
3.6. Метрики JIT-компиляции
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
| process_runtime_dotnet_jit_il_compiled_size_bytes_total | Количество байтов промежуточного языка, скомпилированных с момента запуска процесса | Counter | байт |
| process_runtime_dotnet_jit_methods_compiled_count_total | Количество методов, скомпилированных JIT-компилятором с момента запуска процесса. JIT-компилятор может вызываться несколько раз для одного метода с разными параметрами обобщений или уровнями оптимизации | Counter | ед |
| process_runtime_dotnet_jit_compilation_time_nanoseconds_total | Количество времени, потраченное JIT-компилятором на компиляцию методов с момента запуска процесса | Counter | наносекунды |
3.7. Метрики пула потоков и таймеров
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
| process_runtime_dotnet_monitor_lock_contention_count_total | Количество конфликтов, возникших при попытке захвата блокировок монитора с момента запуска процесса. Конфликты происходят, когда несколько потоков одновременно пытаются получить доступ к ресурсу, защищенному блокировкой. Блокировки монитора обычно реализуются с помощью ключевого слова lock в C# или методов Monitor.Enter() и Monitor.TryEnter() | Counter | ед |
| process_runtime_dotnet_thread_pool_threads_count | Текущее количество потоков в пуле потоков | Gauge | ед |
| process_runtime_dotnet_thread_pool_completed_items_count_total | Общее количество задач, обработанных пулом потоков с момента запуска процесса | Counter | ед |
| process_runtime_dotnet_thread_pool_queue_length | Текущая длина очереди задач, ожидающих обработки в пуле потоков | Gauge | ед |
| process_runtime_dotnet_timer_count | Количество активных таймеров. Таймеры могут быть созданы многими источниками, такими как System.Threading.Timer, Task.Delay или тайм-аутом в CancellationSource. Активный таймер зарегистрирован для срабатывания в будущем и еще не был отменен | Gauge | ед |
3.8. Прочие метрики .NET
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
| process_runtime_dotnet_assemblies_count | Количество сборок .NET, которые в данный момент загружены | Gauge | ед |
| process_runtime_dotnet_exceptions_count_total | Количество исключений, возникших в управляемом коде. Значение будет недоступно, пока исключение не будет выброшено после инициализации OpenTelemetry.Instrumentation.Runtime | Counter | ед |
3.9. Системные метрики
| Наименование метрики | Описание | Тип | Единица измерения |
|---|---|---|---|
| memory_usage | Текущее использование памяти приложением | Gauge | ед |
| cpu_usage | Текущее использование CPU приложением | Gauge | ед |