solarwinds_apm 6.0.0.preV4 → 6.0.0.prev6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713296dd9c5976499e32444e7746b7c340aa49a8cbd34df63308451f39c83615
-  data.tar.gz: 8efaffed12d27beb7144ea55e3180bd49eedf10075f77573591272645fe975ea
+  metadata.gz: 512ec5ee7d54316580c83a629faccc98c8c435151f0dade34d102597ad700a9f
+  data.tar.gz: 7a6f84e7c04493d368a157ed098ae2ea67898c40d2eba23e6a2467d6de6faf18
 SHA512:
-  metadata.gz: 9c2a125a6991e69089af608f6d8c37d2716b083bd47f28c4c7d9610f8d02be31e6024107e91ad09a4e78c6200b9d608de9bd56d5b67b098a8a4a7cdd4a2a1c19
-  data.tar.gz: 61d4b4e5805eefe3dee96567509c4eb2378c226f38df35dabc93df999ec3a209ac8a61a4d578d7710819618e21af2701f8acb327bb684b641d2f5ede6878cbdb
+  metadata.gz: 5fbd2c89241e02a6ab3e54bc430f92f98a5ac13ebf9f3cad135b045aea679a9f170ff0cbf5c3f6cf162f3fd90fdb2d6200e692be4259527cf06eea05904b91b4
+  data.tar.gz: e49ec590eb79e9d4c436f8341bffe16cb8d6fe07e77cb2939159da6b0b33222aed3d4d9bb8610cef55a59b572543c5d74eef2bef9179b2a5a65df258b2a0e8ca

data/ext/oboe_metal/extconf.rb

@@ -26,10 +26,10 @@ swo_include = File.join(ext_dir, 'src')
 
 # Download the appropriate liboboe from Staging or Production
 version = File.read(File.join(swo_include, 'VERSION')).strip
-if ENV['OBOE_DEV'].to_s.downcase == 'true'
+if ENV['OBOE_DEV'].to_s.casecmp('true').zero?
   swo_path = "https://solarwinds-apm-staging.s3.us-west-2.amazonaws.com/apm/c-lib/nightly"
   puts 'Fetching c-lib from DEVELOPMENT Build'
-elsif ENV['OBOE_STAGING'].to_s.downcase == 'true'
+elsif ENV['OBOE_STAGING'].to_s.casecmp('true').zero?
   swo_path = File.join('https://agent-binaries.global.st-ssp.solarwinds.com/apm/c-lib/', version)
   puts 'Fetching c-lib from STAGING'
 else
@@ -38,7 +38,8 @@ end
 
 swo_arch = 'x86_64'
 system_arch = `uname -m` # for mac, the command is `uname` # "Darwin\n"; try `uname -a`
-case system_arch.gsub("\n","")
+system_arch.delete!("\n")
+case system_arch
 when 'x86_64'
   swo_arch = 'x86_64'
 when 'aarch64'

data/ext/oboe_metal/lib/liboboe-1.0-aarch64.so.sha256

@@ -1 +1 @@
-86a0c98301b157fd2ec184e585d70e40753c721c52fbc596ab09aa3d422d5f1f
+b3a0b342e5d59ea95b457bcc647b9a2e202d623d5c17a109df2719a5d61815d2

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

@@ -1 +1 @@
-534122daed4a1a81a9e66828f206662ea8f6bf891fb84438cc3daef5f78a7af4
+5f98ddec2afd1992080d4e751b583a075e1a91b95ca3a5e5d7db49978225c8bd

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

@@ -1 +1 @@
-89936e04f0b8cddf3fb94c8a4c21d16aa780d6e4fbf4bb66eba42eb33fe15cc6
+5227b6cc86a1d60c479f9e2021200b09e3ba70f47a563788c857f51747dbebe8

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

@@ -1 +1 @@
-623f5b308759754c8d771567d5346c46e1d9b53739995a9b5594cc08f8bc6e54
+22d5c810eaf9b663b46ae67586059edf18e7e1e3beab89f079d2b86353ef55d9

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-13.0.0
+14.0.1

data/ext/oboe_metal/src/oboe.h

@@ -27,7 +27,6 @@ extern "C" {
     #include <unistd.h> // On Windows ssize_t definition was put in this header.
 #endif
 #include "bson/bson.h"
-#include "oboe_debug.h"
 
 /**
  * Default configuration settings update interval in seconds.
@@ -101,7 +100,6 @@ extern "C" {
 #define OBOE_REPORTER_PROTOCOL_UDP "udp"
 #define OBOE_REPORTER_PROTOCOL_SSL "ssl"
 #define OBOE_REPORTER_PROTOCOL_NULL "null"
-#define OBOE_REPORTER_PROTOCOL_LAMBDA "lambda"
 
 /** Maximum reasonable length of an arguments string for configuring a reporter. */
 #define OBOE_REPORTER_ARGS_SIZE 4000
@@ -163,10 +161,10 @@ typedef struct oboe_metric_tag {
 } oboe_metric_tag_t;
 
 typedef struct oboe_init_options {
-    int version;                            // the version of this structure (currently on version 15)
+    int version;                            // the version of this structure (currently on version 16)
     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
+                                            // use OBOE_INIT_LOG_LEVEL_INFO(3) for default log level
     const char *log_file_path;              // file name including path for log file
     int max_transactions;                   // maximum number of transaction names to track
     int max_flush_wait_time;                // maximum wait time for flushing data before terminating in milli seconds
@@ -189,6 +187,7 @@ 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 metric_format;                      // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
+    int log_type;                           // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
 } oboe_init_options_t;
 
 typedef struct oboe_span_params {
@@ -486,6 +485,13 @@ int oboe_raw_send(int channel, const char *data, size_t len);
  */
 void oboe_shutdown();
 
+/**
+ * Don't call *coming_impl function directly, they are temporary
+ */
+bool oboe_validate_tracing_decisions_in_t(oboe_tracing_decisions_in_t *in);
+int oboe_init_coming_impl(const char* json);
+int oboe_tracing_decisions_coming_impl(oboe_tracing_decisions_in_t *in, oboe_tracing_decisions_out_t *out);
+void oboe_shutdown_coming_impl();
 
 // Settings interface
 
@@ -577,6 +583,7 @@ const char* oboe_get_tracing_decisions_message(int code);
 #define OBOE_TRACING_DECISIONS_AUTH_NO_SIG_KEY 1
 #define OBOE_TRACING_DECISIONS_AUTH_INVALID_SIG 2
 #define OBOE_TRACING_DECISIONS_AUTH_BAD_TIMESTAMP 3
+#define OBOE_TRACING_DECISIONS_AUTH_INTERNAL_ERROR 4
 
 // convert above codes into const char* messages.
 const char* oboe_get_tracing_decisions_auth_message (int code);
@@ -624,6 +631,20 @@ const char* oboe_get_tracing_decisions_auth_message (int code);
 #define OBOE_REPORTER_FLUSH_NO_REPORTER 3
 #define OBOE_REPORTER_FLUSH_REPORTER_NOT_READY 4
 
+#define OBOE_INIT_LOG_LEVEL_FATAL 0
+#define OBOE_INIT_LOG_LEVEL_ERROR 1
+#define OBOE_INIT_LOG_LEVEL_WARNING 2
+#define OBOE_INIT_LOG_LEVEL_INFO 3
+#define OBOE_INIT_LOG_LEVEL_DEBUG 4
+#define OBOE_INIT_LOG_LEVEL_PREVIOUS_MEDIUM 5
+#define OBOE_INIT_LOG_LEVEL_TRACE 6
+
+#define OBOE_INIT_LOG_TYPE_STDERR 0
+#define OBOE_INIT_LOG_TYPE_STDOUT 1
+#define OBOE_INIT_LOG_TYPE_FILE 2
+#define OBOE_INIT_LOG_TYPE_NULL 3               // NULL means no output
+#define OBOE_INIT_LOG_TYPE_DISABLE 4            // Explicit disable logging
+
 // token buckets
 enum TOKEN_BUCKETS {
   TOKEN_BUCKET_SAMPLING,    // for normal requests
@@ -864,18 +885,40 @@ oboe_internal_stats_t* oboe_get_internal_stats();
 // Random
 void oboe_random_bytes(uint8_t bytes[], size_t sz);
 
-// oboe logging macro
-#define OBOE_DEBUG_LOG_CONFIG(module, app_name, trace_mode, sample_rate, reporter_type, reporter_args, extra) OBOE_DEBUG_LOG_CONFIG_EX(module, app_name, trace_mode, sample_rate, reporter_type, reporter_args, extra)
-#define OBOE_DEBUG_LOG_FATAL(module, ...) OBOE_DEBUG_LOG_FATAL_EX(module, __VA_ARGS__)
-#define OBOE_DEBUG_LOG_ERROR(module, ...) OBOE_DEBUG_LOG_ERROR_EX(module, __VA_ARGS__)
-#define OBOE_DEBUG_LOG_WARNING(module, ...) OBOE_DEBUG_LOG_WARNING_EX(module, __VA_ARGS__)
-#define OBOE_DEBUG_LOG_INFO(module, ...) OBOE_DEBUG_LOG_INFO_EX(module, __VA_ARGS__)
-#define OBOE_DEBUG_LOG_LOW(module, ...) OBOE_DEBUG_LOG_LOW_EX(module, __VA_ARGS__)
-#define OBOE_DEBUG_LOG_MEDIUM(module, ...) OBOE_DEBUG_LOG_MEDIUM_EX(module, __VA_ARGS__)
-#define OBOE_DEBUG_LOG_HIGH(module, ...) OBOE_DEBUG_LOG_HIGH_EX(module, __VA_ARGS__)
+// oboe logging macro (Phasing out marco)
+#define OBOE_DEBUG_LOG_CONFIG(module, app_name, trace_mode, sample_rate, reporter_type, reporter_args, extra) do {} while(0)
+#define OBOE_DEBUG_LOG_FATAL(module, ...) do {} while(0)
+#define OBOE_DEBUG_LOG_ERROR(module, ...) do {} while(0)
+#define OBOE_DEBUG_LOG_WARNING(module, ...) do {} while(0)
+#define OBOE_DEBUG_LOG_INFO(module, ...) do {} while(0)
+#define OBOE_DEBUG_LOG_LOW(module, ...) do {} while(0)
+#define OBOE_DEBUG_LOG_MEDIUM(module, ...) do {} while(0)
+#define OBOE_DEBUG_LOG_HIGH(module, ...) do {} while(0)
 
 void oboe_init_once();
 
+/**
+ * Request Counts function
+ * If succeed, it can get the value and reset the value to 0
+ * @param value output value
+ * @return bool
+ */
+bool oboe_consume_request_count(unsigned int* value);
+bool oboe_consume_token_bucket_exhaustion_count(unsigned int* value);
+bool oboe_consume_trace_count(unsigned int* value);
+bool oboe_consume_sample_count(unsigned int* value);
+bool oboe_consume_through_ignored_count(unsigned int* value);
+bool oboe_consume_through_trace_count(unsigned int* value);
+bool oboe_consume_triggered_trace_count(unsigned int* value);
+/**
+ * Request Counts function
+ * If succeed, it can get the value
+ * @param value output value
+ * @return bool
+ */
+bool oboe_get_last_used_sample_rate(unsigned int* value);
+bool oboe_get_last_used_sample_source(unsigned int* value);
+
 #ifdef __cplusplus
 } // extern "C"
 #endif

data/ext/oboe_metal/src/oboe_api.cpp

@@ -447,9 +447,6 @@ bool Event::sendProfiling() {
     size_t len = (size_t)(this->bbuf.cur - this->bbuf.buf);
     retval = oboe_raw_send(OBOE_SEND_PROFILING, this->bb_str, len);
 
-    if (retval < 0)
-        OBOE_DEBUG_LOG_ERROR(OBOE_MODULE_LIBOBOE, "Raw send failed - reporter returned %d", retval);
-
     return (retval >= 0);
 }
 
@@ -589,11 +586,12 @@ Reporter::Reporter(
     std::string grpc_proxy,         // HTTP proxy address and port to be used for the gRPC connection
     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 metric_format               // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
+    int metric_format,              // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
+    int log_type                    // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
 ) {
     oboe_init_options_t options;
     memset(&options, 0, sizeof(options));
-    options.version = 15;
+    options.version = 16;
     oboe_init_options_set_defaults(&options);
 
     if (hostname_alias != "") {
@@ -629,11 +627,12 @@ Reporter::Reporter(
     }
     options.stdout_clear_nonblocking = stdout_clear_nonblocking;
     options.metric_format = metric_format;
+    options.log_type = log_type;
     init_status = oboe_init(&options);
 }
 
 Reporter::~Reporter() {
-    oboe_reporter_destroy(this);
+    oboe_shutdown();
 }
 
 bool Reporter::sendReport(Event *evt, bool with_system_timestamp) {
@@ -690,3 +689,103 @@ bool Config::checkVersion(int version, int revision) {
 std::string Config::getVersionString() {
     return oboe_config_get_version_string();
 }
+
+// ===================================================================================================
+OboeAPI::OboeAPI(const OboeAPIOptions& options) {
+    oboe_init_options_t oboe_options;
+    memset(&oboe_options, 0, sizeof(oboe_options));
+    oboe_options.version = 16;
+    oboe_init_options_set_defaults(&oboe_options);
+    oboe_options.log_level = options.logging_options.level;
+    oboe_options.log_type = options.logging_options.type;
+    oboe_init(&oboe_options);
+}
+
+OboeAPI::~OboeAPI() {
+    oboe_shutdown();
+}
+
+void OboeAPI::getTracingDecision(
+        // output
+        int *do_metrics,
+        int *do_sample,
+        int *sample_rate,
+        int *sample_source,
+        double *bucket_rate,
+        double *bucket_cap,
+        int *type,
+        int *auth,
+        std::string *status_msg,
+        std::string *auth_msg,
+        int *status,
+        // input
+        const char *in_xtrace,
+        const char *tracestate,
+        int custom_tracing_mode,
+        int custom_sample_rate,
+        int request_type,
+        int custom_trigger_mode,
+        const char *header_options,
+        const char *header_signature,
+        long header_timestamp) {
+    oboe_tracing_decisions_in_t tdi;
+    memset(&tdi, 0, sizeof(tdi));
+    tdi.version = 3;
+
+    tdi.custom_tracing_mode = custom_tracing_mode;
+    tdi.custom_sample_rate = custom_sample_rate;
+    tdi.custom_trigger_mode = custom_trigger_mode;
+    tdi.request_type = request_type;
+
+    tdi.in_xtrace = in_xtrace;
+    tdi.tracestate = tracestate; // value of sw member in tracestate, ignored when not in w3c mode
+    tdi.header_options = header_options;
+    tdi.header_signature = header_signature;
+    tdi.header_timestamp = header_timestamp;
+
+    oboe_tracing_decisions_out_t tdo;
+    memset(&tdo, 0, sizeof(tdo));
+    tdo.version = 3;
+
+    *status = oboe_tracing_decisions(&tdi, &tdo);
+
+    *do_sample = tdo.do_sample;
+    *do_metrics = tdo.do_metrics;
+    *sample_rate = tdo.sample_rate;
+    *sample_source = tdo.sample_source;
+    *bucket_rate = tdo.token_bucket_rate;
+    *bucket_cap = tdo.token_bucket_capacity;
+    *type = tdo.request_provisioned;
+    if (tdo.status_message && tdo.status_message[0] != '\0') {
+        *status_msg = tdo.status_message;
+    }
+    *auth = tdo.auth_status;
+    if (tdo.auth_message && tdo.auth_message[0] != '\0') {
+        *auth_msg = tdo.auth_message;
+    }
+}
+
+bool OboeAPI::consumeRequestCount(unsigned int& counter) {
+    return oboe_consume_request_count(&counter);
+}
+bool OboeAPI::consumeTokenBucketExhaustionCount(unsigned int& counter) {
+    return oboe_consume_token_bucket_exhaustion_count(&counter);
+}
+bool OboeAPI::consumeTraceCount(unsigned int& counter) {
+    return oboe_consume_through_trace_count(&counter);
+}
+bool OboeAPI::consumeSampleCount(unsigned int& counter) {
+    return oboe_consume_sample_count(&counter);
+}
+bool OboeAPI::consumeThroughTraceCount(unsigned int& counter) {
+    return oboe_consume_through_trace_count(&counter);
+}
+bool OboeAPI::consumeTriggeredTraceCount(unsigned int& counter) {
+    return oboe_consume_triggered_trace_count(&counter);
+}
+bool OboeAPI::getLastUsedSampleRate(unsigned int& rate) {
+    return oboe_get_last_used_sample_rate(&rate);
+}
+bool OboeAPI::getLastUsedSampleSource(unsigned int& source) {
+    return oboe_get_last_used_sample_source(&source);
+}

data/ext/oboe_metal/src/oboe_api.h

@@ -102,7 +102,6 @@ class Context {
      * @param newMode One of
      * - OBOE_TRACE_DISABLED(0) to disable tracing,
      * - OBOE_TRACE_ENABLED(1) to start a new trace if needed, or
-     * - OBOE_TRACE_THROUGH(2) to only add to an existing trace.
      */
     static void setTracingMode(int newMode);
 
@@ -463,7 +462,8 @@ class Reporter : private oboe_reporter_t {
         std::string grpc_proxy,         // HTTP proxy address and port to be used for the gRPC connection
         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 metric_format               // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
+        int metric_format,              // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
+        int log_type                    // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
     );
 
     ~Reporter();
@@ -498,4 +498,123 @@ class Config {
     static std::string getVersionString();
 };
 
+struct LoggingOptions {
+    LoggingOptions() : level(2), type(0) {
+    }
+    int level;
+    int type;
+};
+
+struct OboeAPIOptions {
+    LoggingOptions logging_options;
+};
+
+class OboeAPI {
+public:
+    OboeAPI(const OboeAPIOptions& options = OboeAPIOptions());
+    ~OboeAPI();
+    /**
+     * Get tracing decision
+     * @param do_metrics
+     * @param do_sample
+     * @param sample_rate
+     * @param sample_source
+     * @param bucket_rate
+     * @param bucket_cap
+     * @param type
+     * @param auth
+     * @param status_msg
+     * @param auth_msg
+     * @param status
+     * @param in_xtrace
+     * @param tracestate
+     * @param custom_tracing_mode
+     * @param custom_sample_rate
+     * @param request_type
+     * @param custom_trigger_mode
+     * @param header_options
+     * @param header_signature
+     * @param header_timestamp
+     */
+    void getTracingDecision(
+            // SWIG output
+            int *do_metrics,
+            int *do_sample,
+            int *sample_rate,
+            int *sample_source,
+            double *bucket_rate,
+            double *bucket_cap,
+            int *type,
+            int *auth,
+            std::string *status_msg,
+            std::string *auth_msg,
+            int *status,
+            // SWIG input
+            const char *in_xtrace = NULL,
+            const char *tracestate = NULL,
+            int custom_tracing_mode = OBOE_SETTINGS_UNSET,
+            int custom_sample_rate = OBOE_SETTINGS_UNSET,
+            int request_type = 0,
+            int custom_trigger_mode = 0,
+            const char *header_options = NULL,
+            const char *header_signature = NULL,
+            long header_timestamp = 0);
+    /**
+     * Consume request count
+     * Check the return bool before using the counter, also consumeRequestCount will set the internal counter to 0 after referencing it
+     * @param counter
+     * @return bool
+     */
+    bool consumeRequestCount(unsigned int& counter);
+    /**
+     * Consume token bucket exhaustion count
+     * Check the return bool before using the counter, also consumeTokenBucketExhaustionCount will set the internal counter to 0 after referencing it
+     * @param counter
+     * @return bool
+     */
+    bool consumeTokenBucketExhaustionCount(unsigned int& counter);
+    /**
+     * Consume trace count
+     * Check the return bool before using the counter, also consumeTraceCount will set the internal counter to 0 after referencing it
+     * @param counter
+     * @return bool
+     */
+    bool consumeTraceCount(unsigned int& counter);
+    /**
+     * Consume sample count
+     * Check the return bool before using the counter, also consumeSampleCount will set the internal counter to 0 after referencing it
+     * @param counter
+     * @return bool
+     */
+    bool consumeSampleCount(unsigned int& counter);
+    /**
+     * Consume through trace count
+     * Check the return bool before using the counter, also consumeThroughTraceCount will set the internal counter to 0 after referencing it
+     * @param counter
+     * @return bool
+     */
+    bool consumeThroughTraceCount(unsigned int& counter);
+    /**
+     * Consume triggered trace count
+     * Check the return bool before using the counter, also consumeTriggeredTraceCount will set the internal counter to 0 after referencing it
+     * @param counter
+     * @return bool
+     */
+    bool consumeTriggeredTraceCount(unsigned int& counter);
+    /**
+     * Get last used sample rate
+     * Check the return bool before using the rate
+     * @param rate
+     * @return bool
+     */
+    bool getLastUsedSampleRate(unsigned int& rate);
+    /**
+     * Get last used sample source
+     * Check the return bool before using the source
+     * @param source
+     * @return bool
+     */
+    bool getLastUsedSampleSource(unsigned int& source);
+};
+
 #endif  // OBOE_API_H