Skip to content

Commit 6c04abe

Browse files
authored
Tracing documentation (#1331)
1 parent 34ddb63 commit 6c04abe

File tree

8 files changed

+384
-2
lines changed

8 files changed

+384
-2
lines changed

ydb/docs/ru/core/cluster/toc_i.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ items:
1919
href: ../administration/grafana-dashboards.md
2020
- name: Справочник метрик
2121
href: ../reference/observability/metrics/index.md
22+
- name: Трассировка
23+
include: { mode: link, path: ../reference/observability/tracing/toc_p.yaml }
2224
- name: Обновление
2325
href: ../administration/upgrade.md
2426
- name: Изменение конфигурации актор-системы

ydb/docs/ru/core/concepts/_includes/index/how_it_works.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Полное объяснение того, как работает YDB, получилось бы слишком объемным. Ниже вы можете ознакомиться с несколькими основными моментами, а затем продолжить изучение документации, чтобы узнать больше.
44

5-
### Архитектура YDB
5+
### Архитектура YDB {#ydb-architecture}
66

77
![Архитектура YDB](https://storage.yandexcloud.net/ydb-www-prod-site-assets/howitworks/grps.png)
88

ydb/docs/ru/core/maintenance/manual/dynamic-config.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,9 @@ vim dynconfig.yaml
127127
* `log_config`;
128128
* `immediate_controls_config`;
129129
* `table_service_config`;
130-
* `monitoring_config`.
130+
* `monitoring_config`;
131+
* `tracing_config.sampling`;
132+
* `tracing_config.external_throttling`.
131133

132134
В будущем список может быть расширен.
133135

900 KB
Loading
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Передача внешнего trace-id в {{ ydb-short-name }}
2+
3+
## gRPC API
4+
5+
{{ ydb-short-name }} поддерживает передачу внешних trace-id для построения цельной трассы операции. Передача trace-id производится согласно [спецификации trace context](https://w3c.github.io/trace-context/#traceparent-header) — через заголовок `traceparent` gRPC запроса должна передаваться строка вида `00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01`. Она состоит из 4 частей, разделенных символом `-`:
6+
7+
1. Версия – на момент написания документации спецификация определяет только версию 00.
8+
1. Trace id – идентификатор трассы, частью которой является запрос.
9+
1. Parent id – идентификатор родительского спана.
10+
1. Флаги – набор рекомендаций по работе с переданными в заголовке данными.
11+
12+
Только версия 00 поддерживается, флаги игнорируются. Если заголовок не соответствует спецификации, он игнорируется. Все получаемые таким образом трассы имеют [уровень детализации](./setup.md#tracing-levels) 13 (все компоненты трассируются с уровнем `Detailed`).
13+
14+
{% note warning %}
15+
16+
При наличии секции [`external_throttling`](./setup.md#external-throttling) и потоке запросов, превышающем установленные лимиты, могут трассироваться не все запросы. При отсутствии секции [`external_throttling`](./setup.md#external-throttling) заголовок `traceparent` **игноруется** и никакие внешние трассы не продолжаются.
17+
18+
{% endnote %}
19+
20+
## Поддержка SDK
21+
22+
Некоторые SDK поддерживают передачу trace-id, их список, а так же примеры использования вы можете найти на странице [{#T}](../../../reference/ydb-sdk/recipes/debug-jaeger.md).

ydb/docs/ru/core/reference/observability/tracing/setup.md

Lines changed: 349 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
items:
2+
- name: Настройка
3+
href: setup.md
4+
- name: Передача внешнего trace-id
5+
href: external-traces.md
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
items:
2+
- include: { mode: link, path: toc_i.yaml }

0 commit comments

Comments
 (0)