Version 5.0.0 of the gem is not published

[cody-collins]

I don't see it here https://rubygems.org/gems/appoptics_apm

And when updating it in my Gemfile with gem 'appoptics_apm', '5.0.0' and trying bundle install I am getting:

bundler install
Fetching gem metadata from https://rubygems.org/.........
Could not find gem 'appoptics_apm (= 5.0.0)' in rubygems repository https://rubygems.org/ or installed
locally.

The source contains the following gems matching 'appoptics_apm':
  * appoptics_apm-4.0.1-x86_64-linux
  * appoptics_apm-4.0.2
  * appoptics_apm-4.0.3
  * appoptics_apm-4.0.4
  * appoptics_apm-4.0.5
  * appoptics_apm-4.0.6
  * appoptics_apm-4.0.7
  * appoptics_apm-4.0.8
  * appoptics_apm-4.0.9
  * appoptics_apm-4.1.0
  * appoptics_apm-4.1.1
  * appoptics_apm-4.1.2
  * appoptics_apm-4.2.0
  * appoptics_apm-4.2.1
  * appoptics_apm-4.2.2
  * appoptics_apm-4.2.3
  * appoptics_apm-4.2.4
  * appoptics_apm-4.2.5
  * appoptics_apm-4.2.6
  * appoptics_apm-4.2.7
  * appoptics_apm-4.3.0
  * appoptics_apm-4.3.1
  * appoptics_apm-4.4.0
  * appoptics_apm-4.4.1
  * appoptics_apm-4.5.0
  * appoptics_apm-4.5.1
  * appoptics_apm-4.5.2
  * appoptics_apm-4.6.0
  * appoptics_apm-4.7.0
  * appoptics_apm-4.8.0
  * appoptics_apm-4.8.1
  * appoptics_apm-4.8.2
  * appoptics_apm-4.8.3
  * appoptics_apm-4.8.4
  * appoptics_apm-4.9.0
  * appoptics_apm-4.10.0
  * appoptics_apm-4.10.1
  * appoptics_apm-4.11.0
  * appoptics_apm-4.11.1
  * appoptics_apm-4.11.2
  * appoptics_apm-4.12.0
  * appoptics_apm-4.12.1
  * appoptics_apm-4.12.2
  * appoptics_apm-4.13.0

[cheempz]

Hi @cody-collins, thanks for using AppOptics! We are actively migrating customers to the new SolarWinds Observability platform and indeed there is no appoptics_apm v5.0.0--instead it was published as solarwinds_apm and the new project repository is https://github.com/solarwinds/apm-ruby.

Please take a look at the migration documentation, especially for Ruby. Happy to work with you on transitioning to our OpenTelemetry-based Ruby custom distro and the feature-rich SolarWinds Observability platform, feel free to reach out to support or ping me via email lin.lin@solarwinds.com.

[cody-collins]

@cheempz I am using Heroku and the appoptics addon. Does the new repository work for this?

[cheempz]

I see @cody-collins. Unfortunately SolarWinds Observability currently doesn't support Heroku... is it possible for you to stay at the current version of appoptics_apm?

[cody-collins]

@cheempz Currently using version 4.13.0, however there is a bug related to a Rails deprecation. connection_config is deprecated in favor of connection_db_config and removed in Rails 7. In the appoptics code, it does a check to see if connection_db_config is available here and here in v4.13.0 but it returns false when it needs to return true.

[cheempz]

Thanks for the explanation and PR @cody-collins! Let me see if we can actually make a 4.13.1 patch release. The CI/CD machinery is rusty but your contrib is very motivating ;)

Another option: the solarwinds_apm gem can actually be configured to report to AppOptics--it would require explicitly setting the collector endpoint and service key, wondering if that's something you're amenable to trying.

Also, do you mind sharing which heroku AO addon features you use?

[cody-collins]

Thanks for the explanation and PR @cody-collins! Let me see if we can actually make a 4.13.1 patch release. The CI/CD machinery is rusty but your contrib is very motivating ;)

Another option: the solarwinds_apm gem can actually be configured to report to AppOptics--it would require explicitly setting the collector endpoint and service key, wondering if that's something you're amenable to trying.

Also, do you mind sharing which heroku AO addon features you use?

It would be great if a 4.13.1 patch release could be made for short-term, and I could try moving to the new gem as a future step, since it sounds like the appoptics_apm gem is no longer going to be maintained.

I use most of the pre-defined Heroku dashboards, and a couple threshold alerts for response time and database connections.

[cody-collins]

Until it is addressed in this repo, I was trying to use a fork and point to it in my Gemfile with the line gem 'appoptics_apm', git: 'https://github.com/zearn/appoptics-apm-ruby', tag: '4.13.1'. However, when deploying to Heroku, the build log is showing the below error. Any ideas why pointing to a repo directly does not work? I see here that it might be something related to a missing C extension. Is there another step I need to include that in the gem?

       E, [2024-12-12T18:55:24.517573 #2619] ERROR -- : ==============================================================
       E, [2024-12-12T18:55:24.517637 #2619] ERROR -- : Missing AppOpticsAPM libraries.  Tracing disabled.
       E, [2024-12-12T18:55:24.517653 #2619] ERROR -- : Error: cannot load such file -- /tmp/build_2b2fcb06/vendor/bundle/ruby/3.2.0/bundler/gems/appoptics-apm-ruby-3b90ea1d778d/lib/libappoptics_apm.so
       E, [2024-12-12T18:55:24.517665 #2619] ERROR -- : See: https://docs.appoptics.com/kb/apm_tracing/ruby/
       E, [2024-12-12T18:55:24.517673 #2619] ERROR -- : ==============================================================
       W, [2024-12-12T18:55:24.521319 #2619]  WARN -- : ==============================================================
       W, [2024-12-12T18:55:24.521347 #2619]  WARN -- : AppOpticsAPM not loaded. Tracing disabled.
       W, [2024-12-12T18:55:24.521354 #2619]  WARN -- : There may be a problem with the service key or other settings.
       W, [2024-12-12T18:55:24.521360 #2619]  WARN -- : Please check previous log messages.
       W, [2024-12-12T18:55:24.521365 #2619]  WARN -- : ==============================================================

[cheempz]

Hi @cody-collins indeed this gem uses a C extension, where the binding code against it is generated using SWIG during gem build time. Then during gem install the binary library is downloaded and the generated binding code compiles against it to produce the extension. So I think it's not possible to install the gem from GH source.

If you run Docker and can host the built gem somewhere available to your Heroku deployment, the following docker command is a distilled version of how to build it: install SWIG, download extension header files, generate binding code then pack up the gem.

I'm running Docker Desktop 4.36, and due to the C extension only supporting amd64 i explicitly set the --platform option on an M1/arm macOS.

docker build --platform linux/amd64 -t appoptics_apm -f- . <<EOF
FROM ruby:2.7

WORKDIR /work

ADD --keep-git-dir=true https://github.com/zearn/appoptics-apm-ruby.git#4.13.1 /work

RUN echo "gem: --no-document" >> ~/.gemrc \
    && bundle install --without development --without test \
    && apt update && apt install -y --no-install-recommends bison \
    && curl -SL https://github.com/swig/swig/archive/refs/tags/v4.0.2.tar.gz | tar xzC /tmp \
    && cd /tmp/swig-4.0.2 \
    && ./autogen.sh && ./configure && make && make install \
    && cd - \
    && bundle exec rake oboe_files_appoptics_fetch \
    && bundle exec rake build_and_publish_gem
EOF

You can run a quick check that the built gem works by running the image, installing the gem and requiring it in a ruby process.

docker run --platform linux/amd64 -e APPOPTICS_SERVICE_KEY=<API token>:<service name> appoptics_apm bash -c 'gem install appoptics_apm-4.13.0.gem && ruby -r appoptics_apm -e "exit"'

### should see outout like
...
Successfully installed appoptics_apm-4.13.0
1 gem installed
[Fri Dec 13 20:01:23 2024] >> SSL Reporter using host='collector.appoptics.com' port='443' log='' clientid='XdHM...Ig1k:foo' buf=1000 maxTransactions='200' flushMaxWaitTime='5000' eventsFlushInterval='2' maxRequestSizeBytes='3000000' proxy='' [reporter/ssl.cc:3102] [AppOptics-SSL_reporter-info p#1.1]

The gem can then be copied from the container to be hosted somewhere. Hope this helps, let me know if you need more details.

[cody-collins]

@cheempz Thank you! Do you have any update on whether a 4.13.1 release can be published for this repo? I would prefer that over needing to host my own gem if possible

[cheempz]

Sorry but i don't have an update yet @cody-collins, as you suspect appoptics_apm is no longer maintained so will need to scrounge up some bandwidth to try reviving the proper build machinery. My best guess is sometime Jan 2025 :(

[cody-collins]

@cheempz since appoptics_apm won't be maintained, what should my long term solution be for using the AppOptics addon in Heroku? Switch over to the new solarwinds_apm gem?

For configuring the solarwinds_apm, what would the collector endpoint be?

[cheempz]

@cody-collins the ideal long term solution is that you could take advantage of https://devcenter.heroku.com/articles/heroku-telemetry and we can work with you to set up a drain to SolarWinds Observability. It should provide a full replacement of the metrics, traces and logs you might be getting via the AppOptics add-on.

An interim solution is to switch to the new solarwinds_apm gem but still have it export data to AppOptics (described as Partial Migration in this page), note it needs to be done for all applications that's part of a distributed trace. The collector endpoint and service key would be the same values, but you'd have to set them with different environment variables:

• SW_APM_SERVICE_KEY=<AO API token>:<AO service name>
• SW_APM_COLLECTOR=collector.appoptics.com:443