added lib/bootstrap.rb #2635
added lib/bootstrap.rb #2635
Conversation
Introduce `lib/bootstrap.rb` to offer bootstrapping functionality for those users who wish to introduce the New Relic agent to a Ruby application without altering the app's `Gemfile` manifest. Testing instructions: 1. Clone the feature branch 2. Create a brand new Rails app: ```shell rails new railsapp ``` 3. Use RUBYOPT to point to the bootstrap file (NOTE that the .rb extension is dropped here) and boot the Rails app: ```shell RUBYOPT='-r /path/to/clone/lib/bootstrap' railsapp/bin/rails server ``` 4. Now examine `railsapp/log` to confirm that it contains a `newrelic_agent.log` file with indications that Rails library instrumentation took place.
fallwith
requested review from
hannahramadan,
kaylareopelle and
tannalynn
as code owners
added header
lib/bootstrap.rb
Outdated
| # Instructions: | ||
| # - First, make sure the New Relic Ruby agent exists on disk. For these | ||
| # instructions, we'll assume the agent exists at `/newrelic`. | ||
| # - The agent can be downloaded as the "newrelic_rpm" gem from RubyGems.org | ||
| # and unpacked with "gem unpack" | ||
| # - The agent can be cloned from the New Relic public GitHub repo: | ||
| # https://github.com/newrelic/newrelic-ruby-agent | ||
| # - Next, use the "RUBYOPT" environment variable to require ("-r") this | ||
| # file (note that the ".rb" extension is dropped): | ||
| # ``` | ||
| # export RUBYOPT="-r /newrelic/lib/bootstrap" | ||
| # ``` | ||
| # - Launch an existing Ruby app as usual. For a Ruby on Rails app, this might | ||
| # involve running `bin/rails server`. | ||
| # - In the Ruby app's directory, look for and inspect | ||
| # `log/newrelic_agent.log`. If this file exists and there are no "WARN" or | ||
| # "ERROR" entries within it, then the agent was successfully introduced to | ||
| # the Ruby application. |
There was a problem hiding this comment.
Love these instructions. Does someone also need to pass a license key? If so, should that be called out here?
There was a problem hiding this comment.
At some point a license key and some required configs are needed... but I'm not sure we want to encourage independent use of introducing the agent in this way quite yet. We actually talked about gating this behind an env var.
But on the other hand, these instructions get you 90% of the way towards a working agent, so might as well include the final steps.
I think I'd like to add both a disclaimer: NOTE: introducing the agent into your application via bootstrap is in beta., as well as the final steps for a working agent (license key and config file).
What do you think?
There was a problem hiding this comment.
that sounds great! on the beta line, maybe append something like "use at your own risk"
i'm not sure if you necessarily need a config file to make the agent work since almost everything can be set by env vars. i think it will just fall back to defaults, but i'm not certain.
There was a problem hiding this comment.
Oh you're totally right. You'll still get a WARN about a missing config, but things seem to work
| def self.check_for_require | ||
| warn_and_exit "#{__FILE__} is meant to be required, not invoked directly" if $PROGRAM_NAME == __FILE__ | ||
| end |
Co-authored-by: Kayla Reopelle (she/her) <87386821+kaylareopelle@users.noreply.github.com>
SimpleCov Report
|
Introduce
lib/bootstrap.rbto offer bootstrapping functionality for those users who wish to introduce the New Relic agent to a Ruby application without altering the app'sGemfilemanifest.Testing instructions:
Clone the feature branch
Create a brand new Rails app:
RUBYOPT='-r /path/to/clone/lib/bootstrap' railsapp/bin/rails serverrailsapp/logto confirm that it contains anewrelic_agent.logfile with indications that Rails library instrumentation took place.