solarwinds_apm 5.1.9 → 6.0.0.preV2

data/examples/sdk_examples.rb

@@ -1,158 +0,0 @@
-# Copyright (c) 2020 SolarWinds, LLC.
-# All rights reserved.
-
-###############################################################
-# SDK EXAMPLES
-###############################################################
-# The uses cases of the SDK include:
-# - tracing a piece of your own code
-# - tracing a method call of a gem that is not auto-instrumented
-#   by solarwinds_apm
-#
-# SDK documentation:
-# https://rubydoc.info/gems/solarwinds_apm/SolarWindsAPM/SDK
-
-###############################################################
-# Prerequisits
-# export SW_APM_SERVICE_KEY=<API token>:<service_name>
-# `bundle exec ruby sdk_examples.rb`
-# 5 traced requests will show up in the backend
-###############################################################
-
-require 'solarwinds_apm'
-
-unless SolarWindsAPM::SDK.solarwinds_ready?(10_000)
-  puts "aborting!!! Agent not ready after 10 seconds"
-  exit false
-end
-
-###############################################################
-### ADD A SPAN
-###############################################################
-#
-# SolarWindsAPM::SDK.trace()
-# This method adds a span to a trace that has been started either
-# by the auto-instrumentation of the gem handling incoming requests
-# or the SDK method `start_trace`.
-# If this method is called outside of the context of a started
-# trace no spans will be created.
-#
-# The argument is the name for the span
-
-SolarWindsAPM::SDK.trace('span_name') do
-  [9, 6, 12, 2, 7, 1, 9, 3, 4, 14, 5, 8].sort
-end
-
-###############################################################
-# START A TRACE, ADD A SPAN, AND LOG AN INFO EVENT
-###############################################################
-#
-# SolarWindsAPM::SDK.start_trace()
-# This method starts a trace.  It is handy for background jobs,
-# workers, or scripts, that are not part of a rack application
-
-SolarWindsAPM::SDK.start_trace('outer_span') do
-  SolarWindsAPM::SDK.trace('first_child_span') do
-    [9, 6, 12, 2, 7, 1, 9, 3, 4, 14, 5, 8].sort
-    SolarWindsAPM::SDK.log_info({ some: :fancy, hash: :to, send: 1 })
-  end
-end
-
-###############################################################
-# LOG AN ERROR EVENT
-###############################################################
-#
-# SolarWindsAPM::SDK.log_exception()
-# This method adds an error event to the trace, which will be
-# displayed and counted as exception on the solarwinds_apm dashboard.
-
-def do_raise
-  raise StandardError.new("oops")
-end
-
-SolarWindsAPM::SDK.start_trace('with_error') do
-  begin
-    do_raise
-  rescue => e
-    SolarWindsAPM::SDK.log_exception(e)
-  end
-end
-
-###############################################################
-# TRACE A METHOD
-###############################################################
-#
-# SolarWindsAPM::SDK.trace_method()
-# This creates a span every time the defined method is run.
-# The method can be of any (accessible) type (instance,
-# singleton, private, protected etc.).
-
-module ExampleModule
-  def self.do_sum(a, b)
-    a + b
-  end
-end
-
-SolarWindsAPM::SDK.trace_method(ExampleModule,
-                               :do_sum,
-                               config: { name: 'computation', backtrace: true },
-                               kvs: { CustomKey: "some_info" })
-
-SolarWindsAPM::SDK.start_trace('trace_a_method') do
-  ExampleModule.do_sum(1, 2)
-  ExampleModule.do_sum(3, 4)
-end
-
-###############################################################
-# SET A CUSTOM TRANSACTION NAME
-###############################################################
-#
-# SolarWindsAPM::SDK.set_transaction_name()
-#
-# this method can be called anytime after a trace has been started to add a
-# custom name for the whole transaction.
-# In case of a controller the trace is usually started in rack.
-
-class FakeController
-  def create(params)
-    # @fake = fake.new(params.permit(:type, :title))
-    # @fake.save
-    SolarWindsAPM::SDK.set_transaction_name("fake.#{params[:type]}")
-    # redirect_to @fake
-  end
-end
-
-SolarWindsAPM::SDK.start_trace('set_transaction_name') do
-  FakeController.new.create(type: 'news')
-end
-
-###############################################################
-# LOG INJECTION OF TRACE_ID
-###############################################################
-#
-# SolarWindsAPM::SDK.current_trace_info
-# This method creates an object with the current trace ID and
-# helper methods to add the ID to logs for cross-referencing.
-
-SolarWindsAPM::Config[:log_traceId] = :always
-
-SolarWindsAPM::SDK.start_trace('log_trace_id') do
-  trace = SolarWindsAPM::SDK.current_trace_info
-  SolarWindsAPM.logger.warn "Some log message #{trace.for_log}"
-end
-
-###############################################################
-# START A TRACE AND PROFILE
-###############################################################
-#
-# SolarWindsAPM::Profiling.run
-# This method adds profiling for the code executed in the block
-
-SolarWindsAPM::SDK.start_trace("#{name}_profiling") do
-  SolarWindsAPM::Profiling.run do
-    10.times do
-      [9, 6, 12, 2, 7, 1, 9, 3, 4, 14, 5, 8].sort
-      sleep 0.2
-    end
-  end
-end

data/ext/oboe_metal/README.md

@@ -1,69 +0,0 @@
-# Debug the c-code with gdb
-
-inspired by: https://dev.to/wataash/how-to-create-and-debug-ruby-gem-with-c-native-extension-3l8b
-
-
-## install ruby with sources
-
-rbenv is your friend ;) -k means keep sources
-
-```
-rbenv install -k 2.7.5
-rbenv shell 2.7.5
-
-# check that ruby is debuggable
-type ruby           # => ruby is /home/wsh/.rbenv/shims/ruby
-rbenv which ruby    # => /home/wsh/.rbenv/versions/2.6.3/bin/ruby
-```
-
-
-##
-## add debug info when compiling solarwinds_apm
-add this line to extconf.rb to turn off optimization
-
-```
-CONFIG["optflags"] = "-O0"
-```
-
-
-##
-## start ruby app with gdb
-
-This will run ruby and load the app with a breakpoint in the Reporter::startThread
-c-function.
-
-`bundle exec gdb -q -ex 'set breakpoint pending on' -ex 'b Reporter::startThread' -ex run --args ruby -e 'require "./app"'`
-
-If there is a bug in the ruby code or a ruby byebug binding that halts the 
-script, the debugger will hang without showing any output. 
-So, make sure `bundle exec ruby app.rb` runs.
-
-use the gdb navigation commands to step through the code. If it says:
-
-```
-(gdb) n
-Single stepping until exit from function _ZN8Reporter11startThreadEv@plt,
-which has no line number information.
-```
-
-type `c` and it may end up stopping in the right location.
-
-##
-## make ruby .gdbinit macros available
-
-These macros are pretty elaborate. They are checked in the ruby github 
-repo: https://github.com/ruby/ruby/blob/master/.gdbinit
-The code is nicely formatted and colorized in github and easiest to read there.
-
-installation in the user's home dir:
-```
-wget https://github.com/ruby/ruby/blob/master/.gdbinit
-```
-##
-## examples
-
-Some inspiring examples here:
-
-https://jvns.ca/blog/2016/06/12/a-weird-system-call-process-vm-readv/
-
-https://medium.com/@zanker/finding-a-ruby-bug-with-gdb-56d6b321bc86

data/ext/oboe_metal/extconf_local.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
-
-require 'mkmf'
-require 'rbconfig'
-require 'open-uri'
-require 'no_proxy_fix'
-
-CONFIG['warnflags'] = CONFIG['warnflags'].gsub(/-Wdeclaration-after-statement/, '')
-                        .gsub(/-Wimplicit-function-declaration/, '')
-                        .gsub(/-Wimplicit-int/, '')
-                        .gsub(/-Wno-tautological-compare/, '')
-                        .gsub(/-Wno-self-assign/, '')
-                        .gsub(/-Wno-parentheses-equality/, '')
-                        .gsub(/-Wno-constant-logical-operand/, '')
-                        .gsub(/-Wno-cast-function-type/, '')
-init_mkmf(CONFIG)
-
-ext_dir = File.expand_path(File.dirname(__FILE__))
-
-# Set the mkmf lib paths so we have no issues linking to
-# the SolarWindsAPM libs.
-ao_lib_dir = File.join(ext_dir, 'lib')
-ao_path = '../../../oboe/factory-output'
-ao_clib = "liboboe-1.0-x86_64.so"
-ao_item = File.join(ao_path, ao_clib)
-clib = File.join(ao_lib_dir, ao_clib)
-
-FileUtils.cp(ao_item, clib)
-
-# Create relative symlinks for the SolarWindsAPM library
-Dir.chdir(ao_lib_dir) do
-  File.symlink(ao_clib, 'liboboe.so')
-  File.symlink(ao_clib, 'liboboe-1.0.so.0')
-end
-
-dir_config('oboe', 'src', 'lib')
-
-if have_library('oboe', 'oboe_config_get_revision', 'oboe.h')
-  $libs = append_library($libs, 'oboe')
-  $libs = append_library($libs, 'stdc++')
-
-  $CFLAGS << " #{ENV['CFLAGS']}"
-  # $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11"
-  # TODO for debugging: -pg -gdwarf-2, remove for production
-  # -pg does not work on alpine https://www.openwall.com/lists/musl/2014/11/05/2
-  $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11  -gdwarf-2 -I$$ORIGIN/../ext/oboe_metal/include -I$$ORIGIN/../ext/oboe_metal/src"
-  # $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11 -I$$ORIGIN/../ext/oboe_metal/include"
-  $LIBS << " #{ENV['LIBS']}"
-
-  # use "z,defs" to see what happens during linking
-  # $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib,-z,defs'  -lrt"
-  $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib' -lrt"
-  $CXXFLAGS += " -std=c++11 "
-
-  # ____ include debug info, comment out when not debugging
-  # ____ -pg -> profiling info for gprof
-  CONFIG["debugflags"] = "-ggdb3 "
-  CONFIG["optflags"] = "-O0"
-
-  create_makefile('libsolarwinds_apm', 'src')
-else
-  $stderr.puts   '== ERROR ========================================================='
-  if have_library('oboe')
-    $stderr.puts "The c-library either needs to be updated or doesn't match the OS."
-    $stderr.puts 'No tracing will occur.'
-  else
-    $stderr.puts 'Could not find a matching c-library. No tracing will occur.'
-  end
-  $stderr.puts   'Contact technicalsupport@solarwinds.com if the problem persists.'
-  $stderr.puts   '=================================================================='
-  create_makefile('oboe_noop', 'noop')
-end

data/ext/oboe_metal/noop/noop.c

@@ -1,8 +0,0 @@
-#include <ruby.h>
-
-/* ruby calls this to load the extension */
-void Init_oboe_noop(void) {
-  /* assume we haven't yet defined Hola */
-//  VALUE klass = rb_define_class("OboeNoop", rb_cObject);
-  rb_define_class("OboeNoop", rb_cObject);
-}

data/ext/oboe_metal/src/README.md

@@ -1,6 +0,0 @@
-
-oboe_api.h and oboe_api.cpp are copied here from the oboe repo during install
-
-it is best to edit these file in the oboe codebase and use the OBOE_WIP=true env
-var to include the local development version while the changes aren't deployed to s3.
-

data/ext/oboe_metal/src/frames.cc

@@ -1,247 +0,0 @@
-// Copyright (c) 2021 SolarWinds, LLC.
-// All rights reserved.
-
-#include "frames.h"
-
-using namespace std;
-
-unordered_map<VALUE, FrameData> cached_frames;
-
-// in theory the mutex is not needed, because Ruby does not context switch
-// while executing a foreign function, but will this always hold true?
-mutex cached_frames_mutex;
-
-void Frames::reserve_cached_frames() {
-    lock_guard<mutex> guard(cached_frames_mutex);
-    // unordered_maps grow automatically, but it starts at 1 and then
-    // doubles when it is full, so lets avoid the warmup
-    cached_frames.reserve(500);  // it will round to a prime number: 503
-}
-
-void Frames::clear_cached_frames() {
-    lock_guard<mutex> guard(cached_frames_mutex);
-        // unordered_maps grow automatically, but it starts at 1 and then
-        // doubles when it is full, so lets avoid the warmup
-    cached_frames.clear();
-}
-
-// this is a private function
-int Frames::cache_frame(VALUE frame) {
-    VALUE val;
-    FrameData data;
-
-    // only cache it if it does not exist
-    if (cached_frames.count(frame) == 0) {
-        val = rb_profile_frame_label(frame);  // returns method or block
-        if (RB_TYPE_P(val, T_STRING))
-            data.method = RSTRING_PTR(val);
-
-        if (data.method.rfind("block ", 0) == 0) {
-            // we don't need more info if it is a block
-            // we ignore block level info because they make things messy
-            lock_guard<mutex> guard(cached_frames_mutex);
-            cached_frames.insert({frame, data});
-            return 0;
-        }
-
-        val = rb_profile_frame_classpath(frame);  // returns class or nil
-        if (RB_TYPE_P(val, T_STRING)) data.klass = RSTRING_PTR(val);
-
-        val = rb_profile_frame_absolute_path(frame);  // returns file, use rb_profile_frame_path() if nil
-        if (!RB_TYPE_P(val, T_STRING)) val = rb_profile_frame_path(frame);
-        if (RB_TYPE_P(val, T_STRING)) data.file = RSTRING_PTR(val);
-
-        // Ruby 3 reports <cfunc>, but the linenumbers are bogus
-        // the default line number is 0
-        if (!data.file.compare("<cfunc>") == 0) {
-            val = rb_profile_frame_first_lineno(frame);  // returns line number
-            if (RB_TYPE_P(val, T_FIXNUM)) {
-                data.lineno = NUM2INT(val);
-            }
-        }
-        lock_guard<mutex> guard(cached_frames_mutex);
-        cached_frames.insert({frame, data});
-    }
-    return 0;
-}
-
-// all frames in frames_buffer must be in cached_frames
-// before calling this function
-// we are saving the check for better performance
-int Frames::collect_frame_data(VALUE *frames_buffer, int num, vector<FrameData> &frame_data) {
-    if (num == 1) {
-        if (frames_buffer[0] == PR_IN_GC) {
-            FrameData data;
-            data.method = "GARBAGE COLLECTION";
-            frame_data.push_back(data);
-            return 0;
-        } else if (frames_buffer[0] == PR_OTHER_THREAD) {
-            FrameData data;
-            data.method = "OTHER THREADS";
-            frame_data.push_back(data);
-            return 0;
-        }
-    }
-
-    for (int i = 0; i < num; i++) {
-        VALUE frame = frames_buffer[i];
-        frame_data.push_back(cached_frames[frame]);
-    }
-    return 0;
-}
-
-/////
-// For the sake of efficiency this function filters uninteresting frames and
-// does the caching of frames at the same time
-//
-// in-place removal of
-// - frames with line number == 0
-// - all but last of repeated frames
-// - "block" frames (they are confusing) <- revisit
-// and cache uncached frames
-int Frames::remove_garbage(VALUE *frames_buffer, int num) {
-    if (num == 1 && (frames_buffer[0] == PR_OTHER_THREAD || frames_buffer[0] == PR_IN_GC))
-        return 1;
-
-    // TODO decide what to do with <cfunc> frames in Ruby 3
-    // ____ AO-20269
-
-    // 1) ignore top frames where the line number is 0
-    // does that mean there is no line number???
-    bool found = true;
-
-    while (found && num > 0) {
-        if (cached_frames.count(frames_buffer[num - 1]) == 1) {
-            found = (cached_frames[frames_buffer[num - 1]].lineno == 0);
-            if (found) num--;
-        } else {
-            VALUE val = rb_profile_frame_first_lineno(frames_buffer[num - 1]);
-            found = (!RB_TYPE_P(val, T_FIXNUM) || !NUM2INT(val));
-            if (found) {
-                lock_guard<mutex> guard(cached_frames_mutex);
-                cached_frames[frames_buffer[num - 1]].lineno = 0;
-                num--;
-            }
-        }
-    }
-
-    // 2) remove all repeated frames, keep the last one
-    int count = 0;
-    int k = 0;
-    found = false;
-    while (count < num - k) {
-        // is this frame repeated ahead?
-        // if so we will replace it with the next one in line
-        for (int j = count + k + 1; j < num; j++) {
-            if (frames_buffer[count] == frames_buffer[j]) {
-                found = true;
-                break;
-            }
-        }
-
-        if (found) {
-            // if we found this frame again later in the snapshot
-            // we are going to override this one
-            // but not if this is going beyond the boundary
-            k++;
-            if (count + k < num - 1) frames_buffer[count] = frames_buffer[count + k];
-        } else {
-            count++;
-            frames_buffer[count] = frames_buffer[count + k];
-        }
-        found = false;
-    }
-
-    // 3) remove "block" frames, they are reported inconsistently and mess up
-    //    the profile in the dashboard
-    // 4)  while we are at it we also cache all the frames
-    // these 2 are combined so we don't have to run this loop twice
-    num = count;
-    count = 0, k = 0;
-    string method;
-
-    while (count < num - k) {
-        frames_buffer[count] = frames_buffer[count + k];
-        cache_frame(frames_buffer[count]);
-        method = cached_frames[frames_buffer[count]].method;
-
-        // TODO revisit need to remove block frames, they only appear when the Ruby
-        // ____ script is not started with a method and has blocks outside of the
-        // ____ methods called and sometimes inside of rack
-        if (method.rfind("block ", 0) == 0) {
-            k++;
-        } else {
-            count++;
-        }
-    }
-    return count;
-}
-
-// returns the number of the matching frames
-int Frames::num_matching(VALUE *frames_buffer, int num,
-                         VALUE *prev_frames_buffer, int prev_num) {
-    int i;
-    int min = std::min(num, prev_num);
-
-    for (i = 0; i < min; i++) {
-        // we have to start from the "top"
-        if (frames_buffer[num - 1 - i] != prev_frames_buffer[prev_num - 1 - i]) {
-            return i;
-        }
-    }
-    return i;
-}
-
-/////////////////////// DEBUGGING HELPER FUNCTIONS /////////////////////////////
-// helper function to print frame from ruby pointers to frame
-void Frames::print_raw_frame_info(VALUE frame) {
-    if (frame == PR_IN_GC || frame == PR_OTHER_THREAD) {
-        return;
-    }
-
-    VALUE val;
-    int lineno;
-    string file, klass, method;
-
-    val = rb_profile_frame_first_lineno(frame);  // returns line number
-    if (RB_TYPE_P(val, T_FIXNUM)) lineno = NUM2INT(val);
-
-    val = rb_profile_frame_classpath(frame);  // returns class or nil
-    if (RB_TYPE_P(val, T_STRING)) klass = RSTRING_PTR(val);
-
-    val = rb_profile_frame_absolute_path(frame);  // returns file, use rb_profile_frame_path() if nil
-    if (!RB_TYPE_P(val, T_STRING)) val = rb_profile_frame_path(frame);
-    if (RB_TYPE_P(val, T_STRING)) file = RSTRING_PTR(val);
-
-    val = rb_profile_frame_label(frame);  // returns method or block
-    if (RB_TYPE_P(val, T_STRING)) method = RSTRING_PTR(val);
-
-    cout << "    " << frame << "   "
-         << "L: " << lineno << " "
-         << "F: " << file << " "
-         << "C: " << klass << " "
-         << "M: " << method << endl;
-}
-
-void Frames::print_all_raw_frames(VALUE *frames_buffer, int num) {
-    for (int i = 0; i < num; i++) {
-        print_raw_frame_info(frames_buffer[i]);
-    }
-}
-
-// helper function to print frame info
-void Frames::print_frame_info(VALUE frame) {
-    if (cached_frames.find(frame) != cached_frames.end())
-        std::cout << cached_frames[frame].lineno << " "
-                  << cached_frames[frame].file << " "
-                  << cached_frames[frame].klass << " "
-                  << cached_frames[frame].method << std::endl;
-}
-
-// helper function for printing the cached frames
-void Frames::print_cached_frames() {
-    std::cout << "cached_frames contains:" << endl;
-    for (auto it = cached_frames.cbegin(); it != cached_frames.cend(); ++it)
-        std::cout << "           " << it->first << " - " << it->second.method << ":" << it->second.lineno << endl;  // cannot modify *it
-    std::cout << std::endl;
-}

data/ext/oboe_metal/src/frames.h

@@ -1,40 +0,0 @@
-// Copyright (c) 2021 SolarWinds, LLC.
-// All rights reserved.
-
-#ifndef FRAMES_H
-#define FRAMES_H
-
-#include <vector>
-
-#include <mutex>
-#include <unordered_map>
-
-#include <ruby/ruby.h>
-#include <ruby/debug.h>
-
-#include "profiling.h"
-#include "oboe_api.h"
-
-using namespace std;
-
-class Frames {
-   public:
-    static void clear_cached_frames();
-    static void reserve_cached_frames();
-    static int collect_frame_data(VALUE *frames_buffer, int num, vector<FrameData> &frame_data);
-    static int remove_garbage(VALUE *frames_buffer, int num);
-    static int num_matching(VALUE *frames_buffer, int num,
-                            VALUE *prev_frames_buffer, int prev_num);
-
-   private:
-    static int cache_frame(VALUE frame);
-
-    // Debugging helper functions
-   public:
-    static void print_raw_frame_info(VALUE frame);
-    static void print_all_raw_frames(VALUE *frames_buffer, int num);
-    static void print_frame_info(VALUE frame);
-    static void print_cached_frames();
-};
-
-#endif //FRAMES_H