solarwinds_apm 5.0.0 → 5.1.0.pre

data/Gemfile

@@ -9,6 +9,7 @@ group :development, :test do
   gem 'byebug', '>= 8.0.0'
   gem 'irb', '>= 1.0.0' # if RUBY_VERSION >= '2.6.0'
   gem 'memory_profiler'
+  gem 'package_cloud'
 end
 
 gemspec

data/README.md

@@ -362,9 +362,9 @@ manually build this C extension for the gem to function.
 To make this simpler, we've included a few rake tasks to automate this process:
 
 ```bash
-rake clean               # make sure no old stuff is around
-rake fetch_ext_deps      # download c-files
-rake compile             # Build the gem's c extension
+rake clean                             # make sure no old stuff is around
+rake fetch_oboe_file_from_staging      # download c-files from staging
+rake compile                           # Build the gem's c extension
 ```
 
 To see the code related to the C extension, take a look at `ext/oboe_metal/extconf.rb` for details.

data/ext/oboe_metal/extconf.rb

@@ -25,13 +25,13 @@ ext_dir = File.expand_path(File.dirname(__FILE__))
 ao_lib_dir = File.join(ext_dir, 'lib')
 ao_include = File.join(ext_dir, 'src')
 
-# Download the appropriate liboboe from S3(via rake for testing) or files.appoptics.com (production)
+# Download the appropriate liboboe from Staging or Production
 version = File.read(File.join(ao_include, 'VERSION')).strip
-if ENV['OBOE_FROM_S3'].to_s.downcase == 'true'
-  ao_path = File.join('https://rc-files-t2.s3-us-west-2.amazonaws.com/c-lib/', version)
-  puts 'Fetching c-lib from S3'
+if ENV['OBOE_STAGING'].to_s.downcase == 'true'
+  ao_path = File.join('https://agent-binaries.global.st-ssp.solarwinds.com/apm/c-lib/', version)
+  puts 'Fetching c-lib from STAGING'
 else
-  ao_path = File.join('https://files.appoptics.com/c-lib', version)
+  ao_path = File.join('https://agent-binaries.cloud.solarwinds.com/apm/c-lib/', version)
 end
 
 ao_arch = 'x86_64'

data/ext/oboe_metal/lib/liboboe-1.0-alpine-x86_64.so.0.0.0.sha256

@@ -1 +1 @@
-32deed8447ef3b97ed92efe062c2c2c609458978ce8760b29e343cc60c3f93e6
+e1a52a84efc7019c06af710313235a7063f2f73e00ae66e3a4cae9e86f6f03cb

data/ext/oboe_metal/lib/liboboe-1.0-x86_64.so.0.0.0.sha256

@@ -1 +1 @@
-34b3413d417ff9c6c9b19b77cf335294a8cd04132d224651aba2706bdd6dff2f
+662fccb7d38fbc159cdd31a9fc1b7066e6c9c799dda524b1db5508cdab20274b

data/ext/oboe_metal/src/README.md

@@ -1,5 +1,5 @@
 
-oboe_api.hpp and oboe_api.cpp are copied here from the oboe repo during install
+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/VERSION

@@ -1,2 +1,2 @@
-10.3.3
+10.6.1
 

data/ext/oboe_metal/src/frames.h

@@ -13,7 +13,7 @@
 #include <ruby/debug.h>
 
 #include "profiling.h"
-#include "oboe_api.hpp"
+#include "oboe_api.h"
 
 using namespace std;
 

data/ext/oboe_metal/src/init_solarwinds_apm.cc

@@ -13,7 +13,10 @@ void Init_profiling(void);
 
 void Init_libsolarwinds_apm() {
     Init_oboe_metal();
-    Init_profiling();
+
+    // * create SolarWindsAPM::CProfiler module for enabling SolarWindsAPM::Profiling
+    // * see lib/solarwinds_apm/support.rb
+    // Init_profiling(); 
 }
 
 #ifdef __cplusplus

data/ext/oboe_metal/src/logging.h

@@ -4,7 +4,7 @@
 #ifndef LOGGING_H
 #define LOGGING_H
 
-#include "oboe_api.hpp"
+#include "oboe_api.h"
 
 using namespace std;
 

data/ext/oboe_metal/src/oboe.h

@@ -94,9 +94,6 @@ extern "C" {
 #define OBOE_MAX_OP_ID_LEN 8
 #define OBOE_MAX_METADATA_PACK_LEN 512
 
-#define OBOE_METAFORMAT_XTRACE 0
-#define OBOE_METAFORMAT_TRACEPARENT 1
-
 #define TRACEPARENT_CURRENT_VERSION 0
 
 #define XTR_CURRENT_VERSION 2
@@ -132,6 +129,10 @@ extern "C" {
      #endif
 #endif
 
+#if !defined(PID_T_DEF)
+#define PID_T_DEF
+typedef int pid_t;
+#endif //PID_T_DEF
 
 // structs
 
@@ -141,7 +142,6 @@ typedef struct oboe_ids {
 } oboe_ids_t;
 
 typedef struct oboe_metadata {
-    uint8_t     type;
     uint8_t     version;
     oboe_ids_t  ids;
     size_t      task_len;
@@ -169,7 +169,7 @@ typedef struct oboe_metric_tag {
 } oboe_metric_tag_t;
 
 typedef struct oboe_init_options {
-    int version;                            // the version of this structure (currently on version 12 and 13 (adds w3c mode))
+    int version;                            // the version of this structure (currently on version 14)
     const char *hostname_alias;             // optional hostname alias
     int log_level;                          // level at which log messages will be written to log file (0-6)
                                             // use LOGLEVEL_DEFAULT for default log level
@@ -195,7 +195,8 @@ typedef struct oboe_init_options {
     int stdout_clear_nonblocking;           // flag indicating if the O_NONBLOCK flag on stdout should be cleared,
                                             // only used in lambda reporter (off=0, on=1, default off)
     int is_grpc_clean_hack_enabled;         // flag indicating if custom grpc clean hack enabled (default 0)
-    int mode;                               // flag indicating Solarwinds backend (0 = AppOptics; 1 = Nighthawk, default = 0)
+    int mode;                               // depreciated; value is ignored
+    int metric_format;                      // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
 } oboe_init_options_t;
 
 typedef struct oboe_span_params {
@@ -301,7 +302,6 @@ int oboe_event_init     (oboe_event_t *, const oboe_metadata_t *, const uint8_t*
 int oboe_event_destroy  (oboe_event_t *);
 
 int oboe_event_add_info (oboe_event_t *, const char *, const char *);
-int oboe_event_add_info_binary (oboe_event_t *, const char *, const char *, size_t);
 int oboe_event_add_info_int64 (oboe_event_t *, const char *, const int64_t);
 int oboe_event_add_info_double (oboe_event_t *, const char *, const double);
 int oboe_event_add_info_bool (oboe_event_t *, const char *, const int);
@@ -310,6 +310,7 @@ int oboe_event_add_edge (oboe_event_t *, const oboe_metadata_t *);
 int oboe_event_add_edge_fromstr(oboe_event_t *, const char *, size_t);
 
 int oboe_event_add_timestamp(oboe_event_t *evt);
+int oboe_event_add_tid(oboe_event_t* evt);
 int oboe_event_add_hostname(oboe_event_t *evt);
 
 /**
@@ -322,6 +323,15 @@ int oboe_event_add_hostname(oboe_event_t *evt);
  */
 int oboe_event_send(int channel, oboe_event_t *evt, oboe_metadata_t *md);
 
+/**
+ * Send event message using the default reporter. (Only for python otel exporter)
+ * This function won't add Timestamp_u by default
+ * @param channel the channel to send out this message (OBOE_SEND_EVENT or OBOE_SEND_STATUS)
+ * @param evt The event message.
+ * @param md The X-Trace metadata.
+ * @return Length of message sent in bytes on success; otherwise -1.
+ */
+int oboe_event_send_without_timestamp(int channel, oboe_event_t *evt, oboe_metadata_t *md);
 
 // oboe_context
 
@@ -390,7 +400,6 @@ int oboe_reporter_destroy(oboe_reporter_t *rep);    /* DEPRECATE: Use oboe_shutd
 
 ssize_t oboe_reporter_udp_send(void *desc, const char *data, size_t len);   /* DEPRECATE - Use oboe_event_send() */
 
-
 /* Oboe initialization and reporter management */
 
 /**
@@ -451,6 +460,14 @@ int oboe_reporter_flush();
  */
 const char* oboe_get_reporter_type();
 
+/**
+ * Get reporter default_endpoint
+ * It returns static information from each reporter class and doesn't require oboe_init before calling it
+ * @param reporter_type const char* e.g. SSL, UDP, FILE, ...
+ * @param default_endpoint const char* <empty> means no default endpoint
+ */
+const char* oboe_get_reporter_default_endpoint(const char* reporter_type);
+
 /**
  * Check if system is AWS Lambda
  */
@@ -511,7 +528,6 @@ void oboe_shutdown();
 
 // Value for "SampleSource" info key
 // where was the sample rate specified? (oboe settings, config file, hard-coded default, etc)
-#define OBOE_SAMPLE_RATE_SOURCE_CONTINUED -1
 #define OBOE_SAMPLE_RATE_SOURCE_FILE 1
 #define OBOE_SAMPLE_RATE_SOURCE_DEFAULT 2
 #define OBOE_SAMPLE_RATE_SOURCE_OBOE 3
@@ -527,6 +543,8 @@ void oboe_shutdown();
 #define OBOE_TRACE_ALWAYS  1    // deprecated: do not use, only here for backward compatibility
 #define OBOE_TRACE_DISABLED   0
 #define OBOE_TRACE_ENABLED  1
+#define OBOE_TRIGGER_DISABLED   0
+#define OBOE_TRIGGER_ENABLED  1
 
 #define OBOE_SEND_EVENT 0
 #define OBOE_SEND_STATUS 1
@@ -604,36 +622,6 @@ const char* oboe_get_tracing_decisions_auth_message (int code);
 #define OBOE_INIT_SSL_LOAD_CERT 9
 #define OBOE_INIT_SSL_REPORTER_CREATE 10
 #define OBOE_INIT_SSL_MISSING_KEY 11
-#define OBOE_INIT_INVALID_BACKEND 12
-
-//
-// these codes are returned by oboe_notifier_status()
-//
-#define OBOE_NOTIFIER_SHUTTING_DOWN -3
-#define OBOE_NOTIFIER_INITIALIZING -2
-#define OBOE_NOTIFIER_DISABLED -1
-#define OBOE_NOTIFIER_OK 0
-#define OBOE_NOTIFIER_SOCKET_PATH_TOO_LONG 1
-#define OBOE_NOTIFIER_SOCKET_CREATE 2
-#define OBOE_NOTIFIER_SOCKET_CONNECT 3
-#define OBOE_NOTIFIER_SOCKET_WRITE_FULL 4
-#define OBOE_NOTIFIER_SOCKET_WRITE_ERROR 5
-#define OBOE_NOTIFIER_SHUTDOWN_TIMED_OUT 6
-
-//
-// these codes are used for testing the notifier using oboe_notifier_test()
-//
-#define OBOE_NOTIFIER_TEST_KEEPALIVE 0
-#define OBOE_NOTIFIER_TEST_LOG 1
-#define OBOE_NOTIFIER_TEST_REMOTE_WARNING 2
-#define OBOE_NOTIFIER_TEST_REMOTE_CONFIG 3
-
-//
-// interval (in seconds) at which the notifier sends a keep-alive msg,
-// note that a keep-alive is only sent if no other message made it through
-// within the interval time
-//
-#define OBOE_NOTIFIER_KEEP_ALIVE_INTERVAL_SEC 10
 
 //
 // these codes are returned by oboe_custom_metric_summary() and oboe_custom_metric_increment()
@@ -1155,12 +1143,8 @@ int oboe_regex_match(const char* string, void* expression);
 /* oboe internal stats for agents to consume */
 oboe_internal_stats_t* oboe_get_internal_stats();
 
-/* notifier related functions */
-int oboe_notifier_init(const char *socket_path);
-int oboe_notifier_stop(int blocking);
-int oboe_notifier_status();
-int oboe_notifier_test(int test_case, const char *test_str);
-
+// Random
+void oboe_random_bytes(uint8_t bytes[], size_t sz);
 
 #ifdef __cplusplus
 } // extern "C"

data/ext/oboe_metal/src/oboe_api.cpp

@@ -6,7 +6,7 @@
  * This API should follow https://github.com/tracelytics/tracelons/wiki/Instrumentation-API
  **/
 
-#include "oboe_api.hpp"
+#include "oboe_api.h"
 
 /////// Metatdata ///////
 
@@ -77,6 +77,10 @@ void Context::setTracingMode(int newMode) {
     oboe_settings_mode_set(newMode);
 }
 
+void Context::setTriggerMode(int newMode) {
+    oboe_settings_trigger_set(newMode);
+}
+
 void Context::setDefaultSampleRate(int newRate) {
     oboe_settings_rate_set(newRate);
 }
@@ -243,6 +247,39 @@ Event *Context::startTrace() {
     return new Event();
 }
 
+Event* Context::createEntry(const oboe_metadata_t *md, int64_t timestamp, const oboe_metadata_t *parent_md) {
+    /**
+     * As liboboe assumed to manage metadata, liboboe needs to make sure all events are from the same trace.
+     * While Otel doesn't require liboboe to manage metadata,
+     * we need to set the thread local metadata the same task id as input parameter md but a different op_id.
+     */
+    auto thread_local_md = Context::get();
+    oboe_metadata_copy(thread_local_md, md);
+    // reset op_id to zeros
+    memset(thread_local_md->ids.op_id, 0, OBOE_MAX_OP_ID_LEN);
+
+    auto event = new Event();
+    oboe_event_init(event, md, md->ids.op_id);
+    oboe_event_add_info(event, "Label", "entry");
+    oboe_event_add_info_int64(event, "Timestamp_u", timestamp);
+    if (parent_md) {
+        oboe_event_add_edge(event, parent_md);
+    }
+    return event;
+}
+
+Event* Context::createEvent(int64_t timestamp) {
+    auto event = new Event(Context::get());
+    oboe_event_add_info_int64(event, "Timestamp_u", timestamp);
+    return event;
+}
+
+Event* Context::createExit(int64_t timestamp) {
+    auto event = createEvent(timestamp);
+    oboe_event_add_info(event, "Label", "exit");
+    return event;
+}
+
 /////// Event ///////
 
 Event::Event() {
@@ -277,11 +314,7 @@ bool Event::addInfo(char *key, void *val) {
 }
 
 bool Event::addInfo(char *key, const std::string &val) {
-    if (memchr(val.data(), '\0', val.size())) {
-        return oboe_event_add_info_binary(this, key, val.data(), val.size()) == 0;
-    } else {
-        return oboe_event_add_info(this, key, val.data()) == 0;
-    }
+    return oboe_event_add_info(this, key, val.data()) == 0;
 }
 
 bool Event::addInfo(char *key, long val) {
@@ -391,14 +424,8 @@ Metadata *Event::getMetadata() {
 std::string Event::opIdString() {
    char buf[OBOE_MAX_METADATA_PACK_LEN]; // Flawfinder: ignore
    oboe_metadata_tostr(&this->metadata, buf, OBOE_MAX_METADATA_PACK_LEN);
-
-   if ((&this->metadata)->type == OBOE_METAFORMAT_TRACEPARENT) {
-       buf[52] = '\0';
-       return std::string(&buf[36]);
-   } else {
-       buf[58] = '\0';
-       return std::string(&buf[42]);
-   }
+   buf[52] = '\0';
+   return std::string(&buf[36]);
 }
 
 std::string Event::metadataString() {
@@ -419,8 +446,12 @@ std::string Event::metadataString() {
      *
      * @return True on success; otherwise an error message is logged.
      */
-bool Event::send() {
-    return (oboe_event_send(OBOE_SEND_EVENT, this, Context::get()) >= 0);
+bool Event::send(bool with_system_timestamp) {
+    if (with_system_timestamp) {
+        return (oboe_event_send(OBOE_SEND_EVENT, this, Context::get()) >= 0);
+    } else {
+        return (oboe_event_send_without_timestamp(OBOE_SEND_EVENT, this, Context::get()) >= 0);
+    }
 }
 
 /**
@@ -574,11 +605,12 @@ Reporter::Reporter(
     int stdout_clear_nonblocking,   // flag indicating if the O_NONBLOCK flag on stdout should be cleared,
                                     // only used in lambda reporter (off=0, on=1, default off)
     int is_grpc_clean_hack_enabled, // flag indicating if custom grpc clean hack enabled (default 0)
-    int w3c_trace_format            // tag indicating trace id format (0 - legacy Xtrace, 1 - w3c)
+    int w3c_trace_format,           // tag indicating trace id format (0 - legacy Xtrace, 1 - w3c)
+    int metric_format               // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
 ) {
     oboe_init_options_t options;
     memset(&options, 0, sizeof(options));
-    options.version = 13;
+    options.version = 14;
     oboe_init_options_set_defaults(&options);
 
     if (hostname_alias != "") {
@@ -615,6 +647,7 @@ Reporter::Reporter(
     options.stdout_clear_nonblocking = stdout_clear_nonblocking;
     options.is_grpc_clean_hack_enabled = is_grpc_clean_hack_enabled;
     options.mode = w3c_trace_format;
+    options.metric_format = metric_format;
     init_status = oboe_init(&options);
 }
 
@@ -622,20 +655,36 @@ Reporter::~Reporter() {
     oboe_reporter_destroy(this);
 }
 
-bool Reporter::sendReport(Event *evt) {
-    return oboe_event_send(OBOE_SEND_EVENT, evt, Context::get()) >= 0;
+bool Reporter::sendReport(Event *evt, bool with_system_timestamp) {
+    if (with_system_timestamp) {
+        return oboe_event_send(OBOE_SEND_EVENT, evt, Context::get()) >= 0;
+    } else {
+        return oboe_event_send_without_timestamp(OBOE_SEND_EVENT, evt, Context::get()) >= 0;
+    }
 }
 
-bool Reporter::sendReport(Event *evt, oboe_metadata_t *md) {
-    return oboe_event_send(OBOE_SEND_EVENT, evt, md) >= 0;
+bool Reporter::sendReport(Event *evt, oboe_metadata_t *md, bool with_system_timestamp) {
+    if (with_system_timestamp) {
+        return oboe_event_send(OBOE_SEND_EVENT, evt, md) >= 0;
+    } else {
+        return oboe_event_send_without_timestamp(OBOE_SEND_EVENT, evt, md) >= 0;
+    }
 }
 
-bool Reporter::sendStatus(Event *evt) {
-    return oboe_event_send(OBOE_SEND_STATUS, evt, Context::get()) >= 0;
+bool Reporter::sendStatus(Event *evt, bool with_system_timestamp) {
+    if (with_system_timestamp) {
+        return oboe_event_send(OBOE_SEND_STATUS, evt, Context::get()) >= 0;
+    } else {
+        return oboe_event_send_without_timestamp(OBOE_SEND_STATUS, evt, Context::get()) >= 0;
+    }
 }
 
-bool Reporter::sendStatus(Event *evt, oboe_metadata_t *md) {
-    return oboe_event_send(OBOE_SEND_STATUS, evt, md) >= 0;
+bool Reporter::sendStatus(Event *evt, oboe_metadata_t *md, bool with_system_timestamp) {
+    if (with_system_timestamp) {
+        return oboe_event_send(OBOE_SEND_STATUS, evt, md) >= 0;
+    } else {
+        return oboe_event_send_without_timestamp(OBOE_SEND_STATUS, evt, md) >= 0;
+    }
 }
 
 void Reporter::flush() {

data/ext/oboe_metal/src/{oboe_api.hpp → oboe_api.h}

@@ -92,6 +92,15 @@ class Context {
      */
     static void setTracingMode(int newMode);
 
+    /**
+     * Set the trigger tracing mode.
+     *
+     * @param newMode One of
+     * - OBOE_TRIGGER_DISABLED(0) to disable tracing, or
+     * - OBOE_TRIGGER_ENABLED(1) to start a new trace if needed
+     */
+    static void setTriggerMode(int newMode);
+
     /**
      * Set the default sample rate.
      *
@@ -234,6 +243,27 @@ class Context {
      */
     static Event *createEvent();
     static Event *startTrace();
+
+    /**
+     * Create entry event with user-defined metadata and timestamp
+     * @param md const oboe_metadata_t *
+     * @param timestamp int64_t
+     * @param parent_md const oboe_metadata_t *
+     * @return Event*
+     */
+    static Event* createEntry(const oboe_metadata_t *md, int64_t timestamp, const oboe_metadata_t *parent_md = nullptr);
+    /**
+     * Create an continuous event with user-defined timestamp
+     * @param timestamp int64_t
+     * @return Event*
+     */
+    static Event* createEvent(int64_t timestamp);
+    /**
+     * Create exit event with user-defined timestamp
+     * @param timestamp int64_t
+     * @return Event*
+     */
+    static Event* createExit(int64_t timestamp);
 };
 
 class Event : private oboe_event_t {
@@ -278,10 +308,10 @@ class Event : private oboe_event_t {
      * Report this event.
      *
      * This sends the event using the default reporter.
-     *
+     * @param with_system_timestamp bool True means system timestamp 'Timestamp_u' will be added to event
      * @return True on success; otherwise an error message is logged.
      */
-    bool send();
+    bool send(bool with_system_timestamp = true);
 
     /**
      * Report a profiling event
@@ -395,15 +425,16 @@ class Reporter : private oboe_reporter_t {
         int stdout_clear_nonblocking,   // flag indicating if the O_NONBLOCK flag on stdout should be cleared,
                                         // only used in lambda reporter (off=0, on=1, default off)
         int is_grpc_clean_hack_enabled, // flag indicating if custom grpc clean hack enabled (default 0)
-        int w3c_trace_format            // tag indicating trace id format (0 - legacy Xtrace, 1 - w3c)
+        int w3c_trace_format,           // depreciated; value is ignored
+        int metric_format               // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
     );
 
     ~Reporter();
 
-    bool sendReport(Event *evt);
-    bool sendReport(Event *evt, oboe_metadata_t *md);
-    bool sendStatus(Event *evt);
-    bool sendStatus(Event *evt, oboe_metadata_t *md);
+    bool sendReport(Event *evt, bool with_system_timestamp = true);
+    bool sendReport(Event *evt, oboe_metadata_t *md, bool with_system_timestamp = true);
+    bool sendStatus(Event *evt, bool with_system_timestamp = true);
+    bool sendStatus(Event *evt, oboe_metadata_t *md, bool with_system_timestamp = true);
     void flush();
     std::string getType();
 };