Skip to content

[docs] Miscellaneous docs clean up #2604

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.

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 3 commits into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
478 changes: 0 additions & 478 deletions docs/docset.yml

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/reference/connecting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +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
:::{image} images/cloud_id.png
:alt: Cloud ID
:::

Expand All @@ -34,19 +34,19 @@ 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
:::{image} images/cloud_api_key.png
:alt: API key
:::

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
:::{image} images/api_key_name.png
:alt: Choose an API name
:::

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

:::{image} ../images/cloud_api_key.png
:::{image} images/cloud_api_key.png
:alt: API key
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ client = Elasticsearch::Client.new(

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

:::{image} ../images/es_endpoint.jpg
:::{image} images/es_endpoint.jpg
:alt: Finding Elasticsearch endpoint
:::

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

:::{image} ../images/create_api_key.png
:::{image} images/create_api_key.png
:alt: Create API key
:::

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
6 changes: 3 additions & 3 deletions docs/reference/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ 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
:::{image} images/otel-waterfall-without-http.png
:alt: Distributed trace with Elasticsearch spans
:class: screenshot
:::

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
:::{image} images/otel-waterfall-with-http.png
:alt: Distributed trace with Elasticsearch spans
:class: screenshot
:::

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
:::{image} images/otel-waterfall-retry.png
:alt: Distributed trace with Elasticsearch spans
:class: screenshot
:::
Expand Down
Loading