You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONFIG.md
+1-2
Original file line number
Diff line number
Diff line change
@@ -29,5 +29,4 @@ Name | Description | Default
29
29
30
30
`TraceView::Config` is a nested hash used by the traceview gem to store preferences and switches.
31
31
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.
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).
8
8
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).
_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`._
16
16
17
17
# Installation
18
18
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._
20
20
21
21
The traceview gem is [available on Rubygems](https://rubygems.org/gems/traceview) and can be installed with:
22
22
@@ -34,15 +34,15 @@ gem 'traceview'
34
34
35
35
## Rails
36
36
37
-

37
+

38
38
39
39
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.
40
40
41
41
*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.*
42
42
43
43
### The Install Generator
44
44
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).
46
46
47
47
To run the install generator run:
48
48
@@ -54,7 +54,7 @@ After the prompts, this will create an initializer: `config/initializers/tracevi
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.
You can instrument your Grape application by adding the following code to your `config.ru` Rackup file:
104
104
105
105
```ruby
106
106
# If you're not using Bundler.require. Make sure this is done
107
107
# after the Grape require directive.
108
108
require'traceview'
109
-
109
+
110
110
# When traces should be initiated for incoming requests. Valid options are
111
111
# "always", "through" (when the request is initiated with a tracing header
112
112
# from upstream) and "never". You must set this directive to "always" in
113
113
# order to initiate tracing.
114
114
TraceView::Config[:tracing_mode] ='through'
115
-
115
+
116
116
...
117
117
118
118
classApp < Grape::API
@@ -146,7 +146,7 @@ Once inside of the `TraceView::API.start_trace` block, performance metrics will
146
146
147
147
## Other
148
148
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)
150
150
151
151
# Custom Tracing
152
152
@@ -191,11 +191,11 @@ If, for example, you wanted to see the performance for the `Array::sort`, you co
191
191
TraceView::API.profile_method(Array, :sort)
192
192
```
193
193
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).
195
195
196
196
# Support
197
197
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).
199
199
200
200
# Contributing
201
201
@@ -205,13 +205,9 @@ We welcome you to send us PRs. We also humbly request that any new instrumentat
205
205
206
206
## Developer Resources
207
207
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:
211
209
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.
215
211
216
212
If you have any questions or ideas, don't hesitate to contact us anytime.
217
213
@@ -297,8 +293,6 @@ Third, in our wrapper method, we capture the arguments passed in, collect the op
297
293
298
294
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.
299
295
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
-
302
296
Some other tips and guidelines:
303
297
304
298
* 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:
317
311
318
312
## Compiling the C extension
319
313
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.
321
315
322
316
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.
323
317
@@ -333,19 +327,19 @@ Note: Make sure you have the development package `liboboe0-dev` installed before
333
327
334
328
```bash
335
329
>>$ 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
338
332
```
339
333
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.
341
335
342
336
To see the code related to the C extension, take a look at `ext/oboe_metal/extconf.rb` for details.
343
337
344
338
You can read more about Ruby gems with C extensions in the [Rubygems Guides](http://guides.rubygems.org/gems-with-extensions/).
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.
351
345
@@ -369,7 +363,6 @@ We humbly request that any submitted instrumentation is delivered with correspon
369
363
370
364
# License
371
365
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
375
367
368
+
Released under the [Librato Open License](http://docs.traceview.solarwinds.com/Instrumentation/librato-open-license.html)
0 commit comments