solarwinds_apm 6.1.2 → 7.0.0.prev1

data/ext/oboe_metal/src/oboe_api.h

@@ -1,621 +0,0 @@
-/**
- * C++ liboboe wrapper primarily for generating SWIG interfaces
- */
-#ifndef OBOE_API_H
-#define OBOE_API_H
-
-#include <unistd.h>
-#include <cstdlib>
-#include <cstring>
-#include <iostream>
-#include <string>
-#include <vector>
-
-#include "oboe.h"
-
-class Event;
-class Reporter;
-class Context;
-
-// exclude some stuff that unnecessarily bloats the swig interface
-#ifndef SWIG
-// FrameData is for profiling and only used via Ruby directly compiled c++ code
-typedef struct frame_data {
-    std::string klass;
-    std::string method;
-    std::string file;
-    int lineno = 0;
-} FrameData;
-#endif  // SWIG exclusion
-
-/**
- * Metadata is the X-Trace identifier and the information needed to work with it.
- */
-class Metadata : private oboe_metadata_t {
-    friend class Reporter;
-    friend class Context;
-public:
-    Metadata(const oboe_metadata_t *md);
-    ~Metadata();
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @return Event*
-     */
-    Event *createEvent();
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @return Metadata*
-     */
-    Metadata *copy();
-    bool isValid();
-    bool isSampled();
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @param sampled bool default=true
-     * @return Metadata*
-     */
-    static Metadata *makeRandom(bool sampled = true);
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @param s std::string
-     * @return Metadata*
-     */
-    static Metadata *fromString(const std::string& s);
-    /**
-     * Return this pointer
-     * No Object ownership changed via SWIG
-     * @return oboe_metadata_t*
-     */
-    oboe_metadata_t *metadata();
-#ifdef SWIGJAVA
-    std::string toStr();
-#else
-    std::string toString();
-#endif
-};
-
-/**
- * The Context class manages the metadata and the settings configuration.
- *
- * The metadata includes the X-Trace identifier fields and the information work working with it.
- * The metadata is needed before any trace messages can be sent and must either be generated for
- * new traces or derived from the X-Trace header of an existing trace.
- *
- * The settings information is used primarily to determine when a new request should be traced.
- * The information begins with configuration values for tracing_mode and sample_rate and then
- * updates are received periodically from the collector to adjust the rate at which traces
- * are generated.
- */
-class Context {
-   public:
-    /**
-     * Set the tracing mode.
-     *
-     * @param newMode One of
-     * - OBOE_TRACE_DISABLED(0) to disable tracing,
-     * - OBOE_TRACE_ENABLED(1) to start a new trace if needed, or
-     */
-    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.
-     *
-     * This rate is used until overridden by the AppOptics servers.  If not set then the
-     * value comes from settings records downloaded from AppOptics.
-     *
-     * The rate is interpreted as a ratio out of OBOE_SAMPLE_RESOLUTION (currently 1,000,000).
-     *
-     * @param newRate A number between 0 (none) and OBOE_SAMPLE_RESOLUTION (a million)
-     */
-    static void setDefaultSampleRate(int newRate);
-
-    /**
-     * Ask the collector for the final tracing decisions
-     *
-     * call once per request
-     *
-     * when compiled via SWIG this function takes 0-8 input argss and returns 9 output args
-     *
-     * inputs (0-8, all optional):
-     * @param in_xtrace, a valid xtrace string
-     * @param tracestate, value of sw member in tracestate, ignored when not in w3c mode
-     * @param custom_sample_rate, 0-1000000
-     * @param custom_tracing_mode, 0(disabled) or 1(enabled)
-     * @param request_type, 0 normal sampling, 1 trigger trace
-     * @param custom_custom_trigger_mode, 0(disabled) or 1(enabled)
-     * @param header_options, the string from the X-Trace-Options header
-     * @param header_signature, the string from the X-Trace-Options-Signature header
-     * @param header_timestamp, the timestamp inside the X-Trace-Options header
-     *
-     * returns:
-     * @param do_metrics, ignore when using SWIG, it will be mapped to the first return value
-     * @param do_sample, ignore when using SWIG, it will be mapped to the second return value
-     * @param sample_rate, ignore when using SWIG, it will be mapped to the third return value
-     * @param sample_source, ignore when using SWIG, it will be mapped to the forth return value
-     * @param type, 0 normal sampling, 1 - trigger trace
-     * @param auth, 0 success, 1 failure, -1 not requested
-     * @param status_msg, message describing the trigger tracing decision
-     * @param auth_msg, message describing the success/failure of the authorization
-     *
-     * @status one of the OBOE_TRACING_DECISION_* codes
-     */
-
-    static void getDecisions(
-        // 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 = 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);
-
-    /**
-     * Return a pointer to the current context
-     * Return a pointer in C++ heap
-     * No object ownership changed via SWIG
-     * @return oboe_metadata_t*
-     */
-    static oboe_metadata_t *get();
-    /**
-     * Get the current context as a printable string.
-     */
-#ifdef SWIGJAVA
-    static std::string toStr();
-#else
-    static std::string toString();
-#endif
-
-    /**
-     * Set the current context (this updates thread-local storage).
-     */
-    static void set(oboe_metadata_t *md);
-
-    /**
-     * Set the current context from a string.
-     * @param s const std::string&
-     */
-    static void fromString(const std::string& s);
-
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @return Metadata*
-     */
-    static Metadata *copy();
-
-    static void setSampledFlag();
-
-    static void clear();
-
-    static bool isValid();
-
-    static bool isSampled();
-
-    /**
-     * Perform validation and replacement of invalid characters on the given service key.
-     */
-    static std::string validateTransformServiceName(const std::string& service_key);
-
-    /**
-     * Shut down the Oboe library.
-     *
-     * This releases any resources held by the library which may include terminating
-     * child threads.
-     */
-    static void shutdown();
-
-    /**
-     * check if oboe is ready for tracing
-     *
-     * @param timeout an optional timeout (in milli seconds) to block this function until ready
-     * @return one of the return codes (see oboe.h):
-     * - OBOE_SERVER_RESPONSE_UNKNOWN
-     * - OBOE_SERVER_RESPONSE_OK
-     * - OBOE_SERVER_RESPONSE_TRY_LATER
-     * - OBOE_SERVER_RESPONSE_LIMIT_EXCEEDED
-     * - OBOE_SERVER_RESPONSE_INVALID_API_KEY
-     * - OBOE_SERVER_RESPONSE_CONNECT_ERROR
-     */
-    static int isReady(unsigned int timeout);
-
-    /**
-     * check if oboe is running in a AWS Lambda environment
-     */
-    static bool isLambda();
-
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @return Event*
-     */
-    static Event *createEvent();
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @return Event*
-     */
-    static Event *startTrace();
-    /**
-     * Create entry event with user-defined metadata and timestamp
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @param md const oboe_metadata_t *
-     * @param timestamp int64_t
-     * @param parent_md const oboe_metadata_t * default = nullptr
-     * @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
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @param timestamp int64_t
-     * @return Event*
-     */
-    static Event* createEvent(int64_t timestamp);
-    /**
-     * Create exit event with user-defined timestamp
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @param timestamp int64_t
-     * @return Event*
-     */
-    static Event* createExit(int64_t timestamp);
-};
-
-class Event : private oboe_event_t {
-    friend class Reporter;
-    friend class Context;
-    friend class Metadata;
-
-   private:
-    Event();
-    Event(const oboe_metadata_t *md, bool addEdge = true);
-
-   public:
-    ~Event();
-
-    // called e.g. from Python e.addInfo("Key", None) & Ruby e.addInfo("Key", nil)
-    bool addInfo(const char *key, void *val);
-    bool addInfo(const char *key, const std::string& val);
-    bool addInfo(const char *key, long val);
-    bool addInfo(const char *key, double val);
-    bool addInfo(const char *key, bool val);
-    bool addInfo(const char *key, const long *vals, int num);
-
-#ifndef SWIG  // for profiling only used by Ruby gem cpp-code
-    bool addInfo(const char *key, const std::vector<FrameData> &vals);
-#endif
-
-    bool addEdge(oboe_metadata_t *md);
-    bool addContextOpId(const oboe_metadata_t *md);
-
-    bool addHostname();
-
-    /**
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @return Metadata*
-     */
-    Metadata *getMetadata();
-    std::string metadataString();
-    std::string opIdString();
-
-    /**
-     * 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 with_system_timestamp = true);
-
-    /**
-     * Report a profiling event
-     *
-     * This sends the event using the default reporter
-     * It doesn't add a timestamp
-     * The timestamp needs to be precise for profiling and therefore
-     * needs to be added by the agent when the snapshot is taken
-     */
-    bool sendProfiling();
-
-    bool addSpanRef(const oboe_metadata_t *md);
-    bool addProfileEdge(std::string id);
-    /**
-     * Create a new event object using the given metadata context.
-     * NOTE: The metadata context must be unique to the new trace.
-     * Return an `new` C++ object
-     * Object ownership changed via SWIG
-     * SWIG managed the de-allocation using %newobject keyword
-     * @param md const oboe_metadata_t*
-     * @return Event*
-     */
-    static Event *startTrace(const oboe_metadata_t *md);
-};
-
-class Span {
-   public:
-   /**
-    * these functions return the final transaction name
-    * to be used in the exit event of the trace
-    */
-    static std::string createSpan(const char *transaction, const char *domain, const int64_t duration, const int has_error, const char *service_name = NULL);
-
-    static std::string createHttpSpan(const char *transaction, const char *url, const char *domain, const int64_t duration,
-                                      const int status, const char *method, const int has_error, const char *service_name = NULL);
-};
-
-class MetricTags {
-    friend class CustomMetrics;
-
-   public:
-    MetricTags(size_t count);
-    ~MetricTags();
-    bool add(size_t index, const char *k, const char *v);
-    /**
-     * Get oboe_metric_tag_t function
-     * Please note that SWIG doesn't have the definition of
-     * oboe_metric_tag_t.
-     * Ruby and Python should not call this method
-     *
-     * Return tags as pointer.
-     * No object ownership changed via SWIG
-     * @return oboe_metric_tag_t*
-     */
-    oboe_metric_tag_t *get() const;
-   private:
-    oboe_metric_tag_t *tags;
-    size_t size;
-};
-
-class CustomMetrics {
-   public:
-    static int summary(const char *name, const double value, const int count, const int host_tag,
-                       const char *service_name, const MetricTags *tags, size_t tags_count);
-
-    static int increment(const char *name, const int count, const int host_tag,
-                         const char *service_name, const MetricTags *tags, size_t tags_count);
-};
-
-#ifndef SWIG  // for profiling only used by Ruby gem c++-code
-class OboeProfiling {
-    public:
-     static int get_interval();
-};
-#endif
-
-class Reporter : private oboe_reporter_t {
-    friend class Context;  // Access to the private oboe_reporter_t base structure.
-   public:
-    int init_status;
-
-    /**
-      * Initialize a reporter structure.
-      *
-      * See the wrapped Context::init for more details.
-      *
-      * @params  these correspond to the keys of the oboe_init_options struct
-      */
-    Reporter(
-        std::string hostname_alias,  // optional hostname alias
-        int log_level,               // level at which log messages will be written to log file (0-6)
-        std::string 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
-        int events_flush_interval,   // events flush timeout in seconds (threshold for batching messages before sending off)
-        int max_request_size_bytes,  // events flush batch size in KB (threshold for batching messages before sending off)
-
-        std::string reporter,      // the reporter to be used ("ssl", "upd", "file", "null")
-        std::string host,          // collector endpoint (reporter=ssl), udp address (reporter=udp), or file path (reporter=file)
-        std::string service_key,   // the service key (also known as access_key)
-        std::string certificates,  // content of SSL certificates, passed to gRPC::SslCredentialsOptions() for collector connection verification
-
-        int buffer_size,                // size of the message buffer
-        int trace_metrics,              // flag indicating if trace metrics reporting should be enabled (default) or disabled
-        int histogram_precision,        // the histogram precision (only for ssl)
-        double token_bucket_capacity,   // custom token bucket capacity
-        double token_bucket_rate,       // custom token bucket rate
-        int file_single,                // use single files in file reporter for each event
-
-        int ec2_metadata_timeout,       // the timeout (milli seconds) for retrieving EC2 metadata
-        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 log_type,                   // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
-        int defer_init                  // defer init (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
-    );
-
-    ~Reporter();
-
-    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();
-};
-
-class Config {
-   public:
-    /**
-     * Check if the Oboe library is compatible with a given version.revision.
-     *
-     * This will succeed if the library is at least as recent as specified and if no
-     * definitions have been removed since that revision.
-     *
-     * @param version The library's version number which increments every time the API changes.
-     * @param revision The revision of the current version of the library.
-     * @return Non-zero if the Oboe library is considered compatible with the specified revision.
-     */
-    static bool checkVersion(int version, int revision);
-
-    /**
-     * Get the complete Oboe library version number as a string, e.g. '10.0.3'
-     *
-     * @return The library's version string
-     */
-    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

data/ext/oboe_metal/src/oboe_debug.h

@@ -1,17 +0,0 @@
-#ifndef _OBOE_DEBUG_H
-#define _OBOE_DEBUG_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-typedef void (*OboeDebugLoggerFcn)(void *context, int level, const char *source_name, int source_lineno, const char *msg);
-
-// Add or update a callback function to get log details
-int oboe_debug_log_add(OboeDebugLoggerFcn newLogger, void *context);
-
-#ifdef __cplusplus
-} // extern "C"
-#endif
-
-#endif // _OBOE_DEBUG_H