Skip to content

Commit 0fed45c

Browse files
authored
Merge pull request #1000 from colleenmcginnis/fix-images-when-assembled
[docs] Fix image paths for docs-assembler
2 parents 8c2c51d + 422a5d3 commit 0fed45c

File tree

2 files changed

+8
-18
lines changed

2 files changed

+8
-18
lines changed

docs/reference/getting-started.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,11 @@ esClient.close();
6767

6868
Your Elasticsearch endpoint can be found on the **My deployment** page of your deployment:
6969

70-
:::{image} images/es-endpoint.jpg
71-
:alt: Finding Elasticsearch endpoint
72-
:::
70+
![Finding Elasticsearch endpoint](images/es-endpoint.jpg)
7371

7472
You can generate an API key on the **Management** page under Security.
7573

76-
:::{image} images/create-api-key.png
77-
:alt: Create API key
78-
:::
74+
![Create API key](images/create-api-key.png)
7975

8076
For other connection options, refer to the [Connecting](setup/connecting.md) section.
8177

docs/reference/setup/opentelemetry.md

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

1010
The native instrumentation in the Java API 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 Java API Client. The following image shows a trace that records the handling of three different {{es}} requests: an `index`, `get` and a search `request`:
1111

12-
:::{image} ../images/otel-waterfall-instrumented-without-http.jpg
13-
:alt: Distributed trace with {{es}} spans
14-
:class: screenshot
15-
:::
12+
% TO DO: Use `:class: screenshot`
13+
![Distributed trace with {{es}} spans](../images/otel-waterfall-instrumented-without-http.jpg)
1614

1715
Usually, OpenTelemetry agents and 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):
1816

19-
:::{image} ../images/otel-waterfall-instrumented.jpg
20-
:alt: Distributed trace with {{es}} and HTTP spans
21-
:class: screenshot
22-
:::
17+
% TO DO: Use `:class: screenshot`
18+
![Distributed trace with {{es}} and HTTP spans](../images/otel-waterfall-instrumented.jpg)
2319

2420
Advanced Java API 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 an `index` request in a scenario with two {{es}} nodes:
2521

26-
:::{image} ../images/otel-waterfall-retries.jpg
27-
:alt: Distributed trace with request retries
28-
:class: screenshot
29-
:::
22+
% TO DO: Use `:class: screenshot`
23+
![Distributed trace with request retries](../images/otel-waterfall-retries.jpg)
3024

3125
The first node is unavailable and results in an HTTP error, while the retry to the second node succeeds. Both HTTP requests are subsumed by the logical {{es}} request span (in blue).
3226

0 commit comments

Comments
 (0)