Skip to content

Commit a92443b

Browse files
authored
Merge pull request #965 from colleenmcginnis/docs-clean-up
[docs] Miscellaneous docs clean up
2 parents 2ee59ee + 4d32262 commit a92443b

9 files changed

+6
-482
lines changed

docs/docset.yml

Lines changed: 0 additions & 476 deletions
Large diffs are not rendered by default.

docs/reference/building-objects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ CreateIndexResponse createResponse = client.indices()
5555
);
5656
```
5757

58-
Builder lambdas become particularly useful with complex nested queries like the one below, taken from the [intervals query API documentation](elasticsearch://reference/query-languages/query-dsl-intervals-query.md).
58+
Builder lambdas become particularly useful with complex nested queries like the one below, taken from the [intervals query API documentation](elasticsearch://reference/query-languages/query-dsl/query-dsl-intervals-query.md).
5959

6060
This example also highlights a useful naming convention for builder parameters in deeply nested structures. For lambda expressions with a single argument, Kotlin provides the implicit `it` parameter and Scala allows use of `_`. This can be approximated in Java by using an underscore or a single letter prefix followed by a number representing the depth level (i.e. `_0`, `_1`, or `b0`, `b1` and so on). Not only does this remove the need to create throw-away variable names, but it also improves code readability. Correct indentation also allows the structure of the query to stand out.
6161

docs/reference/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,13 @@ esClient.close();
8686

8787
Your Elasticsearch endpoint can be found on the **My deployment** page of your deployment:
8888

89-
:::{image} ../images/es-endpoint.jpg
89+
:::{image} images/es-endpoint.jpg
9090
:alt: Finding Elasticsearch endpoint
9191
:::
9292

9393
You can generate an API key on the **Management** page under Security.
9494

95-
:::{image} ../images/create-api-key.png
95+
:::{image} images/create-api-key.png
9696
:alt: Create API key
9797
:::
9898

File renamed without changes.

docs/reference/opentelemetry.md

Lines changed: 3 additions & 3 deletions
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 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
12+
:::{image} images/otel-waterfall-instrumented-without-http.jpg
1313
:alt: Distributed trace with {{es}} spans
1414
:class: screenshot
1515
:::
1616

1717
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):
1818

19-
:::{image} ../images/otel-waterfall-instrumented.jpg
19+
:::{image} images/otel-waterfall-instrumented.jpg
2020
:alt: Distributed trace with {{es}} and HTTP spans
2121
:class: screenshot
2222
:::
2323

2424
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:
2525

26-
:::{image} ../images/otel-waterfall-retries.jpg
26+
:::{image} images/otel-waterfall-retries.jpg
2727
:alt: Distributed trace with request retries
2828
:class: screenshot
2929
:::

0 commit comments

Comments
 (0)