Simplify Ruby example

getting-started-guides/ruby/instrumented/Gemfile.lock → getting-started-guides/ruby/Gemfile.lock

@@ -217,6 +217,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-22
   x86_64-linux
 

getting-started-guides/ruby/README.md

@@ -0,0 +1,43 @@
+# Getting Started Guide - Ruby
+
+This is a simple application instrumented with [OpenTelemetry Ruby](https://github.com/open-telemetry/opentelemetry-ruby).
+It demonstrates how to configure OpenTelemetry Ruby to send data to New Relic.
+
+## Requirements
+
+* [Ruby 3.2.2](https://www.ruby-lang.org/en)
+* [A New Relic account](https://one.newrelic.com/)
+* [A New Relic license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#license-key)
+
+## Running the application
+
+1. Set the following environment variables to configure OpenTelemetry to send
+   data to New Relic:
+
+    ```shell
+    export OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.nr-data.net
+    export OTEL_EXPORTER_OTLP_HEADERS=api-key=<your_license_key>
+    export OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT=4095
+    export OTEL_SERVICE_NAME=getting-started-ruby
+    export OTEL_RESOURCE_ATTRIBUTES=service.instance.id=123
+    ```
+
+    * If your account is based in the EU, set the endpoint to: [https://otlp.eu01.nr-data.net](https://otlp.eu01.nr-data.net)
+
+2. Run the following command to install dependencies:
+
+    ```shell
+    bundle install
+    ```
+
+3. Run the application with the following command and open
+   [http://localhost:8080/fibonacci?n=1](http://localhost:8080/fibonacci?n=1)
+   in your web browser to ensure it is working.
+
+    ```shell
+    bundle exec rackup
+    ```
+
+4. Experiment with providing different values for `n` in the query string.
+   Valid values are between 1 and 90. Values outside this range cause an error
+   which will show up in New Relic.