oboe.hpp in oboe-heroku-0.8.0.9

- old
+ new

@@ -6,11 +6,11 @@
 
 #ifndef OBOE_HPP
 #define OBOE_HPP
 
 #include <string>
-#include <oboe.h>
+#include <oboe/oboe.h>
 
 
 class Event;
 class Reporter;
 class Context;
@@ -114,22 +114,22 @@
     static void setDefaultSampleRate(int newRate) {
         oboe_settings_cfg_sample_rate_set(newRate);
     }
 
     /**
-     *  Check if the current request should be sampled based on settings.
+     * Check if the current request should be traced based on the current 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 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.  Also special rules for AppView
+     * Web synthetic traces apply if in_tv_meta is given a non-empty string.
      *
-     *  If a valid X-TV-Meta identifier is provided and AppView Web sample
-     *  always is enabled then return true independent of the other conditions.
+     * 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 True if we should trace; otherwise false.
+     *  @return True if the request should be traced; otherwise false.
      */
     static bool sampleRequest(
         std::string layer,
         std::string in_xtrace,
         std::string in_tv_meta)