traceview 3.0.0-java

data/ext/oboe_metal/src/oboe.hpp

@@ -0,0 +1,352 @@
+#ifndef OBOE_HPP
+#define OBOE_HPP
+
+#include <string>
+#include <oboe.h>
+
+
+class Event;
+
+class Metadata : private oboe_metadata_t {
+    friend class UdpReporter;
+    friend class FileReporter;
+    friend class Context;
+
+public:
+    Metadata(oboe_metadata_t *md) {
+        oboe_metadata_copy(this, md);
+    }
+
+    ~Metadata() {
+        oboe_metadata_destroy(this);
+    }
+
+    static Metadata* fromString(std::string s) {
+        oboe_metadata_t md;
+        oboe_metadata_fromstr(&md, s.data(), s.size());
+        return new Metadata(&md); // copies md
+    }
+
+    // these new objects are managed by SWIG %newobject
+    Event *createEvent();
+
+    static Metadata *makeRandom() {
+        oboe_metadata_t md;
+        oboe_metadata_init(&md);
+        oboe_metadata_random(&md);
+        return new Metadata(&md); // copies md
+    }
+
+    Metadata *copy() {
+        return new Metadata(this);
+    }
+
+    bool isValid() {
+        return oboe_metadata_is_valid(this);
+    }
+
+#ifdef SWIGJAVA
+    std::string toStr() {
+#else
+    std::string toString() {
+#endif
+        char buf[OBOE_MAX_METADATA_PACK_LEN];
+
+        int rc = oboe_metadata_tostr(this, buf, sizeof(buf) - 1);
+        if (rc == 0) {
+            return std::string(buf);
+        } else {
+            return std::string(); // throw exception?
+        }
+    }
+
+};
+
+class Context {
+public:
+    /**
+     * Set the tracing mode.
+     *
+     * @param newMode One of
+     * - OBOE_TRACE_NEVER(0) to disable tracing,
+     * - OBOE_TRACE_ALWAYS(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) {
+        oboe_settings_cfg_tracing_mode_set(newMode);
+    }
+
+    /**
+     * Set the default sample rate.
+     *
+     * This rate is used until overridden by the TraceView servers.  If not set then the
+     * value 300,000 will be used (ie. 30%).
+     *
+     * 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) {
+        oboe_settings_cfg_sample_rate_set(newRate);
+    }
+
+    /**
+     * Check if the current request should be traced based on the current settings.
+     *
+     * If xtrace is empty, or if it is identified as a foreign (ie. cross customer)
+     * trace, then sampling will be considered as a new trace.
+     * Otherwise sampling will be considered as adding to the current trace.
+     * Different layers may have special rules.  Also special rules for AppView
+     * Web synthetic traces apply if in_tv_meta is given a non-empty string.
+     *
+     * This is designed to be called once per layer per request.
+     *
+     * @param layer Name of the layer being considered for tracing
+     * @param in_xtrace Incoming X-Trace ID (NULL or empty string if not present)
+     * @param in_tv_meta AppView Web ID from X-TV-Meta HTTP header or higher layer (NULL or empty string if not present).
+     * @return Zero to not trace; otherwise return the sample rate used in the low order
+     *         bytes 0 to 2 and the sample source in the higher-order byte 3.
+     */
+    static int sampleRequest(
+        std::string layer,
+        std::string in_xtrace,
+        std::string in_tv_meta)
+    {
+        int sample_rate = 0;
+        int sample_source = 0;
+        int rc = (oboe_sample_layer(layer.c_str(), in_xtrace.c_str(), in_tv_meta.c_str(), &sample_rate, &sample_source));
+
+        return (rc == 0 ? 0 : (((sample_source & 0xFF) << 24) | (sample_rate & 0xFFFFFF)));
+    }
+
+    // returns pointer to current context (from thread-local storage)
+    static oboe_metadata_t *get() {
+        return oboe_context_get();
+    }
+
+#ifdef SWIGJAVA
+    static std::string toStr() {
+#else
+    static std::string toString() {
+#endif
+        char buf[OBOE_MAX_METADATA_PACK_LEN];
+
+        oboe_metadata_t *md = Context::get();
+        int rc = oboe_metadata_tostr(md, buf, sizeof(buf) - 1);
+        if (rc == 0) {
+            return std::string(buf);
+        } else {
+            return std::string(); // throw exception?
+        }
+    }
+
+    static void set(oboe_metadata_t *md) {
+        oboe_context_set(md);
+    }
+
+    static void fromString(std::string s) {
+        oboe_context_set_fromstr(s.data(), s.size());
+    }
+
+    // this new object is managed by SWIG %newobject
+    static Metadata *copy() {
+        return new Metadata(Context::get());
+    }
+
+    static void clear() {
+        oboe_context_clear();
+    }
+
+    static bool isValid() {
+        return oboe_context_is_valid();
+    }
+
+    static void init() {
+        oboe_init();
+    }
+
+    // these new objects are managed by SWIG %newobject
+    static Event *createEvent();
+    static Event *startTrace();
+};
+
+class Event : private oboe_event_t {
+    friend class UdpReporter;
+    friend class FileReporter;
+    friend class Context;
+    friend class Metadata;
+
+private:
+    Event() {
+        oboe_event_init(this, Context::get());
+    }
+
+    Event(const oboe_metadata_t *md, bool addEdge=true) {
+        // both methods copy metadata from md -> this
+        if (addEdge) {
+            // create_event automatically adds edge in event to md
+            oboe_metadata_create_event(md, this);
+        } else {
+            // initializes new Event with this md's task_id & new random op_id; no edges set
+            oboe_event_init(this, md);
+        }
+    }
+
+public:
+    ~Event() {
+        oboe_event_destroy(this);
+    }
+
+    // called e.g. from Python e.addInfo("Key", None) & Ruby e.addInfo("Key", nil)
+    bool addInfo(char *key, void* val) {
+        // oboe_event_add_info(evt, key, NULL) does nothing
+        (void) key;
+        (void) val;
+        return true;
+    }
+
+    bool 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;
+        }
+    }
+
+    bool addInfo(char *key, long val) {
+        int64_t val_ = val;
+        return oboe_event_add_info_int64(this, key, val_) == 0;
+    }
+
+    bool addInfo(char *key, double val) {
+        return oboe_event_add_info_double(this, key, val) == 0;
+    }
+
+    bool addEdge(oboe_metadata_t *md) {
+        return oboe_event_add_edge(this, md) == 0;
+    }
+
+    bool addEdgeStr(const std::string& val) {
+        return oboe_event_add_edge_fromstr(this, val.c_str(), val.size()) == 0;
+    }
+
+    Metadata* getMetadata() {
+        return new Metadata(&this->metadata);
+    }
+
+    std::string metadataString() {
+        char buf[OBOE_MAX_METADATA_PACK_LEN];
+
+        int rc = oboe_metadata_tostr(&this->metadata, buf, sizeof(buf) - 1);
+        if (rc == 0) {
+            return std::string(buf);
+        } else {
+            return std::string(); // throw exception?
+        }
+    }
+
+    static Event* startTrace(const oboe_metadata_t *md);
+
+};
+
+Event *Context::createEvent() {
+    return new Event(Context::get());
+}
+
+Event *Metadata::createEvent() {
+    return new Event(this);
+}
+
+Event *Context::startTrace() {
+    oboe_metadata_t *md = Context::get();
+    oboe_metadata_random(md);
+    return new Event();
+}
+
+Event *Event::startTrace(const oboe_metadata_t *md) {
+    return new Event(md, false);
+}
+
+class UdpReporter : private oboe_reporter_t {
+public:
+    UdpReporter(const char *addr, const char *port=NULL) {
+        if (port == NULL)
+            port = "7831";
+
+        oboe_reporter_udp_init(this, addr, port);
+    }
+
+    ~UdpReporter() {
+        oboe_reporter_destroy(this);
+    }
+
+    bool sendReport(Event *evt) {
+        return oboe_reporter_send(this, Context::get(), evt) >= 0;
+    }
+
+    bool sendReport(Event *evt, oboe_metadata_t *md) {
+        return oboe_reporter_send(this, md, evt) >= 0;
+    }
+};
+
+class FileReporter : private oboe_reporter_t {
+public:
+    FileReporter(const char *file) {
+        oboe_reporter_file_init(this, file);
+    }
+
+    ~FileReporter() {
+        oboe_reporter_destroy(this);
+    }
+
+    bool sendReport(Event *evt) {
+        return oboe_reporter_send(this, Context::get(), evt) >= 0;
+    }
+
+    bool sendReport(Event *evt, oboe_metadata_t *md) {
+        return oboe_reporter_send(this, md, evt) >= 0;
+    }
+};
+
+
+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) {
+        return (oboe_config_check_version(version, revision) != 0);
+    }
+
+    /**
+     * Get the Oboe library version number.
+     *
+     * This number increments whenever an incompatible change to the API/ABI is made.
+     *
+     * @return The library's version number or -1 if the version is not known.
+     */
+    static int getVersion() {
+        return oboe_config_get_version();
+    }
+
+    /**
+     * Get the Oboe library revision number.
+     *
+     * This number increments whenever a compatible change is made to the
+     * API/ABI (ie. an addition).
+     *
+     * @return The library's revision number or -1 if not known.
+     */
+    static int getRevision() {
+        return oboe_config_get_revision();
+    }
+};
+
+#endif