Skip to content

Commit 3bbe349

Browse files
author
Lin Lin
committed
Update docs, support, github and other AppNeta references
1 parent db06514 commit 3bbe349

File tree

14 files changed

+51
-62
lines changed

14 files changed

+51
-62
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
For the latest release info, see here:
3-
https://github.com/appneta/ruby-traceview/releases
3+
https://github.com/tracelytics/ruby-traceview/releases
44

55
Dates in this file are in the format MM/DD/YYYY.
66

CONFIG.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,4 @@ Name | Description | Default
2929

3030
`TraceView::Config` is a nested hash used by the traceview gem to store preferences and switches.
3131

32-
See [this Rails generator template file](https://github.com/appneta/oboe-ruby/blob/master/lib/rails/generators/traceview/templates/traceview_initializer.rb) for documentation on all of the supported values.
33-
32+
See [this Rails generator template file](https://github.com/tracelytics/oboe-ruby/blob/master/lib/rails/generators/traceview/templates/traceview_initializer.rb) for documentation on all of the supported values.

README.md

+27-34
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# Welcome to the TraceView Ruby Gem
22

3-
The traceview gem provides AppNeta [TraceView](http://www.appneta.com/application-performance-management/) performance instrumentation for Ruby.
3+
The traceview gem provides [TraceView](https://traceview.solarwinds.com/) performance instrumentation for Ruby.
44

5-
![Ruby TraceView](https://s3.amazonaws.com/pglombardo/oboe-ruby-header.png)
5+
![Ruby TraceView](http://docs.traceview.solarwinds.com/images/ruby_readme/oboe-ruby-header.png)
66

7-
It has the ability to report performance metrics on an array of libraries, databases and frameworks such as Rails, Mongo, Memcache, ActiveRecord, Cassandra, Rack, Resque [and more](https://docs.appneta.com/ruby-instrumentation-supported-components)
7+
It has the ability to report performance metrics on an array of libraries, databases and frameworks such as Rails, Mongo, Memcache, ActiveRecord, Cassandra, Rack, Resque [and more](http://docs.traceview.solarwinds.com/Instrumentation/ruby.html#ruby-support-matrix).
88

9-
It requires a [TraceView](http://www.appneta.com/products/traceview/) account to view metrics. Get yours, [it's free](http://www.appneta.com/products/traceview-free-account/).
9+
It requires a [TraceView](https://traceview.solarwinds.com/) account to view metrics. Get yours, [it's free](https://traceview.solarwinds.com/TraceView/Signup).
1010

1111
[![Gem Version](https://badge.fury.io/rb/traceview.png)](https://badge.fury.io/rb/traceview)
12-
[![Build Status](https://travis-ci.org/appneta/ruby-traceview.png?branch=master)](https://travis-ci.org/appneta/ruby-traceview)
13-
[![Code Climate](https://codeclimate.com/github/appneta/ruby-traceview.png)](https://codeclimate.com/github/appneta/ruby-traceview)
12+
[![Build Status](https://travis-ci.org/tracelytics/ruby-traceview.png?branch=master)](https://travis-ci.org/tracelytics/ruby-traceview)
13+
[![Code Climate](https://codeclimate.com/github/tracelytics/ruby-traceview.png)](https://codeclimate.com/github/tracelytics/ruby-traceview)
1414

15-
_Note: The repository name has been changed to ruby-traceview. Please update your github remotes with `git remote set-url origin git@github.com:appneta/ruby-traceview.git`._
15+
_Note: The repository name has been changed to ruby-traceview. Please update your github remotes with `git remote set-url origin git@github.com:tracelytics/ruby-traceview.git`._
1616

1717
# Installation
1818

19-
_Before installing the gem below, make sure that you have the [base packages](http://docs.appneta.com/installation-overview#1-install-base-packages) installed on your host first._
19+
_Before installing the gem below, make sure that you have the [base packages](http://docs.traceview.solarwinds.com/TraceView/install-instrumentation.html#install-base-packages) installed on your host first._
2020

2121
The traceview gem is [available on Rubygems](https://rubygems.org/gems/traceview) and can be installed with:
2222

@@ -34,15 +34,15 @@ gem 'traceview'
3434

3535
## Rails
3636

37-
![Ruby on Rails](http://www.appneta.com/images/logos/frameworks/rails.png)
37+
![Ruby on Rails](http://docs.traceview.solarwinds.com/images/ruby_readme/rails.png)
3838

3939
No special steps are needed to instrument Ruby on Rails. Once part of the bundle, the traceview gem will automatically detect Rails and instrument on stack initialization.
4040

4141
*Note: You will still need to decide on your `tracing_mode` depending on whether you are running with an instrumented Apache or nginx in front of your Rails stack. See below for more details.*
4242

4343
### The Install Generator
4444

45-
The traceview gem provides a Rails generator used to seed an initializer where you can configure and control `tracing_mode` and [other options](https://docs.appneta.com/configuring-ruby-instrumentation)
45+
The traceview gem provides a Rails generator used to seed an initializer where you can configure and control `tracing_mode` and [other options](http://docs.traceview.solarwinds.com/Instrumentation/ruby.html#configuring-instrumentation).
4646

4747
To run the install generator run:
4848

@@ -54,7 +54,7 @@ After the prompts, this will create an initializer: `config/initializers/tracevi
5454

5555
## Sinatra
5656

57-
![Sinatra](http://www.appneta.com/images/logos/frameworks/sinatra.png)
57+
![Sinatra](http://docs.traceview.solarwinds.com/images/ruby_readme/sinatra.png)
5858

5959
You can instrument your Sinatra application by adding the following code to your `config.ru` Rackup file:
6060

@@ -79,7 +79,7 @@ With this, the traceview gem will automatically detect Sinatra on boot and instr
7979

8080
## Padrino
8181

82-
![Padrino](http://www.appneta.com/images/logos/frameworks/padrino.png)
82+
![Padrino](http://docs.traceview.solarwinds.com/images/ruby_readme/padrino.png)
8383

8484
As long as the traceview gem is in your `Gemfile` (inserted after the `gem 'padrino'` directive) and you are calling `Bundler.require`, the traceview gem will automatically instrument Padrino applications.
8585

@@ -98,21 +98,21 @@ end
9898

9999
## Grape
100100

101-
![Grape](http://www.appneta.com/images/logos/frameworks/grape.png)
101+
![Grape](http://docs.traceview.solarwinds.com/images/ruby_readme/grape.png)
102102

103103
You can instrument your Grape application by adding the following code to your `config.ru` Rackup file:
104104

105105
```ruby
106106
# If you're not using Bundler.require. Make sure this is done
107107
# after the Grape require directive.
108108
require 'traceview'
109-
109+
110110
# When traces should be initiated for incoming requests. Valid options are
111111
# "always", "through" (when the request is initiated with a tracing header
112112
# from upstream) and "never". You must set this directive to "always" in
113113
# order to initiate tracing.
114114
TraceView::Config[:tracing_mode] = 'through'
115-
115+
116116
...
117117

118118
class App < Grape::API
@@ -146,7 +146,7 @@ Once inside of the `TraceView::API.start_trace` block, performance metrics will
146146

147147
## Other
148148

149-
You can send deploy notifications to TraceView and have the events show up on your dashboard. See: [Capistrano Deploy Notifications with tlog](https://docs.appneta.com/capistrano-deploy-notifications-tlog)
149+
You can send deploy notifications to TraceView and have the events show up on your dashboard. See: [Capistrano Deploy Notifications with tlog](http://docs.traceview.solarwinds.com/Instrumentation/ruby.html#report-deploy-notifications)
150150

151151
# Custom Tracing
152152

@@ -191,11 +191,11 @@ If, for example, you wanted to see the performance for the `Array::sort`, you co
191191
TraceView::API.profile_method(Array, :sort)
192192
```
193193

194-
For full documentation, options and reporting custom KVs, see our documentation on [method profiling](http://docs.appneta.com/ruby#profiling-ruby-methods).
194+
For full documentation, options and reporting custom KVs, see our documentation on [method profiling](http://docs.traceview.solarwinds.com/Instrumentation/ruby.html#ruby-function-profiling).
195195

196196
# Support
197197

198-
If you find a bug or would like to request an enhancement, feel free to file an issue. For all other support requests, see our [support portal](https://tickets.appneta.com) or on IRC @ #appneta on [Freenode](http://freenode.net/).
198+
If you find a bug or would like to request an enhancement, feel free to file an issue. For all other support requests, see our [support portal](https://tracelytics.freshdesk.com).
199199

200200
# Contributing
201201

@@ -205,13 +205,9 @@ We welcome you to send us PRs. We also humbly request that any new instrumentat
205205

206206
## Developer Resources
207207

208-
We at AppNeta have made a large effort to expose as much technical information as possible to assist developers wishing to contribute to the traceview gem. Below are the three major sources for information and help for developers:
209-
210-
* The [TraceView blog](http://www.appneta.com/blog) has a constant stream of great technical articles. (See [A Gentle X-Trace Introduction](http://www.appneta.com/blog/x-trace-introduction/) for details on the basic methodology that TraceView uses to gather structured performance data across hosts and stacks.)
208+
We have made a large effort to expose as much technical information as possible to assist developers wishing to contribute to the traceview gem. Below is a good source for information and help for developers:
211209

212-
* The [TraceView Documentation Portal](https://docs.appneta.com/ruby) has a large collection of technical articles or, if needed, you can [submit a support request](https://tickets.appneta.com) directly to the team.
213-
214-
* You can also reach the TraceView team on our IRC channel #appneta on freenode.
210+
* The [TraceView Knowledge Base](http://docs.traceview.solarwinds.com/) has a large collection of technical articles or, if needed, you can submit a support request directly to the team.
215211

216212
If you have any questions or ideas, don't hesitate to contact us anytime.
217213

@@ -297,8 +293,6 @@ Third, in our wrapper method, we capture the arguments passed in, collect the op
297293

298294
The `TraceView::API.trace` method calls Dalli's native operation and reports the timing metrics and your custom `report_kvs` up to TraceView servers to be shown on the user's dashboard.
299295

300-
That is a very quick example of a simple instrumentation implementation. If you have any questions, visit us on IRC in #appneta on Freenode.
301-
302296
Some other tips and guidelines:
303297

304298
* You can point your Gemfile directly at your cloned traceview gem source by using `gem 'traceview', :path => '/path/to/ruby-traceview'`
@@ -317,7 +311,7 @@ Some other tips and guidelines:
317311

318312
## Compiling the C extension
319313

320-
The traceview gem utilizes a C extension to interface with the system `liboboe.so` library. This system library is installed with the TraceView host packages (tracelyzer, liboboe0, liboboe-dev) and is used to report [host](http://www.appneta.com/blog/app-host-metrics/) and performance metrics from multiple sources (Ruby, Apache, Python etc.) back to TraceView servers.
314+
The traceview gem utilizes a C extension to interface with the system `liboboe.so` library. This system library is installed with the TraceView host packages (tracelyzer, liboboe0, liboboe-dev) and is used to report host and performance metrics from multiple sources (Ruby, Apache, Python etc.) back to TraceView servers.
321315

322316
C extensions are usually built on `gem install` but when working out of a local git repository, it's required that you manually build this C extension for the gem to function.
323317

@@ -333,19 +327,19 @@ Note: Make sure you have the development package `liboboe0-dev` installed before
333327

334328
```bash
335329
>>$ dpkg -l | grep liboboe
336-
ii liboboe-dev 1.2.1-trusty1 AppNeta TraceView common library -- development files
337-
ii liboboe0 1.2.1-trusty1 AppNeta Traceview common library
330+
ii liboboe-dev 1.2.1-trusty1 TraceView common library -- development files
331+
ii liboboe0 1.2.1-trusty1 Traceview common library
338332
```
339333

340-
See [Installing Base Packages on Debian and Ubuntu](https://docs.appneta.com/installation-overview) in the Knowledge Base for details. Our hacker extraordinaire [Rob Salmond](https://github.com/rsalmond) from the support team has even gotten these packages to [run on Gentoo](http://www.appneta.com/blog/unsupported-doesnt-work/)!
334+
See [Installing Base Packages on Debian and Ubuntu](http://docs.traceview.solarwinds.com/TraceView/install-instrumentation.html#debian-and-ubuntu) in the Knowledge Base for details.
341335

342336
To see the code related to the C extension, take a look at `ext/oboe_metal/extconf.rb` for details.
343337

344338
You can read more about Ruby gems with C extensions in the [Rubygems Guides](http://guides.rubygems.org/gems-with-extensions/).
345339

346340
## Running the Tests
347341

348-
![TraceView Ruby Tests](https://s3.amazonaws.com/appneta/tv_ruby_tests.png)
342+
![TraceView Ruby Tests](http://docs.traceview.solarwinds.com/images/ruby_readme/tv_ruby_tests.png)
349343

350344
The tests bundled with the gem are implemented using [Minitest](https://github.com/seattlerb/minitest). The tests are currently used to validate the sanity of the traces generated and basic gem functionality.
351345

@@ -369,7 +363,6 @@ We humbly request that any submitted instrumentation is delivered with correspon
369363

370364
# License
371365

372-
Copyright (c) 2014 Appneta
373-
374-
Released under the [AppNeta Open License](http://www.appneta.com/appneta-license), Version 1.0
366+
Copyright (c) 2016 SolarWinds, LLC
375367

368+
Released under the [Librato Open License](http://docs.traceview.solarwinds.com/Instrumentation/librato-open-license.html)

Rakefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ task :compile do
7373
else
7474
Dir.chdir pwd
7575
puts '!! Extension failed to build (see above). Are the base TraceView packages installed?'
76-
puts '!! See https://docs.appneta.com/install-instrumentation'
76+
puts '!! See http://docs.traceview.solarwinds.com/TraceView/install-instrumentation.html'
7777
end
7878
else
7979
puts '== Nothing to do under JRuby.'

examples/DNT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ Since this pattern is used with the standard Ruby Regexp class, you can
3232
use any Regexp supported pattern. See the documentation on Ruby Regexp
3333
[here](https://www.omniref.com/ruby/2.2.0/symbols/Regexp?d=380181456&n=0#doc_uncollapsed=true&d=380181456&n=0)
3434
or you can also view the oboe gem [source code documentation for this
35-
feature](https://github.com/appneta/oboe-ruby/blob/master/lib/oboe/config.rb#L74).
35+
feature](https://github.com/tracelytics/ruby-traceview/blob/master/lib/traceview/config.rb#L129).

examples/tracing_async_threads.rb

+1-2
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,5 @@ def do_the_work(job_to_do)
120120
# end
121121
# end
122122
#
123-
# If anything isn't clear, please don't hesitate to reach us at support (traceviewsupport@appneta.com)
124-
# or on IRC #appneta @ freenode.
123+
# If anything isn't clear, please don't hesitate to reach us at support (traceviewsupport@solarwinds.com).
125124
#

lib/joboe_metal.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -202,15 +202,15 @@ def set_sample_rate(_rate)
202202
$stderr.puts '=============================================================='
203203
$stderr.puts 'TraceView Java Agent not initialized properly.'
204204
$stderr.puts 'Possibly misconfigured? Going into no-op mode.'
205-
$stderr.puts 'https://docs.appneta.com/installing-jruby-instrumentation'
205+
$stderr.puts 'http://docs.traceview.solarwinds.com/Instrumentation/other-instrumentation-modules.html#jruby'
206206
$stderr.puts '=============================================================='
207207

208208
when Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED
209209
TraceView.loaded = false
210210
$stderr.puts '=============================================================='
211211
$stderr.puts 'TraceView Java Agent not loaded. Going into no-op mode.'
212212
$stderr.puts 'To preload the TraceView java agent see:'
213-
$stderr.puts 'https://docs.appneta.com/installing-jruby-instrumentation'
213+
$stderr.puts 'http://docs.traceview.solarwinds.com/Instrumentation/other-instrumentation-modules.html#jruby'
214214
$stderr.puts '=============================================================='
215215

216216
else

lib/rails/generators/traceview/install_generator.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ def print_header
4848
say "-------------------"
4949
say ""
5050
say "TraceView Installation Overview:"
51-
say "https://docs.appneta.com/installation-overview"
51+
say "http://docs.traceview.solarwinds.com/TraceView/install-instrumentation.html"
5252
say ""
5353
say "More information on instrumenting Ruby applications can be found here:"
54-
say "https://docs.appneta.com/installing-ruby-instrumentation"
54+
say "http://docs.traceview.solarwinds.com/Instrumentation/ruby.html#installing-ruby-instrumentation"
5555
end
5656

5757
def print_body

lib/rails/generators/traceview/templates/traceview_initializer.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# AppNeta TraceView Initializer (for the traceview gem)
2-
# http://www.appneta.com/products/traceview/
1+
# TraceView Initializer (for the traceview gem)
2+
# https://traceview.solarwinds.com/
33
#
44
# More information on instrumenting Ruby applications can be found here:
5-
# https://support.appneta.com/cloud/installing-ruby-instrumentation
5+
# http://docs.traceview.solarwinds.com/Instrumentation/ruby.html#installing-ruby-instrumentation
66

77
if defined?(TraceView::Config)
88
# Tracing Mode determines when traces should be initiated for incoming requests. Valid
@@ -99,7 +99,7 @@
9999
#
100100
# Alternatively, if you would like to install the separate
101101
# libcurl instrumentation, see here:
102-
# http://docs.appneta.com/installing-libcurl-instrumentation
102+
# http://docs.traceview.solarwinds.com/Instrumentation/other-instrumentation-modules.html#libcurl
103103
#
104104
# TraceView::Config[:curb][:cross_host] = false
105105
#

lib/traceview/api.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
module TraceView
55
##
66
# This module implements the TraceView tracing API.
7-
# See: https://github.com/appneta/oboe-ruby#the-tracing-api
7+
# See: https://github.com/tracelytics/ruby-traceview#the-tracing-api
88
# and/or: http://rdoc.info/gems/traceview/TraceView/API/Tracing
99
module API
1010
def self.extend_with_tracing

lib/traceview/config.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ def self.initialize(_data = {})
174174
#
175175
# Alternatively, if you would like to install the separate
176176
# libcurl instrumentation, see here:
177-
# http://docs.appneta.com/installing-libcurl-instrumentation
177+
# http://docs.traceview.solarwinds.com/Instrumentation/other-instrumentation-modules.html#libcurl
178178
#
179179
@@config[:curb][:cross_host] = false
180180

lib/traceview/support.rb

+4-5
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def self.support_report
2525

2626
TraceView.logger.warn '********************************************************'
2727
TraceView.logger.warn '* BEGIN TraceView Support Report'
28-
TraceView.logger.warn '* Please email the output of this report to traceviewsupport@appneta.com'
28+
TraceView.logger.warn '* Please email the output of this report to traceviewsupport@solarwinds.com'
2929
TraceView.logger.warn '********************************************************'
3030
TraceView.logger.warn "Ruby: #{RUBY_DESCRIPTION}"
3131
TraceView.logger.warn "$0: #{$0}"
@@ -124,10 +124,9 @@ def self.support_report
124124

125125
TraceView.logger.warn '********************************************************'
126126
TraceView.logger.warn '* END TraceView Support Report'
127-
TraceView.logger.warn '* Support Email: traceviewsupport@appneta.com'
128-
TraceView.logger.warn '* Support Portal: https://tickets.appneta.com'
129-
TraceView.logger.warn '* Freenode IRC: #appneta'
130-
TraceView.logger.warn '* Github: https://github.com/appneta/ruby-traceview'
127+
TraceView.logger.warn '* Support Email: traceviewsupport@solarwinds.com'
128+
TraceView.logger.warn '* Support Portal: https://tracelytics.freshdesk.com'
129+
TraceView.logger.warn '* Github: https://github.com/tracelytics/ruby-traceview'
131130
TraceView.logger.warn '********************************************************'
132131

133132
TraceView.logger.level = @logger_level

test/instrumentation/em_http_request_test.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# Disable this test on JRuby until we can investigate
77
# "SOCKET: SET COMM INACTIVITY UNIMPLEMENTED 10"
8-
# https://travis-ci.org/appneta/traceview-ruby/jobs/33745752
8+
# https://travis-ci.org/tracelytics/ruby-traceview/jobs/33745752
99
if RUBY_VERSION >= '1.9' and TraceView::Config[:em_http_request][:enabled] and not defined?(JRUBY_VERSION)
1010

1111
describe "EventMachine" do

traceview.gemspec

+4-5
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Gem::Specification.new do |s|
66
s.version = TraceView::Version::STRING
77
s.date = Time.now.strftime('%Y-%m-%d')
88

9-
s.license = "AppNeta Open License, Version 1.0"
9+
s.license = "Librato Open License, Version 1.0"
1010

1111
s.authors = ["Peter Giacomo Lombardo", "Spiros Eliopoulos"]
12-
s.email = %q{traceviewsupport@appneta.com}
13-
s.homepage = %q{http://www.appneta.com/products/traceview/}
14-
s.summary = %q{AppNeta TraceView performance instrumentation gem for Ruby}
12+
s.email = %q{traceviewsupport@solarwinds.com}
13+
s.homepage = %q{https://traceview.solarwinds.com/}
14+
s.summary = %q{TraceView performance instrumentation gem for Ruby}
1515
s.description = %q{The TraceView gem provides performance instrumentation for MRI Ruby, JRuby and related frameworks.}
1616

1717
s.extra_rdoc_files = ["LICENSE"]
@@ -45,4 +45,3 @@ Gem::Specification.new do |s|
4545

4646
s.required_ruby_version = '>= 1.8.6'
4747
end
48-

0 commit comments

Comments
 (0)