change gem name

Author: xuan-cao-swi

zero-code-instrumentation/.rubocop.yml renamed to opentelemetry-auto-instrumentation/.rubocop.yml

@@ -0,0 +1 @@
+# Release History: opentelemetry-auto-instrumentation

opentelemetry-auto-instrumentation/CHANGELOG.md

@@ -1,6 +1,6 @@
-# Zero-code Instrumentation
+# Opentelemetry Auto Instrumentation
 
-The `zero-code-instrumentation` gem provides an easy way to load and initialize opentelemetry-ruby for zero-code instrumentation.
+The `opentelemetry-auto-instrumentation` gem provides an easy way to load and initialize opentelemetry-ruby for zero-code instrumentation.
 
 ## What is OpenTelemetry?
 
@@ -10,19 +10,19 @@ OpenTelemetry provides a single set of APIs, libraries, agents, and collector se
 
 ## How does this gem fit in?
 
-The `zero-code-instrumentation` gem provides an easy way to load and initialize the OpenTelemetry Ruby SDK without changing your code initialize the SDK. This gem is particularly used with the [OpenTelemetry Operator][opentelemetry-operator].
+The `opentelemetry-auto-instrumentation` gem provides an easy way to load and initialize the OpenTelemetry Ruby SDK without changing your code initialize the SDK. This gem is particularly used with the [OpenTelemetry Operator][opentelemetry-operator].
 
 ## How do I get started?
 
-It's recommended to install this gem through gem install rather than Bundler since it doesn't require modifying any user's codebase (including the Gemfile).
+It's recommended to install this gem through `gem install` rather than Bundler since it doesn't require modifying your codebase (including the Gemfile).
 
 Install the gem using:
 
 ```console
-gem install zero-code-instrumentation
+gem install opentelemetry-auto-instrumentation
 ```
 
-Install zero-code-instrumentation will automatically install following gems:
+Installing opentelemetry-auto-instrumentation will automatically install following gems:
 ```console
 opentelemetry-sdk
 opentelemetry-api
@@ -38,7 +38,7 @@ opentelemetry-resource-detector-container
 Instrument your application:
 
 ```console
-RUBYOPT="-r zero-code-instrumentation" ruby application.rb
+RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
 ```
 
 Instrument your application with additional environment variables:
@@ -49,75 +49,75 @@ export OTEL_EXPORTER_OTLP_ENDPOINT="your-endpoint"
 export OTEL_RUBY_RESOURCE_DETECTORS="container"
 export OTEL_SERVICE_NAME="your-service-name"
 
-RUBYOPT="-r zero-code-instrumentation" ruby application.rb
+RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
 ```
 
 Instrument your application with disabling certain instrumentation (e.g. sinatra):
 
 ```console
 export OTEL_RUBY_INSTRUMENTATION_SINATRA_ENABLED='false'
-RUBYOPT="-r zero-code-instrumentation" ruby application.rb
+RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
 ```
 
 Instrument your application with only certain instrumentation installed (e.g. mysql, redis):
 
 ```console
 export OTEL_RUBY_ENABLED_INSTRUMENTATIONS='mysql2,redis'
-RUBYOPT="-r zero-code-instrumentation" ruby application.rb
+RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
 ```
 
 Instrument your application with only redis and configure its options:
 
 ```console
 export OTEL_RUBY_ENABLED_INSTRUMENTATIONS='redis'
 export OTEL_RUBY_INSTRUMENTATION_REDIS_CONFIG_OPTS='peer_service=new_service;db_statement=omit'
-RUBYOPT="-r zero-code-instrumentation" ruby application.rb
+RUBYOPT="-r opentelemetry-auto-instrumentation" ruby application.rb
 ```
 
 Instrument Rails application:
 
 ```console
-RUBYOPT="-r zero-code-instrumentation" rails server
+RUBYOPT="-r opentelemetry-auto-instrumentation" rails server
 ```
 
-Instrument Rails application with `bundle exec`
+Instrument Rails application with `bundle exec`:
 
-Since installing the `zero-code-instrumentation` gem through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.
+Since installing the `opentelemetry-auto-instrumentation` gem through `gem install`, anything related to the OpenTelemetry gem won't be stored in Bundler's gem path. Therefore, users need to add an additional gem path that contains these gems prior to initialization.
 
 ```console
-RUBYOPT="-r {PUT YOUR GEM PATH}/gems/zero-code-instrumentation-0.1.0/lib/zero-code-instrumentation" bundle exec rails server
+RUBYOPT="-r {PUT YOUR GEM PATH}/gems/opentelemetry-auto-instrumentation-0.1.0/lib/opentelemetry-auto-instrumentation" bundle exec rails server
 ```
 
 Instrument Sinatra application with rackup:
 
-If you are using a Gemfile to install the required gems but without `Bundler.require`, set `REQUIRE_BUNDLER` to true. This way, `zero-code-instrumentation` will call `Bundler.require` to initialize the required gems prior to SDK initialization.
+If you are using a Gemfile to install the required gems but without `Bundler.require`, set `REQUIRE_BUNDLER` to true. This way, `opentelemetry-auto-instrumentation` will call `Bundler.require` to initialize the required gems prior to SDK initialization.
 
 ```console
 export REQUIRE_BUNDLER=true
-RUBYOPT="-r zero-code-instrumentation" rackup config.ru
+RUBYOPT="-r opentelemetry-auto-instrumentation" rackup config.ru
 ```
 
-If you wish to load some gems outside the Gemfile, then they need to be placed in front of zero-code-instrumentation:
+If you wish to load some gems outside the Gemfile, then they need to be placed in front of opentelemetry-auto-instrumentation:
 
 ```console
 export BUNDLE_WITHOUT=development,test
 gem install mysql2
-RUBYOPT="-r mysql2 -r zero-code-instrumentation" ruby application.rb
+RUBYOPT="-r mysql2 -r opentelemetry-auto-instrumentation" ruby application.rb
 ```
 
 ## Example
 
 In example folder, executing the following commands should result in trace output.
 
 ```console
-# if the user doesn't want to install zero-code-instrumentation from rubygems.org
+# if the user doesn't want to install opentelemetry-auto-instrumentation from rubygems.org
 # the user can build the gem and install it with gem install *.gem
 
-gem install zero-code-instrumentation
+gem install opentelemetry-auto-instrumentation
 bundle install
 export REQUIRE_BUNDLER=true
 export OTEL_TRACES_EXPORTER=console
-RUBYOPT="-r zero-code-instrumentation" ruby app.rb
+RUBYOPT="-r opentelemetry-auto-instrumentation" ruby app.rb
 ```
 
 ## Configuration
@@ -127,7 +127,7 @@ These environment variables are not standard OpenTelemetry environment variables
 | Environment Variable | Description | Default | Example |
 |----------------------|-------------|---------|---------|
 | `OTEL_RUBY_REQUIRE_BUNDLER` | Set to `true` if you are using Bundler to install gems but without `Bundler.require` in your script during initialization. | nil | N/A |
-| `OTEL_RUBY_ADDITIONAL_GEM_PATH` | Intended to be used for the OpenTelemetry Operator environment if you install `zero-code-instrumentation` to a customized path. | nil | N/A |
+| `OTEL_RUBY_ADDITIONAL_GEM_PATH` | Intended to be used for the OpenTelemetry Operator environment if you install `opentelemetry-auto-instrumentation` to a customized path. | nil | N/A |
 | `OTEL_RUBY_OPERATOR` | Set to `true` to set the binding path for the OpenTelemetry Operator. | `/otel-auto-instrumentation-ruby` | N/A |
 | `OTEL_RUBY_RESOURCE_DETECTORS` | Determine what kind of resource detector is needed. Currently supports `container`, `azure`, and `google_cloud_platform`. Use commas to separate multiple detectors. | nil | `container,azure` |
 | `OTEL_RUBY_ENABLED_INSTRUMENTATIONS` | Shortcut used when you only want to instrument one or a couple of particular libraries. | nil | `redis,active_record` |
@@ -136,13 +136,13 @@ These environment variables are not standard OpenTelemetry environment variables
 
 ## How can I get involved?
 
-The `zero-code-instrumentation` gem source is on GitHub, along with related gems.
+The `opentelemetry-auto-instrumentation` gem source is on GitHub, along with related gems.
 
 The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
-The `zero-code-instrumentation` gem is distributed under the Apache 2.0 license. See LICENSE for more information.
+The `opentelemetry-auto-instrumentation` gem is distributed under the Apache 2.0 license. See LICENSE for more information.
 
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings