lib/opencensus/config.rb in opencensus-0.3.1 vs lib/opencensus/config.rb in opencensus-0.4.0
- old
+ new
@@ -10,20 +10,22 @@
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
+
require "opencensus/common/config"
module OpenCensus
# The OpenCensus overall configuration.
@config = Common::Config.new
class << self
##
- # Configure OpenCensus. Most configuration parameters are part of
- # subconfigurations that live under this main configuration.
+ # Configure OpenCensus. Most configuration parameters are defined in
+ # subconfigurations that live under this main configuration. See, for
+ # example, {OpenCensus::Trace.configure}.
#
# If the OpenCensus Railtie is installed in a Rails application, the
# toplevel configuration object is also exposed as `config.opencensus`.
#
# Generally, you should configure this once at process initialization,
@@ -31,10 +33,10 @@
#
# Example:
#
# OpenCensus.configure do |config|
# config.trace.default_sampler =
- # OpenCensus::Trace::Samplers::AlwaysSample.new
+ # OpenCensus::Trace::Samplers::RateLimiting.new
# config.trace.default_max_attributes = 16
# end
#
def configure
if block_given?