Skip to content

Commit e58f463

Browse files
authoredMar 25, 2025
[docs] Miscellaneous docs clean up (#2604)
* remove unused substitutions * move images * fix image path
1 parent 61149f7 commit e58f463

12 files changed

+9
-487
lines changed
 

‎docs/docset.yml

-478
Large diffs are not rendered by default.

‎docs/reference/connecting.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This document contains code snippets to show you how to connect to various {{es}
1616

1717
If you are using [Elastic Cloud](https://www.elastic.co/cloud), the client offers an easy way to connect to it. You need the Cloud ID that you can find in the cloud console, then your username and password.
1818

19-
:::{image} ../images/cloud_id.png
19+
:::{image} images/cloud_id.png
2020
:alt: Cloud ID
2121
:::
2222

@@ -34,19 +34,19 @@ client = Elasticsearch::Client.new(
3434

3535
You can also connect to the Cloud by using API Key authentication. You can generate an `API key` in the `Management` page under the section `Security`.
3636

37-
:::{image} ../images/cloud_api_key.png
37+
:::{image} images/cloud_api_key.png
3838
:alt: API key
3939
:::
4040

4141
When you click on `Create API key` you can choose a name and set the other options (eg. restrict privileges, expire after time, etc).
4242

43-
:::{image} ../images/api_key_name.png
43+
:::{image} images/api_key_name.png
4444
:alt: Choose an API name
4545
:::
4646

4747
After this step you will get the `API key` in the API keys page.
4848

49-
:::{image} ../images/cloud_api_key.png
49+
:::{image} images/cloud_api_key.png
5050
:alt: API key
5151
:::
5252

‎docs/reference/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ client = Elasticsearch::Client.new(
3838

3939
Your Elasticsearch endpoint can be found on the **My deployment** page of your deployment:
4040

41-
:::{image} ../images/es_endpoint.jpg
41+
:::{image} images/es_endpoint.jpg
4242
:alt: Finding Elasticsearch endpoint
4343
:::
4444

4545
You can generate an API key on the **Management** page under Security.
4646

47-
:::{image} ../images/create_api_key.png
47+
:::{image} images/create_api_key.png
4848
:alt: Create API key
4949
:::
5050

File renamed without changes.
File renamed without changes.
File renamed without changes.

‎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 Ruby 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 Ruby Client. The following image shows a trace that records the handling of two different {{es}} requests: a `ping` 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):
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 Ruby 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)