Skip to content

chore: update ruby deps #4366

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 2 commits into from
Jul 29, 2024
Merged

chore: update ruby deps #4366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92afd32
chore: update ruby deps
Jul 29, 2024
092fab0
Merge branch 'main' into mat-rumian-update-ruby-docs
mat-rumian Jul 29, 2024
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
26 changes: 13 additions & 13 deletions .../get-started-transaction-tracing/opentelemetry-instrumentation/ruby-on-rails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn how to collect telemetry data from Ruby on Rails applications

[Opentelemetry-Ruby](https://github.com/open-telemetry/opentelemetry-ruby) gives the possibility to obtain telemetry data from Ruby on Rails (RoR) applications by adding a few lines of code to your project.

There are a few simple steps to instrument the application and export the telemetry data by [OpenTelemetry Protocol exporter](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.26.3/exporter/otlp).
There are a few simple steps to instrument the application and export the telemetry data by [OpenTelemetry Protocol exporter](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.28.1/exporter/otlp).

## Step 1. OpenTelemetry dependencies installation

Expand All @@ -16,15 +16,15 @@ Installation of the packages listed below is required to apply the instrumentati
* **gem** command:

```bash
gem install opentelemetry-sdk -v 1.4.0
gem install opentelemetry-exporter-otlp -v 0.26.3
gem install opentelemetry-sdk -v 1.5.0
gem install opentelemetry-exporter-otlp -v 0.28.1
```

* **bundler**, the packages have to be inserted into your **gemfile** and the **bundle install** command has to be run:

```bash
gem 'opentelemetry-sdk', '1.4.0'
gem 'opentelemetry-exporter-otlp', '0.26.3'
gem 'opentelemetry-sdk', '1.5.0'
gem 'opentelemetry-exporter-otlp', '0.28.1'
```

Installation of the gems above is mandatory. The next step is to install instrumentation packages corresponding to the libraries used in the application. A complete list of available plugins can be found [here](https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation).
Expand All @@ -34,19 +34,19 @@ There are two solutions:
* Installation of the specific package - for example, if the application is a **Rails** Web server that is also performing some database queries using **MySQL** package. To get traces from libraries used in the project, corresponding instrumented packages have to be installed:

```bash
gem install opentelemetry-instrumentation-rails -v 0.30.0
gem install opentelemetry-instrumentation-rails -v 0.31.1
gem install opentelemetry-instrumentation-action_pack -v 0.9.0
gem install opentelemetry-instrumentation-action_view -v 0.7.0
gem install opentelemetry-instrumentation-active_job -v 0.7.1
gem install opentelemetry-instrumentation-active_model_serializers -v 0.20.1
gem install opentelemetry-instrumentation-active_record -v 0.7.0
gem install opentelemetry-instrumentation-mysql2 -v 0.27.0
gem install opentelemetry-instrumentation-action_view -v 0.7.1
gem install opentelemetry-instrumentation-active_job -v 0.7.3
gem install opentelemetry-instrumentation-active_model_serializers -v 0.20.2
gem install opentelemetry-instrumentation-active_record -v 0.7.2
gem install opentelemetry-instrumentation-mysql2 -v 0.27.2
```

* Installation of the "all in one" package - installing this package will install all available instrumentation packages:

```bash
gem install opentelemetry-instrumentation-all -v 0.60.0
gem install opentelemetry-instrumentation-all -v 0.62.1
```

## Step 2. Code changes
Expand Down Expand Up @@ -86,7 +86,7 @@ To enable instrumentation in the Ruby on Rails application and export the teleme

## Step 3. Telemetry data exporter configuration

The final step is to configure the exporter host, service and application name. This can be done [directly in the code](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.26.3/exporter/otlp#how-do-i-get-started) or by environment variables. In this example, the exporter will be configured by environment variables.
The final step is to configure the exporter host, service and application name. This can be done [directly in the code](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.28.1/exporter/otlp#how-do-i-get-started) or by environment variables. In this example, the exporter will be configured by environment variables.

* `OTEL_EXPORTER=otlp` - environment variable sets the exporter to OTLP.

Expand Down
18 changes: 9 additions & 9 deletions ...pm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Obtaining telemetry data from applications written in Ruby has never been eas

## How to instrument your Ruby application?

There are a few simple steps to instrument the application and export the telemetry data by [OpenTelemetry Protocol exporter](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.26.3/exporter/otlp) - **version sdk=1.4.0, exporter=0.26.3**.
There are a few simple steps to instrument the application and export the telemetry data by [OpenTelemetry Protocol exporter](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.28.1/exporter/otlp) - **version sdk=1.5.0, exporter=0.28.1**.

## Step 1. Gems Installation

Expand All @@ -18,15 +18,15 @@ Installation of the packages listed below is required to apply the instrumentati
* **gem** command

```bash
gem install opentelemetry-sdk -v 1.4.0
gem install opentelemetry-exporter-otlp -v 0.26.3
gem install opentelemetry-sdk -v 1.5.0
gem install opentelemetry-exporter-otlp -v 0.28.1
```

* **bundler**, the packages have to be inserted into your **gemfile** and **bundle install** command has to be run

```bash
gem 'opentelemetry-sdk', '1.4.0'
gem 'opentelemetry-exporter-otlp', '0.26.3'
gem 'opentelemetry-sdk', '1.5.0'
gem 'opentelemetry-exporter-otlp', '0.28.1'
```

Installation of the gems above is mandatory. The next step is to install instrumentation packages corresponding to the libraries used in the application. A complete list of available plugins can be found [here](https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation).
Expand All @@ -36,14 +36,14 @@ There are two solutions:
* Installation of the specific packages - for example, if the application is a **Sinatra** HTTP server which is also performing some HTTP requests using **Net HTTP** package. To instrument all the incoming and outgoing requests corresponding instrumented packages have to be installed:

```bash
gem install opentelemetry-instrumentation-sinatra -v 0.23.2
gem install opentelemetry-instrumentation-net_http -v 0.22.4
gem install opentelemetry-instrumentation-sinatra -v 0.24.1
gem install opentelemetry-instrumentation-net_http -v 0.22.7
```

* Installation of the “all in one” package - installing this package will install all available instrumentation packages:

```bash
gem install opentelemetry-instrumentation-all -v 0.60.0
gem install opentelemetry-instrumentation-all -v 0.62.1
```

## Step 2. Required code changes
Expand Down Expand Up @@ -73,7 +73,7 @@ To enable instrumentation in the application and export the telemetry data it is

## Step 3. Telemetry data exporter configuration

The final step is to configure the exporter host and service name. This can be done [directly in the code](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.26.3/exporter/otlp#how-do-i-get-started) or by environment variables. In this example, the exporter will be configured by environment variables.
The final step is to configure the exporter host and service name. This can be done [directly in the code](https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-exporter-otlp/v0.28.1/exporter/otlp#how-do-i-get-started) or by environment variables. In this example, the exporter will be configured by environment variables.

* Environment variable sets the exporter to OTLP:

Expand Down