Tracing documentation #1331

domwst · 2024-01-26T08:27:27Z

Changelog entry

Tracing documentation

Changelog category

Documentation (changelog entry is not required)

Additional information

...

github-actions · 2024-01-26T08:32:22Z

✅ Documentation build

Revision builded successful
Revision preview link

Build logs

Warnings (1)

⚠️ Incorrect syntax for notes, file /ru/administration/tracing/external-traces.md

github-actions · 2024-01-29T00:35:20Z

✅ Documentation build

Revision builded successful
Revision preview link

Build logs

Warnings (1)

⚠️ Incorrect syntax for notes, file /ru/administration/tracing/external-traces.md

ydb/docs/ru/core/administration/tracing/external-traces.md

github-actions · 2024-02-08T11:58:26Z

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (1)

⚠️ Incorrect syntax for notes, file /ru/administration/tracing/setup.md

github-actions · 2024-02-08T12:05:13Z

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (1)

⚠️ Incorrect syntax for notes, file /ru/administration/tracing/external-traces.md

github-actions · 2024-02-08T12:10:50Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-08T12:40:11Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-08T13:48:11Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-09T13:10:42Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-09T14:35:01Z

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ No such file or has no access to /ru/administration/tracing/sampling.md

github-actions · 2024-02-09T15:50:00Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-10T06:46:57Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-12T12:52:27Z

✅ Documentation build

Revision built successfully
Revision preview link

fomichev3000 · 2024-02-19T06:39:38Z

ydb/docs/ru/core/administration/tracing/setup.md

@@ -0,0 +1,155 @@
+# Настройка трассировки {{ ydb-short-name }}
+
+Для настройки трейсинга добавьте в конфигурацию (`cluster.yaml`) следующую секцию:


Это первый и единственный раздел про трассировку YDB. Я бы добавил вступление про трассировку вообще.

предпложение зачем нужна трассировка

ссылка на то, где с трассировкой можно подробнее ознкомиться (внешний ресурс)

мы поддерживаем open tracing? написать про это

Написал небольшое введение про трассировку

Добавил ссылку на соответствующий раздел opentelemetry

В следующей секции про минимальную настройку написал, что коллектор должен быть OTEL-совместимым

ydb/docs/ru/core/administration/tracing/setup.md

fomichev3000 · 2024-02-19T06:46:36Z

ydb/docs/ru/core/administration/tracing/setup.md

+
+{% endnote %}
+
+### External throttling


Не сказано, является ли секция обязательной. Если не обязательна, то какое поведение по умолчанию? Могу я вообще выключить external throttling.

Как в open telemetry называется "external throttling"?

Описал поведение по умолчанию. В open telemetry нет такого понятия, как throttling – только sampling

ydb/docs/ru/core/administration/tracing/setup.md

github-actions · 2024-02-27T15:09:52Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-27T16:42:19Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-28T06:45:09Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-28T07:09:12Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-28T08:17:32Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-02-28T08:30:17Z

✅ Documentation build

Revision built successfully
Revision preview link

fomichev3000 · 2024-03-01T07:56:45Z

ydb/docs/ru/core/administration/tracing/setup.md

+
+Для аггрегации разрозненных спанов в трассы они отправляются в *коллектор*. Это сервис, который аггрегирует и сохраняет получаемые спаны для последующего анализа трасс. {{ ydb-short-name }} не включает в себя этот сервис, администратор должен поднять его самостоятельно. Обычно в качестве коллектора используется [jaeger](https://www.jaegertracing.io/).
+
+Больше про трассировку вы можете прочитать в разделе [observability primer](https://opentelemetry.io/docs/concepts/observability-primer/) сайта opentelemetry.


"сайта opentelemetry" -- это не сайт. В том смысле, что сайт не указан. Я бы перенес ссылку в начало абзаца, а не в конец, там где дается определение трассировки. Там бы и сослался.

Перенес этот абзац в заметку в начало статьи

ydb/docs/ru/core/administration/tracing/setup.md

fomichev3000 · 2024-03-01T07:58:38Z

ydb/docs/ru/core/administration/tracing/setup.md

+
+## Полная конфигурация
+
+Пример более детальной настройки приведен ниже:


Нет явного рассказа про семплинг и external tracing. Это концептуальные вещи, про которые я бы явно писал.
В общем сложно интерпретировать пример без слов, когда видишь первый раз

Добавил в соответствующие секции краткое описание

ydb/docs/ru/core/administration/tracing/setup.md

fomichev3000 · 2024-03-01T08:30:24Z

ydb/docs/ru/core/administration/tracing/external-traces.md

@@ -0,0 +1,10 @@
+# Передача внешнего trace-id в {{ ydb-short-name }}


Не понятно из этого документа, мы трассируем любой внеший trace id? Как-то ограниченно?
На мой взгляд странно видеть в документации про трейсинг 2 статьи, одну общую, вторую про внешний трейсинг... Как-то не очень логично для меня...
И очень странно, что про внешний трейсинг в одной статье, а про его настройку в другой... не логично же

Логика тут такая: первая статья описывает трассировку с точки зрения администратора, вторая описывает трассировку с точки зрения разработчика. Наверное стоит тут сделать отсылку к ограничениям на внешние трассы и написать

Добавил в статью про передачу trace-id примечание о том, что могут трассироваться не все запросы

github-actions · 2024-03-05T06:24:25Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-03-06T10:31:28Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-03-06T10:45:32Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-03-06T10:57:55Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-04-03T10:25:27Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-04-03T11:32:37Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-04-03T11:45:09Z

✅ Documentation build

Revision built successfully
Revision preview link

github-actions · 2024-04-03T13:44:46Z

❌ Documentation build

Revision build failed

Build logs

Errors (5)

❌ Link is unreachable: ../../concepts/_includes/index/how_it_works.md#ydb-architecture in /ru/reference/observability/tracing/setup.md

❌ Link is unreachable: ../../deploy/configuration/config.md in /ru/reference/observability/tracing/setup.md

❌ Link is unreachable: ../../maintenance/embedded_monitoring/logs.md in /ru/reference/observability/tracing/setup.md

❌ Link is unreachable: ../../maintenance/manual/dynamic-config.md in /ru/reference/observability/tracing/setup.md

❌ Link is unreachable: ../../reference/ydb-sdk/recipes/debug-jaeger.md in /ru/reference/observability/tracing/external-traces.md

github-actions · 2024-04-03T14:00:26Z

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ Link is unreachable: ../../maintenance/manual/dynamic-config.md in /ru/reference/observability/tracing/setup.md

github-actions · 2024-04-03T14:05:11Z

✅ Documentation build

Revision built successfully
Revision preview link

domwst requested a review from a team as a code owner January 26, 2024 08:27

github-actions bot added the documentation Improvements or additions to documentation label Jan 26, 2024

domwst marked this pull request as draft January 26, 2024 08:27

blinkov reviewed Jan 29, 2024

View reviewed changes

ydb/docs/ru/core/administration/tracing/external-traces.md Outdated Show resolved Hide resolved

fomichev3000 requested changes Feb 19, 2024

View reviewed changes

domwst linked an issue Feb 20, 2024 that may be closed by this pull request

Write documentation on using tracing. #2004

Closed

domwst marked this pull request as ready for review February 28, 2024 08:27

fomichev3000 requested changes Mar 1, 2024

View reviewed changes

domwst added 11 commits April 3, 2024 10:19

Removed <code> formating

1a66fa3

Trying to make list work

0edc4bd

Typo fix

a543e10

Added

7dbb2a2

Added dot

dc215fe

Fixed some flaws

d666e79

Added several new references, added warning

54dc761

Fixed note

5da3871

Added snippets with configuration

94fbfad

Several issues fixed

2481e28

Added note on new behaviour of external_throttling

bd5db90

Removed complete configuration

83e9a8c

Changed tense

738fe78

Moved tracing docs to reference/observability

ada0741

Fixed links

03bbc9f

Fixed another link

b6dcac0

fomichev3000 approved these changes Apr 4, 2024

View reviewed changes

domwst merged commit 6c04abe into ydb-platform:main Apr 4, 2024

This was referenced Apr 6, 2024

Fix kafka read session verify #3522

Merged

Fix kafka read session partitions releases #3528

Merged

StekPerepolnen mentioned this pull request Apr 10, 2024

hc fallback when static group has unknown status #3620

Merged

shnikd mentioned this pull request Apr 11, 2024

Support create sequence #3662

Merged

serbel324 mentioned this pull request Apr 25, 2024

Introduce local SyncLog data cutter #4124

Merged

blinkov mentioned this pull request Jun 24, 2024

[docs] translate reference/observability/tracing #5865

Merged

		@@ -0,0 +1,155 @@
		# Настройка трассировки {{ ydb-short-name }}

		Для настройки трейсинга добавьте в конфигурацию (`cluster.yaml`) следующую секцию:


		Для аггрегации разрозненных спанов в трассы они отправляются в коллектор. Это сервис, который аггрегирует и сохраняет получаемые спаны для последующего анализа трасс. {{ ydb-short-name }} не включает в себя этот сервис, администратор должен поднять его самостоятельно. Обычно в качестве коллектора используется [jaeger](https://www.jaegertracing.io/).

		Больше про трассировку вы можете прочитать в разделе [observability primer](https://opentelemetry.io/docs/concepts/observability-primer/) сайта opentelemetry.


		## Полная конфигурация

		Пример более детальной настройки приведен ниже:

		@@ -0,0 +1,10 @@
		# Передача внешнего trace-id в {{ ydb-short-name }}

Tracing documentation #1331

Tracing documentation #1331

Uh oh!

Conversation

domwst commented Jan 26, 2024

Changelog entry

Changelog category

Additional information

Uh oh!

github-actions bot commented Jan 26, 2024

✅ Documentation build

Build logs

Warnings (1)

Uh oh!

github-actions bot commented Jan 29, 2024

✅ Documentation build

Build logs

Warnings (1)

Uh oh!

Uh oh!

github-actions bot commented Feb 8, 2024

✅ Documentation build

Build logs

Warnings (1)

Uh oh!

github-actions bot commented Feb 8, 2024

✅ Documentation build

Build logs

Warnings (1)

Uh oh!

github-actions bot commented Feb 8, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 8, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 8, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 9, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 9, 2024

❌ Documentation build

Build logs

Errors (1)

Uh oh!

github-actions bot commented Feb 9, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 10, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 12, 2024

✅ Documentation build

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Feb 27, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 27, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 28, 2024

✅ Documentation build

Uh oh!

github-actions bot commented Feb 28, 2024

✅ Documentation build

Uh oh!