oboe.hpp in oboe-2.1.4

- old
+ new

@@ -1,18 +1,11 @@
-// Copyright (c) 2012 by Tracelytics, Inc.
-// All rights reserved.
-
 #ifndef OBOE_HPP
 #define OBOE_HPP
 
 #include <string>
-#include <oboe/oboe.h>
+#include <oboe.h>
 
-// oboe prefix added in liboboe 1.0
-#ifndef MAX_METADATA_PACK_LEN
-#define MAX_METADATA_PACK_LEN OBOE_MAX_METADATA_PACK_LEN
-#endif
 
 class Event;
 
 class Metadata : private oboe_metadata_t {
     friend class UdpReporter;
@@ -55,11 +48,11 @@
 #ifdef SWIGJAVA
     std::string toStr() {
 #else
     std::string toString() {
 #endif
-        char buf[MAX_METADATA_PACK_LEN];
+        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 {
@@ -69,21 +62,70 @@
 
 };
 
 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 sampled based on settings.
+     *
+     *  If in_xtrace is empty, 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.
+     *
+     *  If a valid X-TV-Meta identifier is provided and AppView Web sample
+     *  always is enabled then return true independent of the other conditions.
+     *
+     *  @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 True if we should trace; otherwise false.
+     */
+    static bool sampleRequest(
+        std::string layer,
+        std::string in_xtrace,
+        std::string in_tv_meta)
+    {
+        return (oboe_sample_layer(layer.c_str(), in_xtrace.c_str(), in_tv_meta.c_str(), NULL, NULL));
+    }
+
     // 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[MAX_METADATA_PACK_LEN];
+        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);
@@ -150,10 +192,12 @@
     }
 
     // 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())) {
@@ -174,16 +218,20 @@
 
     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[MAX_METADATA_PACK_LEN];
+        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 {
@@ -251,6 +299,48 @@
 
     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