Skip to content

[docs] Fix image paths for docs-assembler #2654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025
Merged

[docs] Fix image paths for docs-assembler #2654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions docs/reference/connecting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ This document contains code snippets to show you how to connect to various {{es}

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.

:::{image} images/cloud_id.png
:alt: Cloud ID
:::
![Cloud ID](images/cloud_id.png)

Once you have collected the Cloud ID you can use the client to connect to your Elastic Cloud instance, as follows:

Expand All @@ -34,21 +32,15 @@ client = Elasticsearch::Client.new(

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`.

:::{image} images/cloud_api_key.png
:alt: API key
:::
![API key](images/cloud_api_key.png)

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

:::{image} images/api_key_name.png
:alt: Choose an API name
:::
![Choose an API name](images/api_key_name.png)

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

:::{image} images/cloud_api_key.png
:alt: API key
:::
![API key](images/cloud_api_key.png)

**IMPORTANT**: you need to copy and store the `API key` in a secure place, since you will not be able to view it again in Elastic Cloud.

Expand Down
8 changes: 2 additions & 6 deletions docs/reference/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,11 @@ client = Elasticsearch::Client.new(

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

:::{image} images/es_endpoint.jpg
:alt: Finding Elasticsearch endpoint
:::
![Finding Elasticsearch endpoint](images/es_endpoint.jpg)

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

:::{image} images/create_api_key.png
:alt: Create API key
:::
![Create API key](images/create_api_key.png)

For other connection options, refer to the [*Connecting*](/reference/connecting.md) section.

Expand Down
18 changes: 6 additions & 12 deletions docs/reference/opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,18 @@ You can use [OpenTelemetry](https://opentelemetry.io/) to monitor the performanc

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.

:::{image} images/otel-waterfall-without-http.png
:alt: Distributed trace with Elasticsearch spans
:class: screenshot
:::
% TO DO: Use `:class: screenshot`
![Distributed trace with Elasticsearch spans](images/otel-waterfall-without-http.png)

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

:::{image} images/otel-waterfall-with-http.png
:alt: Distributed trace with Elasticsearch spans
:class: screenshot
:::
% TO DO: Use `:class: screenshot`
![Distributed trace with Elasticsearch spans](images/otel-waterfall-with-http.png)

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:

:::{image} images/otel-waterfall-retry.png
:alt: Distributed trace with Elasticsearch spans
:class: screenshot
:::
% TO DO: Use `:class: screenshot`
![Distributed trace with Elasticsearch spans](images/otel-waterfall-retry.png)

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).

Expand Down