Конвенция наименования тегов

На этой странице:

Основные
Сетевые коммуникации
HTTP вызовы
Базы данных
Очереди сообщений
Удаленные вызовы процедур (RPC)
Ошибки

Основные

Имя	Тип	Описание
`language`	`string`	Язык SDK использованный для создания спана. Возможны следующие значения: `cpp`, `dotnet`, `go`, `jvm`, `javascript`, `php`, `python`, `ruby`.
`span.kind`	`string`	Тип работы, возможны следующие значения: `server`, `client`, `producer`, `consumer` или `internal`
`component`	`string`	Наименование компонента/библиотеки, которая соотносится со спаном.

Сетевые коммуникации

Имя	Тип	Описание
`network.client.ip`	`string`	IP адрес клиента, который инициировал входящее соединение.
`network.destination.ip`	`string`	IP адрес того, куда направляется исходящее соединение.
`network.host.ip`	`string`	IP адрес хоста, на котором был создан спан.
`network.client.port`	`number`	Порт клиента, который инициировал подключение.
`network.destination.port`	`number`	Порт на удаленной машине, к которому устанавливается исходящее соединение.
`network.client.name`	`string`	Имя хоста клиента, инициировавшего входящее соединение.
`network.destination.name`	`string`	Имя удаленного хоста или аналогичного узла, с которым осуществляется исходящее соединение.
`network.host.name`	`string`	Локальное имя хоста.
`network.client.transport`	`string`	Транспортный протокол, используемый для установки входящего соединения.
`network.destination.transport`	`string`	Транспортный протокол, используемый для осуществления исходящего соединения.

HTTP вызовы

Для описания спанов HTTP-клиента и сервера можно использовать следующие теги:

Имя	Тип	Описание
`http.status_code`	`string`	Код статуса ответа HTTP.
`http.url`	`string`	URL-адрес HTTP-запроса, включая обфусцированную строку запроса.
`http.version`	`string`	Версия HTTP, использованная для запроса.
`http.method`	`string`	Порт клиента, инициировавшего соединение.
`http.route`	`string`	Найденный маршрут (шаблон пути). Пример: `/users/:userID`
`http.client_ip`	`string`	IP-адрес исходного клиента, находящегося за всеми прокси-серверами, если он известен. Определяется из таких заголовков, как `X-Forwarded-For`.
`http.useragent`	`string`	Заголовок User-Agent, полученный вместе с запросом.
`http.request.content_length`	`number`	Размер тела полезной нагрузки запроса в байтах.
`http.response.content_length`	`number`	Размер тела полезной нагрузки ответа в байтах.
`http.request.content_length_uncompressed`	`number`	Размер несжатого тела полезной нагрузки запроса после транспортного декодирования.
`http.response.content_length_uncompressed`	`number`	Размер несжатого тела полезной нагрузки ответа после транспортного декодирования.
`http.request.headers.*`	`string`	HTTP-заголовки запроса. По умолчанию не собираются, но могут быть опционально настроены с помощью параметра `POBP_TRACE_HEADER_TAGS`.
`http.response.headers.*`	`string`	HTTP-заголовки ответа. По умолчанию не собираются, но могут быть опционально настроены с помощью параметра `POBP_TRACE_HEADER_TAGS`.

Базы данных

Для описания спанов вызовов к базам данных можно использовать следующие теги:

Имя	Тип	Описание
`db.system`	`string`	Идентификатор системы управления базами данных (используемого продукта СУБД).
`db.connection_string`	`string`	Строка соединения, используемая для подключения к базе данных.
`db.user`	`string`	Имя пользователя, получившего доступ к базе данных
`db.instance`	`string`	Имя базы данных, к которой осуществляется подключение.
`db.statement`	`string`	Выполняемый запрос базы данных.
`db.operation`	`string`	Имя выполняемой операции. Пример: `SELECT`, `findAndModify`, `HMSET`
`db.sql.table`	`number`	Имя первичной таблицы, над которой выполняется операция, включая имя базы данных (если применимо).
`db.row_count`	`number`	Количество строк/результатов запроса или операции.

Дополнительные атрибуты для конкретных технологий баз данных используют префикс db.<db.system>.

Очереди сообщений

Для описания спанов, соответствующих вызовам к системам обмена сообщениями, можно использовать следующие теги:

Имя	Тип	Описание
`messaging.system`	`string`	Идентификатор системы обмена сообщениями.
`messaging.destination`	`string`	Имя места назначения сообщения.
`messaging.destination_kind`	`string`	Вид назначения сообщения.
`messaging.protocol`	`string`	Имя транспортного протокола.
`messaging.protocol_version`	`string`	Версия транспортного протокола.
`messaging.url`	`string`	Строка подключения к системе обмена сообщениями.
`messaging.message_id`	`string`	Значение, используемое системой обмена сообщениями в качестве идентификатора сообщения, представленное в виде строки.
`messaging.conversation_id`	`string`	Идентификатор взаимодействия, к которому принадлежит сообщение, представленный в виде строки.
`messaging.message_payload_size`	`number`	Размер полезной нагрузки несжатого сообщения в байтах.
`messaging.operation`	`string`	Строка, идентифицирующая вид сообщения. Пример: `send` (сообщение, отправленное продюсеру), `receive` (сообщение получено консьюмером), или `process` (ранее полученное сообщение обрабатывается консьюмером).
`messaging.consumer_id`	`string`	Идентификатор консьюмера, получающего сообщение.

Дополнительные атрибуты для конкретных систем обмена сообщениями используют префикс messaging.<messaging.system>.

Удаленные вызовы процедур (RPC)

Для описания спанов, соответствующих удаленным вызовам процедур, таким как RMI или gRPC, можно использовать следующие теги:

Имя	Тип	Описание
`rpc.system`	`string`	Идентификатор удаленной системы.
`rpc.service`	`string`	Имя вызываемого сервиса.
`rpc.method`	`string`	Имя вызываемого метода.

Ошибки

Для описания ошибок, связанных со спанами, можно использовать следующие теги:

Имя	Тип	Описание
`error.type`	`string`	Тип или вид ошибки (или код в некоторых случаях).
`error.message`	`string`	Лаконичное, читаемое человеком сообщение в одну строку, поясняющее суть ошибки.
`error.stack`	`string`	Трассировка стека или дополнительная информация об ошибке.