opencensus 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42681c2940ade96a318ba521ab0c6d28064a5084
-  data.tar.gz: 06b1d23140c3bb582ba11b0d05c918585c4d073e
+  metadata.gz: fcd6b186ce0092ad6cf63ec39de790c05ba2a8e5
+  data.tar.gz: d23b444fb33a05c2333d745e72a956217239a622
 SHA512:
-  metadata.gz: 132b2e15377b4a6eddb3ca5688fde6dc709bad8189175acd0fb3226840c7bdd5ca01014fc520b18212c808ece97fd21a88860884fbdb016245d841d8f897d413
-  data.tar.gz: 3bed182ab9c3d94f8043e7ce98bcde78da6ce7fefdef8356b320845dffdf0383e2ad5b090e148261244dbc95e188f96c3740df67129432b51f7a24dce480307a
+  metadata.gz: 59fdc1eaacc8e1f6616fc6948a78338756af8091d0be7ee5bd953270cdd2d48051048f72b56a7e9c030afea97d9f4dfe9356655586ef6dd4e672646715a495bc
+  data.tar.gz: a9879fbf66e97502c4c35ad4ea99365a17865138bfb4c05eb3701797b4c41990bc3bf48b7431ffb1ca01f4b3c55c824da7a2ec59c9b9bc4d8d66ec9bdc4eaf5e

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenCensus
+--markup markdown
+./lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History
 
+### 0.3.1 / 2018-04-13
+
+* Clean unneeded files from the gem
+
 ### 0.3.0 / 2018-03-26
 
 * SpanContext#build_contained_spans honors sampling bit.

data/lib/opencensus/version.rb

@@ -14,5 +14,5 @@
 
 module OpenCensus
   ## Current OpenCensus version
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: opencensus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jeff Ching
 - Daniel Azuma
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,28 +145,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
+- ".yardopts"
 - AUTHORS
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- docs/.gitignore
-- docs/404.html
-- docs/Gemfile
-- docs/_config.yml
-- docs/_layouts/default.html
-- docs/index.md
-- examples/hello-world/Gemfile
-- examples/hello-world/README.md
-- examples/hello-world/hello.rb
 - lib/opencensus.rb
 - lib/opencensus/common.rb
 - lib/opencensus/common/config.rb
@@ -203,7 +188,6 @@ files:
 - lib/opencensus/trace/trace_context_data.rb
 - lib/opencensus/trace/truncatable_string.rb
 - lib/opencensus/version.rb
-- opencensus.gemspec
 homepage: https://github.com/census-instrumentation/opencensus-ruby
 licenses:
 - Apache-2.0

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-/docs/_site
-/docs/Gemfile.lock
-/docs/api/
-
-/examples/*/Gemfile.lock

data/.rubocop.yml

@@ -1,48 +0,0 @@
-AllCops:
-  Exclude:
-    - "acceptance/**/*"
-    - "integration/**/*"
-    - "opencensus.gemspec"
-    - "Rakefile"
-    - "support/**/*"
-    - "test/**/*"
-    - "docs/**/*"
-    - "tmp/**/*"
-
-Documentation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-Style/MethodDefParentheses:
-  EnforcedStyle: require_no_parentheses
-Style/NumericLiterals:
-  Enabled: false
-Layout/SpaceAroundOperators:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Layout/EmptyLines:
-  Enabled: false
-Style/EmptyElse:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Max: 10
-Metrics/PerceivedComplexity:
-  Max: 10
-Metrics/AbcSize:
-  Max: 25
-Metrics/MethodLength:
-  Max: 20
-Metrics/ParameterLists:
-  Enabled: false
-Style/RescueModifier:
-  Enabled: false
-Style/ClassVars:
-  Enabled: false
-Style/TrivialAccessors:
-  Enabled: false
-Style/CaseEquality:
-  Enabled: false
-Style/GuardClause:
-  Enabled: false

data/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1
-script:
-  - bundle exec rake
-
-deploy:
-  provider: pages
-  local_dir: docs
-  skip_cleanup: true
-  email: chingor@google.com # To satisfy the CLA check, replace this with bot email.
-  github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard
-  on:
-    branch: master

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in opencensus.gemspec
-gemspec

data/Rakefile

@@ -1,24 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "yard"
-
-require "rubocop/rake_task"
-RuboCop::RakeTask.new
-
-Rake::TestTask.new :test do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-YARD::Rake::YardocTask.new do |t|
- t.files   = ['lib/**/*.rb']   # optional
- t.options = ['--output-dir', 'docs/api'] # optional
- t.stats_options = ['--list-undoc']         # optional
-end
-
-task :faster do
-  ENV["FASTER_TESTS"] = "true"
-end
-
-task :default => [:test, :rubocop, :yard]

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "opencensus"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docs/.gitignore

@@ -1,3 +0,0 @@
-_site
-.sass-cache
-.jekyll-metadata

data/docs/404.html

@@ -1,24 +0,0 @@
----
-layout: default
----
-
-<style type="text/css" media="screen">
-  .container {
-    margin: 10px auto;
-    max-width: 600px;
-    text-align: center;
-  }
-  h1 {
-    margin: 30px 0;
-    font-size: 4em;
-    line-height: 1;
-    letter-spacing: -1px;
-  }
-</style>
-
-<div class="container">
-  <h1>404</h1>
-
-  <p><strong>Page not found :(</strong></p>
-  <p>The requested page could not be found.</p>
-</div>

data/docs/Gemfile

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-source "https://rubygems.org"
-
-# Hello! This is where you manage which Jekyll version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-#
-#     bundle exec jekyll serve
-#
-# This will help ensure the proper Jekyll version is running.
-# Happy Jekylling!
-gem "jekyll", "~> 3.6.2"
-
-# This is the default theme for new Jekyll sites. You may change this to anything you like.
-# gem "minima", "~> 2.0"
-gem "jekyll-theme-minimal", "~> 0.1"
-# gem "minimal"
-
-# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-# uncomment the line below. To upgrade, run `bundle update github-pages`.
-# gem "github-pages", group: :jekyll_plugins
-
-# If you have any plugins, put them here!
-group :jekyll_plugins do
-  gem "jekyll-feed", "~> 0.6"
-end
-
-# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
-
-gem "github-pages", group: :jekyll_plugins

data/docs/_config.yml

@@ -1,39 +0,0 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
-title: OpenCensus for Ruby
-email: your-email@example.com
-description: A stats collection and distributed tracing framework
-baseurl: "/opencensus-ruby" # the subpath of your site, e.g. /blog
-url: "http://opencensus.io" # the base hostname & protocol for your site, e.g. http://example.com
-github_username:  census-instrumentation
-
-# Build settings
-markdown: kramdown
-theme: jekyll-theme-minimal
-plugins:
-  - jekyll-feed
-
-# Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
-# exclude:
-#   - Gemfile
-#   - Gemfile.lock
-#   - node_modules
-#   - vendor/bundle/
-#   - vendor/cache/
-#   - vendor/gems/
-#   - vendor/ruby/

data/docs/_layouts/default.html

@@ -1,65 +0,0 @@
-<!doctype html>
-<html lang="{{ site.lang | default: "en-US" }}">
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="chrome=1">
-
-{% seo %}
-
-    <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
-    <meta name="viewport" content="width=device-width">
-    <!--[if lt IE 9]>
-    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-  </head>
-  <body>
-    <div class="wrapper">
-      <header>
-        <h1>{{ site.title | default: site.github.repository_name }}</h1>
-        <p>{{ site.description | default: site.github.project_tagline }}</p>
-
-        {% if site.github.is_project_page %}
-          <p class="view"><a href="{{ site.github.repository_url }}">View the Project on GitHub <small>{{ github_name }}</small></a></p>
-        {% endif %}
-        <p class="view"><a href="{{ '/api' | relative_url }}">View the API documentation</a>
-
-        {% if site.github.is_user_page %}
-          <p class="view"><a href="{{ site.github.owner_url }}">View My GitHub Profile</a></p>
-        {% endif %}
-
-        {% if site.show_downloads %}
-          <ul>
-            <li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
-            <li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li>
-            <li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
-          </ul>
-        {% endif %}
-      </header>
-      <section>
-
-      {{ content }}
-
-      </section>
-      <footer>
-        {% if site.github.is_project_page %}
-        <p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
-        {% endif %}
-        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
-      </footer>
-    </div>
-    <script src="{{ '/assets/js/scale.fix.js' | relative_url }}"></script>
-
-
-  {% if site.google_analytics %}
-    <script>
-        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
-
-        ga('create', '{{ site.google_analytics }}', 'auto');
-        ga('send', 'pageview');
-    </script>
-  {% endif %}
-  </body>
-</html>

data/docs/index.md

@@ -1,151 +0,0 @@
----
-layout: default
----
-
-# OpenCensus for Ruby
-
-OpenCensus provides a framework to measure a server's resource usage and
-collect performance stats. The `opencensus` Rubygem contains the core
-OpenCensus APIs and basic integrations with Rails, Faraday, and GRPC.
-
-The library is in alpha stage, and the API is subject to change.
-
-## Quick Start
-
-### Installation
-
-Install the gem directly:
-
-```sh
-$ gem install opencensus
-```
-
-Or install through Bundler:
-
-1. Add the `opencensus` gem to your Gemfile:
-
-```ruby
-gem "opencensus"
-```
-
-2. Use Bundler to install the gem:
-
-```sh
-$ bundle install
-```
-
-### Getting started with Ruby on Rails
-
-The OpenCensus library provides a Railtie that integrates with Ruby On Rails,
-automatically tracing incoming requests in the application. It also
-automatically traces key processes in your application such as database queries
-and view rendering.
-
-To enable Rails integration, require this file during application startup:
-
-```ruby
-# In config/application.rb
-require "opencensus/trace/integrations/rails"
-```
-
-### Getting started with other Rack-based frameworks
-
-Other Rack-based frameworks, such as Sinatra, can use the Rack Middleware
-integration, which automatically traces incoming requests. To enable the
-integration for a non-Rails Rack framework, add the middleware to your
-middleware stack.
-
-```ruby
-# In config.ru or similar Rack configuration file
-require "opencensus/trace/integrations/rack_middleware"
-use OpenCensus::Trace::Integrations::RackMiddleware
-```
-
-## Instrumentation features
-
-### Tracing outgoing HTTP requests
-
-If your app uses the [Faraday](https://github.com/lostisland/faraday) library
-to make outgoing HTTP requests, consider installing the Faraday Middleware
-integration. This integration creates a span for each outgoing Faraday request,
-tracking the latency of that request, and propagates distributed trace headers
-into the request so you can potentially connect your request trace with that of
-the remote service. Here is an example:
-
-```ruby
-conn = Faraday.new(url: "http://www.example.com") do |c|
-  c.use OpenCensus::Trace::Integrations::FaradayMiddleware
-  c.adapter Faraday.default_adapter
-  end
-conn.get "/"
-```
-
-See the documentation for the
-[FaradayMiddleware](http://opencensus.io/opencensus-ruby/api/OpenCensus/Trace/Integrations/FaradayMiddleware.html)
-class for more info.
-
-### Adding Custom Trace Spans
-
-In addition to the spans added by the Rails integration (e.g. for database
-queries) and by Faraday integration for outgoing HTTP requests, you can add
-additional custom spans to the request trace:
-
-```ruby
-OpenCensus::Trace.in_span "my_task" do |span|
-  # Do stuff...
-
-  OpenCensus::Trace.in_span "my_subtask" do |subspan|
-    # Do other stuff
-  end
-end
-```
-
-See the documentation for the
-[OpenCensus::Trace](http://opencensus.io/opencensus-ruby/api/OpenCensus/Trace.html)
-module for more info.
-
-### Exporting traces
-
-By default, OpenCensus will log request trace data as JSON. To export traces to
-your favorite analytics backend, install an export plugin. There are plugins
-currently being developed for Stackdriver, Zipkin, and other services.
-
-### Configuring the library
-
-OpenCensus allows configuration of a number of aspects via the configuration
-class. The following example illustrates how that looks:
-
-```ruby
-OpenCensus.configure do |c|
-  c.trace.default_sampler = OpenCensus::Trace::Samplers::AlwaysSample.new
-  c.trace.default_max_attributes = 16
-end
-```
-
-If you are using Rails, you can equivalently use the Rails config:
-
-```ruby
-config.opencensus.trace.default_sampler =
-  OpenCensus::Trace::Samplers::AlwaysSample.new
-config.opencensus.trace.default_max_attributes = 16
-```
-
-You can configure a variety of core OpenCensuys options, including:
-
-* Sampling, which controls how often a request is traced.
-* Exporting, which controls how trace information is reported.
-* Formatting, which controls how distributed request trace headers are
-  constructed
-* Size maximums, which control when trace data is truncated.
-
-Additionally, integrations and other plugins might have their own
-configurations.
-
-For more information, consult the documentation for
-[OpenCensus.configure](http://opencensus.io/opencensus-ruby/api/OpenCensus.html#configure-class_method)
-and
-[OpenCensus::Trace.configure](http://opencensus.io/opencensus-ruby/api/OpenCensus/Trace.html#configure-class_method).
-
-## Supported Ruby Versions
-
-This library is supported on Ruby 2.0+.

data/examples/hello-world/Gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "faraday", "~> 0.14"
-gem "opencensus", "~> 0.3"
-gem "sinatra", "~> 2.0"

data/examples/hello-world/README.md

@@ -1,33 +0,0 @@
-# Hello World example
-
-This example application demonstrates how to use OpenCensus to record traces for a Sinatra-based web application.
-
-## Prerequisites
-
-Ruby 2.2 or later is required. Make sure you have Bundler installed as well.
-
-    gem install bundler
-
-## Installation
-
-Get the example from the OpenCensus Ruby repository on Github, and cd into the example application directory.
-
-    git clone https://github.com/census-instrumentation/opencensus-ruby.git
-    cd opencensus-ruby/examples/hello-world
-
-Install the dependencies using Bundler.
-
-    bundle install
-
-## Running the example
-
-Run the application locally on your workstation with:
-
-    bundle exec ruby hello.rb
-
-This will run on port 4567 by default, and display application logs on the terminal. From a separate shell, you can send requests using a tool such as curl:
-
-    curl http://localhost:4567/
-    curl http://localhost:4567/lengthy
-
-The running application will log the captured traces.

data/examples/hello-world/hello.rb

@@ -1,59 +0,0 @@
-# Copyright 2018 OpenCensus Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# 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.
-
-
-# This is a simple Sinatra application demonstrating how to record traces
-# using OpenCensus.
-#
-# It uses the OpenCensus Rack middleware to trace all incoming requests. It
-# also demonstrates how to use the Faraday middleware to trace outgoing HTTP
-# requests, as well as how to instrument your code to capture custom spans.
-#
-# By default, the resulting trace data is logged in JSON format. You can also
-# configure OpenCensus to report traces to a backend such as Stackdriver or
-# Zipkin using an exporter plugin library.
-
-require "sinatra"
-
-# Install the Rack middleware to trace incoming requests.
-require "opencensus/trace/integrations/rack_middleware"
-use OpenCensus::Trace::Integrations::RackMiddleware
-
-# Access the Faraday middleware which will be used to trace outgoing HTTP
-# requests.
-require "opencensus/trace/integrations/faraday_middleware"
-
-# Each request will be traced automatically by the middleware.
-get "/" do
-  "Hello world!"
-end
-
-# Traces for this request will also include sub-spans as indicated below.
-get "/lengthy" do
-  # Configure this Faraday connection with a middleware to trace outgoing
-  # requests.
-  conn = Faraday.new(url: "http://www.google.com") do |c|
-    c.use OpenCensus::Trace::Integrations::FaradayMiddleware
-    c.adapter Faraday.default_adapter
-  end
-  conn.get "/"
-
-  # You may instrument your code to create custom spans for long-running
-  # operations.
-  OpenCensus::Trace.in_span "long task" do
-    sleep rand
-  end
-
-  "Done!"
-end

data/opencensus.gemspec

@@ -1,35 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "opencensus/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "opencensus"
-  spec.version       = OpenCensus::VERSION
-  spec.authors       = ["Jeff Ching", "Daniel Azuma"]
-  spec.email         = ["chingor@google.com", "dazuma@google.com"]
-
-  spec.summary       = %q{A stats collection and distributed tracing framework}
-  spec.description   = %q{A stats collection and distributed tracing framework}
-  spec.homepage      = "https://github.com/census-instrumentation/opencensus-ruby"
-  spec.license       = "Apache-2.0"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.2.0"
-
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "minitest-focus", "~> 1.1"
-  spec.add_development_dependency "faraday", "~> 0.13"
-  spec.add_development_dependency "rails", "~> 5.1.4"
-  spec.add_development_dependency "rubocop", "~> 0.52"
-  spec.add_development_dependency "yard", "~> 0.9"
-  spec.add_development_dependency "yard-doctest", "~> 0.1.6"
-end