Доступні інструментування

Автоматичне інструментування OpenTelemetry .NET підтримує широкий спектр бібліотек.

Інструментування

Усі інструментування стандартно увімкнені для всіх типів сигналів (трейси, метрики та логи).

Ви можете вимкнути всі інструментування для певного типу сигналу, встановивши змінну середовища OTEL_DOTNET_AUTO_{SIGNAL}_INSTRUMENTATION_ENABLED в значення false.

Для більш детального підходу ви можете вимкнути конкретні інструментування для даного типу сигналу, встановивши змінну середовища OTEL_DOTNET_AUTO_{SIGNAL}_{0}_INSTRUMENTATION_ENABLED в значення false, де {SIGNAL} — це тип сигналу, наприклад TRACES, а {0} — це чутлива до регістру назва інструментування.

Інструментування трейсів

Статус: Змішаний. Трейси стабільні, але окремі бібліотеки інструментування мають експериментальний статус через відсутність стабільної семантичної домовленості.

[1]: Загальне інструментування ADO.NET, що охоплює методи DbCommand. Воно охоплює лише реалізації перевизначених методів. Зазвичай багато реалізацій використовують ключове слово new у C#; такі випадки потребують конкретних реалізацій. Це інструментування не охоплює бібліотеки, що охоплюються конкретними інструментуваннями, такими як SQLCLIENT, NPGSQL, MYSQLDATA, MYSQLCONNECTOR, ORACLEMDA або SQLITE.

[2]: Підтримує System.Data.Common (версії від 4.0.0 до 12.0.0 включно), System.Data для .NET Framework (версії від 2.0.0 до 5.0.0 включно) та netstandard (версії від 2.0.0 до 3.0.0 включно).

[3]: Підтримується лише інтегрований режим конвеєра.

[4]: ASP.NET (.NET Framework) MVC / WebApi не підтримується на ARM64.

[5]: Пакети з префіксом Azure., випущені після 1 жовтня 2021 року.

[6]: Версія Elastic.Clients.Elasticsearch ≥8.0.0 і <8.10.0. Версія ≥8.10.0 підтримується інструментуванням Elastic.Transport.

[7]: Confluent.Kafka підтримується з версії ≥1.8.2 на ARM64 для Windows та Linux та ≥1.9.2 на macOS.

[8]: MongoDB.Driver потребує інструментування байт-коду лише для версій < 3.7.0; у версіях 3.7.0+ використовується лише інструментування вихідного коду.

[9]: RabbitMq.Client потребує інструментарію байт-коду лише для версій 5.* та 6.*, версії 7.0.0+ використовують лише інструментування вихідного коду.

[10]: System.Data.SqlClient є застарілим.

[11]: Microsoft.Data.SqlClient v3.* не підтримується на .NET Framework через проблему. System.Data.SqlClient підтримується починаючи з версії 4.8.5.

[12]: Інструментування байт-коду використовується лише для поширення контексту, налаштовується за допомогою OTEL_DOTNET_EXPERIMENTAL_SQLCLIENT_ENABLE_TRACE_CONTEXT_PROPAGATION.

[13]: Підтримуються версії StackExchange.Redis ≥2.6.122 та <4.0.0 на .NET, та версії ≥2.6.122 та <3.0.0 на .NET Framework.

[14]: Інструментування байт-коду використовується лише для поширення контексту, налаштовується за допомогою OTEL_DOTNET_AUTO_NPGSQL_CONTEXT_PROPAGATION.

[15]: Підтримуються версії Quartz ≥3.4.0 та <4.0.0, але підтримка Quartz 3.x застаріла. Версії ≥4.0.0 підтримуються лише на .NET 10+.

Інструментування метрик

Статус: Змішаний. Метрики стабільні, але окремі інструментування мають експериментальний статус через відсутність стабільної семантичної конвенції.

[1]: Метрики ASP.NET генеруються лише якщо інструментування трейсів AspNet також увімкнено.

[2]: System.Data.SqlClient є застарілим.

[3]: Microsoft.Data.SqlClient v3.* не підтримується на .NET Framework через проблему. System.Data.SqlClient підтримується починаючи з версії 4.8.5.

Інструментування логів

Статус: Експериментальний.

[1]: Для ASP.NET Core застосунків, інструментування LoggingBuilder може бути увімкнено без використання .NET CLR Profiler, встановивши змінну середовища ASPNETCORE_HOSTINGSTARTUPASSEMBLIES в значення OpenTelemetry.AutoInstrumentation.AspNetCoreBootstrapper.

[2]: Інструментування надає як контекст для інʼєкції трейсів та і місток для логів.

Опції інструментування

[1]: Ця функція підтримується лише пакунками 23.26.200 та новішими. Також вимагає сервера Oracle AI Database 26ai.

[2]: Увімкнення перекомпіляції IL для SqlCommand у .NET Framework, щоб забезпечити наявність CommandText для інструментування SqlClient, що є необхідним для заповнення полів db.query.text та db.query.summary. Раніше CommandText був доступний лише для збережених процедур. Якщо це налаштування ввімкнено, воно також доступне для необроблених запитів. Це змінює поведінку подій, що генеруються SqlEventSource, що може вплинути на інші частини програми, якщо використовується цей механізм.

[3]: Приймач PostgreSQL з OpenTelemetry Collector Contrib надає це значення як postgresql.application_name у своїй події db.server.query_sample. Збір вибірок запитів вимкнено стандартно і вимагає pg_monitor; дивіться закріплену конфігурацію приймача. Поширення виконує SET application_name через синхронний шлях ExecuteInternalCommand Npgsql перед кожною операцією з трасуванням. Npgsql скидає цю команду та очікує на її відповіді CommandComplete і ReadyForQuery, тому поширення додає один обмін із базою даних на кожну операцію з трасуванням. Воно не змінює, не додає префіксів і не обʼєднує SQL застосунку. Коли Npgsql завершує дію користувача, поки він усе ще володіє зʼєднувачем, інструментування виконує RESET application_name через той самий шлях. Це додає один обмін для очищення на кожну поширену операцію та скидає значення до стандартного для сесії, налаштованого під час відкриття зʼєднання, до того як керування повертається тому, хто викликає, або зʼєднувач можна використати для іншої операції. PostgreSQL RESET не відновлює значення, присвоєне пізніше через SET; тому ввімкнення цієї опції може перезаписати зміни application_name, зроблені кодом застосунку під час виконання. Дивіться життєвий цикл EndUserAction Npgsql. Ці внутрішні команди використовують потік Simple Query у PostgreSQL, який відкидає попередній безіменний оператор і портал; явно підготовлені та автоматично підготовлені оператори Npgsql є іменованими і залишаються повʼязаними з фізичним зʼєднанням. Дивіться правила протоколу розширених запитів PostgreSQL та документацію щодо підготовлених операторів Npgsql. Оскільки SET і RESET є справжніми операторами PostgreSQL, спостерігач, що виконує опитування під час їх короткого виконання, теоретично може їх зафіксувати. Очищення відкладається, поки транзакція перебуває в стані помилки, щоб ROLLBACK міг виконатися першим, а потім виконується, коли дія відновлення успішно завершується. Операції COPY у Npgsql 10+ охоплюються через його життєвий цикл TraceCopyStart. Мультиплексування не підтримується: application_name є станом фізичної сесії, тоді як Npgsql може записувати кілька логічних команд до одного зʼєднувача в одному циклі мультиплексування. Інструментування безпечно пропускає поширення та записує одне попередження, коли виявляє мультиплексований зʼєднувач.