Skip to content

Commit ad5c821

Browse files
[docs] Miscellaneous docs clean up (#2853) (#2884)
* remove unused substitutions * move images (cherry picked from commit 5d7db56) Co-authored-by: Colleen McGinnis <[email protected]>
1 parent 901dbc3 commit ad5c821

8 files changed

+5
-483
lines changed

Diff for: docs/docset.yml

-478
Large diffs are not rendered by default.

Diff for: docs/reference/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ client = Elasticsearch(
4141

4242
Your Elasticsearch endpoint can be found on the **My deployment** page of your deployment:
4343

44-
:::{image} ../images/es-endpoint.jpg
44+
:::{image} images/es-endpoint.jpg
4545
:alt: Finding Elasticsearch endpoint
4646
:::
4747

4848
You can generate an API key on the **Management** page under Security.
4949

50-
:::{image} ../images/create-api-key.png
50+
:::{image} images/create-api-key.png
5151
:alt: Create API key
5252
:::
5353

File renamed without changes.
File renamed without changes.

Diff for: docs/reference/opentelemetry.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ You can use [OpenTelemetry](https://opentelemetry.io/) to monitor the performanc
99

1010
The native instrumentation in the Python client follows the [OpenTelemetry Semantic Conventions for {{es}}](https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/). In particular, the instrumentation in the client covers the logical layer of {{es}} requests. A single span per request is created that is processed by the service through the Python client. The following image shows a trace that records the handling of two different {{es}} requests: an `info` request and a `search` request.
1111

12-
:::{image} ../images/otel-waterfall-without-http.png
12+
:::{image} images/otel-waterfall-without-http.png
1313
:alt: Distributed trace with Elasticsearch spans
1414
:class: screenshot
1515
:::
1616

1717
Usually, OpenTelemetry auto-instrumentation modules come with instrumentation support for HTTP-level communication. In this case, in addition to the logical {{es}} client requests, spans will be captured for the physical HTTP requests emitted by the client. The following image shows a trace with both, {{es}} spans (in blue) and the corresponding HTTP-level spans (in red) after having installed the ``opentelemetry-instrumentation-urllib3`` package:
1818

19-
:::{image} ../images/otel-waterfall-with-http.png
19+
:::{image} images/otel-waterfall-with-http.png
2020
:alt: Distributed trace with Elasticsearch spans
2121
:class: screenshot
2222
:::
2323

2424
Advanced Python client behavior such as nodes round-robin and request retries are revealed through the combination of logical {{es}} spans and the physical HTTP spans. The following example shows a `search` request in a scenario with two nodes:
2525

26-
:::{image} ../images/otel-waterfall-retry.png
26+
:::{image} images/otel-waterfall-retry.png
2727
:alt: Distributed trace with Elasticsearch spans
2828
:class: screenshot
2929
:::

0 commit comments

Comments
 (0)