Remove the trace constructor and rename startAgent (#367)

This PR is a follow-up to [PR 361](#361). PR-URL: #367
googleapis · Feb 7, 2017 · c999103 · c999103
1 parent b0e6c04
commit c999103
Show file tree

Hide file tree

Showing 45 changed files with 95 additions and 119 deletions.
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ This module provides Stackdriver Trace support for Node.js applications. [Stackd
 
 3. Include and start the library *as the very first action in your application*:
 
-        var agent = require('@google/cloud-trace')().startAgent();
+        var agent = require('@google/cloud-trace').start();
 
   If you use `--require` in your start up command, make sure that the trace agent is --required first.
 
@@ -47,7 +47,7 @@ If you are running somewhere other than the Google Cloud Platform, see [running
 
 See [the default configuration](config.js) for a list of possible configuration options. These options can be passed to the agent through the object argument to the start command shown above:
 
-        require('@google/cloud-trace')().startAgent({samplingRate: 500});
+        require('@google/cloud-trace').start({samplingRate: 500});
 
 Alternatively, you can provide configuration through a config file. This can be useful if you want to load our module using `--require` on the command line instead of editing your main script. You can start by copying the default config file and modifying it to suit your needs. The `GCLOUD_DIAGNOSTICS_CONFIG` environment variable should point to your configuration file.
 
@@ -142,7 +142,7 @@ For any of the web frameworks listed above (`express`, `hapi`, and `restify`), a
 The API is exposed by the `agent` returned by a call to `start`:
 
 ```javascript
-  var agent = require('@google/cloud-trace')().startAgent();
+  var agent = require('@google/cloud-trace').start();
 ```
 
 For child spans, you can either use the `startSpan` and `endSpan` API, or use the `runInSpan` function that uses a callback-style. For root spans, you must use `runInRootSpan`.

diff --git a/index.js b/index.js
@@ -126,7 +126,7 @@ var publicAgent = {
     return agent.addTransactionLabel(key, value);
   },
 
-  startAgent: function(projectConfig) {
+  start: function(projectConfig) {
     var config = initConfig(projectConfig);
 
     if (this.isActive() && !config.forceNewAgent_) { // already started.
@@ -231,34 +231,6 @@ var publicAgent = {
   private_: function() { return agent; }
 };
 
-/**
- * <p class="notice">
- *   *This module is experimental, and should be used by early adopters. This
- *   module uses APIs that may be undocumented and subject to change without
- *   notice.*
- * </p>
- *
- * This module provides Stackdriver Trace support for Node.js applications.
- * [Stackdriver Trace](https://cloud.google.com/cloud-trace/) is a feature of
- * [Google Cloud Platform](https://cloud.google.com/) that collects latency
- * data (traces) from your applications and displays it in near real-time in
- * the [Google Cloud Console][cloud-console].
- *
- * @constructor
- * @alias module:trace
- *
- * @resource [What is Stackdriver Trace]{@link
- *   https://cloud.google.com/cloud-trace/}
- *
- * @param {object} options - [Configuration object](#/docs)
- */
-// TODO: Remove this constructor.
-function Trace(options) {
-  if (!(this instanceof Trace)) {
-    return new Trace(options);
-  }
-}
-
 /**
  * Start the Trace agent that will make your application available for
  * tracing with Stackdriver Trace.
@@ -269,25 +241,29 @@ function Trace(options) {
  * https://www.youtube.com/watch?v=NCFDqeo7AeY}
  *
  * @example
- * trace.startAgent();
+ * trace.start();
  */
-Trace.prototype.startAgent = function(config) {
-  publicAgent.startAgent(config);
+function start(config) {
+  publicAgent.start(config);
   return publicAgent;
-};
+}
 
-Trace.prototype.isActive = function() {
+function isActive() {
   return publicAgent.isActive();
-};
+}
 
-Trace.prototype.get = function() {
+function get() {
   return publicAgent.get();
-};
+}
 
 global._google_trace_agent = publicAgent;
-module.exports = Trace;
+module.exports = {
+  start: start,
+  isActive: isActive,
+  get: get
+};
 
 // If the module was --require'd from the command line, start the agent.
 if (module.parent && module.parent.id === 'internal/preload') {
-  module.exports().startAgent();
+  module.exports.start();
 }
diff --git a/test/fixtures/preloaded-agent.js b/test/fixtures/preloaded-agent.js
@@ -16,7 +16,7 @@
 'use strict';
 
 var assert = require('assert');
-var agent = require('../../')();
+var agent = require('../../');
 
 assert(agent.isActive());
 agent.get().stop();

diff --git a/test/fixtures/start-agent.js b/test/fixtures/start-agent.js
@@ -17,4 +17,4 @@
 
 process.env.GCLOUD_TRACE_LOGLEVEL = 4;
 require('glob'); // Load a module before agent
-require('../..')().startAgent();
+require('../..').start();
diff --git a/test/hooks/test-hooks-interop-mongo-express.js b/test/hooks/test-hooks-interop-mongo-express.js
@@ -40,7 +40,7 @@ describe('mongodb + express', function() {
   var oldDebug;
   var mongoose;
   before(function() {
-    agent = require('../..')().startAgent().get().private_();
+    agent = require('../..').start().get().private_();
     mongoose = require('./fixtures/mongoose4');
     oldDebug = agent.logger.debug;
     agent.logger.debug = function(error) {

diff --git a/test/hooks/test-trace-connect.js b/test/hooks/test-trace-connect.js
@@ -28,7 +28,7 @@ describe('test-trace-connect', function() {
   var agent;
   var connect;
   before(function() {
-    agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+    agent = require('../..').start({ samplingRate: 0 }).private_();
     connect = require('./fixtures/connect3');
     // Mute stderr to satiate appveyor
     write = process.stderr.write;

diff --git a/test/hooks/test-trace-express.js b/test/hooks/test-trace-express.js
@@ -28,7 +28,7 @@ describe('test-trace-express', function() {
   var agent;
   var express;
   before(function() {
-    agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+    agent = require('../..').start({ samplingRate: 0 }).private_();
     express = require('./fixtures/express4');
 
     // Mute stderr to satiate appveyor

diff --git a/test/hooks/test-trace-grpc.js b/test/hooks/test-trace-grpc.js
@@ -201,7 +201,7 @@ Object.keys(versions).forEach(function(version) {
   describe(version, function() {
     before(function() {
       // It is necessary for the samplingRate to be 0 for the tests to succeed
-      agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+      agent = require('../..').start({ samplingRate: 0 }).private_();
       agent.config_.enhancedDatabaseReporting = true;
 
       common = require('./common.js');

diff --git a/test/hooks/test-trace-hapi.js b/test/hooks/test-trace-hapi.js
@@ -46,7 +46,7 @@ Object.keys(versions).forEach(function(version) {
     var agent;
     var hapi;
     before(function() {
-      agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+      agent = require('../..').start({ samplingRate: 0 }).private_();
       hapi = require(versions[version]);
     });
 

diff --git a/test/hooks/test-trace-http.js b/test/hooks/test-trace-http.js
@@ -26,7 +26,7 @@ describe('test-trace-http', function() {
   var http;
   var server;
   before(function() {
-    agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+    agent = require('../..').start({ samplingRate: 0 }).private_();
     http = require('http');
 
     server = http.Server(function(req, res) {
@@ -254,7 +254,7 @@ describe('https', function() {
   var agent;
   var https;
   before(function() {
-    agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+    agent = require('../..').start({ samplingRate: 0 }).private_();
     https = require('https');
   });
 

diff --git a/test/hooks/test-trace-mongodb.js b/test/hooks/test-trace-mongodb.js
@@ -35,7 +35,7 @@ Object.keys(versions).forEach(function(version) {
     var mongodb;
     var server;
     before(function() {
-      agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+      agent = require('../..').start({ samplingRate: 0 }).private_();
       mongodb = require(versions[version]);
     });
 

diff --git a/test/hooks/test-trace-mongoose.js b/test/hooks/test-trace-mongoose.js
@@ -30,7 +30,7 @@ describe('test-trace-mongoose', function() {
   var mongoose;
   var Simple;
   before(function() {
-    agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+    agent = require('../..').start({ samplingRate: 0 }).private_();
 
     mongoose = require('./fixtures/mongoose4');
     mongoose.Promise = global.Promise;

diff --git a/test/hooks/test-trace-mysql.js b/test/hooks/test-trace-mysql.js
@@ -31,7 +31,7 @@ describe('test-trace-mysql', function() {
   var mysql;
   var pool;
   before(function() {
-    agent = require('../..')().startAgent({
+    agent = require('../..').start({
       enhancedDatabaseReporting: true
     }).private_();
     mysql = require('./fixtures/mysql2');

diff --git a/test/hooks/test-trace-redis.js b/test/hooks/test-trace-redis.js
@@ -38,7 +38,7 @@ Object.keys(versions).forEach(function(version) {
     var agent;
     var redis;
     before(function() {
-      agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+      agent = require('../..').start({ samplingRate: 0 }).private_();
       redis = require(versions[version]);
     });
 

diff --git a/test/hooks/test-trace-restify.js b/test/hooks/test-trace-restify.js
@@ -36,7 +36,7 @@ Object.keys(versions).forEach(function(version) {
     var agent;
     var restify;
     before(function() {
-      agent = require('../..')().startAgent({ samplingRate: 0 }).private_();
+      agent = require('../..').start({ samplingRate: 0 }).private_();
       restify = require(versions[version]);
 
       // Mute stderr to satiate appveyor

diff --git a/test/non-interference/express-e2e.js b/test/non-interference/express-e2e.js
@@ -58,7 +58,7 @@ cp.execFileSync('npm', ['install']);
 // Reformat tests to use newly installed express
 console.log('Reformating tests');
 var gcloud_require = 'require(\'' + path.join(__dirname, '..', '..') +
-    '\')().startAgent({ forceNewAgent_: true });';
+    '\').start({ forceNewAgent_: true });';
 glob(test_glob, function(err, files) {
   error = error || err;
   for (var i = 0; i < files.length; i++) {

diff --git a/test/non-interference/http-e2e.js b/test/non-interference/http-e2e.js
@@ -50,7 +50,7 @@ var test_glob = semver.satisfies(process.version, '0.12.x') ?
 // Run tests
 console.log('Running tests');
 var gcloud_require = 'require(\'' + path.join(__dirname, '..', '..') +
-    '\')().startAgent();';
+    '\').start();';
 glob(test_glob, function(err, files) {
   var errors = 0;
   var testCount;

diff --git a/test/non-interference/restify-e2e.js b/test/non-interference/restify-e2e.js
@@ -57,7 +57,7 @@ cp.execFileSync('npm', ['install']);
 // Reformat tests to use newly installed restify
 console.log('Reformating tests');
 var gcloud_require = 'require(\'' + path.join(__dirname, '..', '..') +
-    '\')().startAgent({ forceNewAgent_: true });';
+    '\').start({ forceNewAgent_: true });';
 glob(test_glob, function(err, files) {
   for (var i = 0; i < files.length; i++) {
     cp.execFileSync('sed', ['-i.bak', 's#\'use strict\';#' +

diff --git a/test/performance/express/express-performance-runner.js b/test/performance/express/express-performance-runner.js
@@ -19,7 +19,7 @@
 if (process.argv[2] === '-i') {
   process.env.GCLOUD_TRACE_ENABLED = true;
   process.env.GCLOUD_TRACE_EXCLUDE_HTTP = true;
-  var traceAgent = require('../../..')().startAgent().private_();
+  var traceAgent = require('../../..').start().private_();
   // We want to drop all spans and avoid network ops
   traceAgent.traceWriter.writeSpan = function() {};
 }

diff --git a/test/performance/http/http-performance-runner.js b/test/performance/http/http-performance-runner.js
@@ -19,7 +19,7 @@
 var traceAgent;
 if (process.argv[2] === '-i') {
   process.env.GCLOUD_TRACE_ENABLED = true;
-  traceAgent = require('../../..')().startAgent().private_();
+  traceAgent = require('../../..').start().private_();
   // We want to drop all spans and avoid network ops
   traceAgent.traceWriter.writeSpan = function() {};
 }

diff --git a/test/performance/mongo/mongo-performance-runner.js b/test/performance/mongo/mongo-performance-runner.js
@@ -25,7 +25,7 @@
 var traceAgent;
 if (process.argv[2] === '-i') {
   process.env.GCLOUD_TRACE_ENABLED = true;
-  traceAgent = require('../../..')().startAgent().private_();
+  traceAgent = require('../../..').start().private_();
   // We want to drop all spans and avoid network ops
   traceAgent.traceWriter.writeSpan = function() {};
 }

diff --git a/test/performance/restify/restify-performance-runner.js b/test/performance/restify/restify-performance-runner.js
@@ -19,7 +19,7 @@
 if (process.argv[2] === '-i') {
   process.env.GCLOUD_TRACE_ENABLED = true;
   process.env.GCLOUD_TRACE_EXCLUDE_HTTP = true;
-  var traceAgent = require('../../..')().startAgent().private_();
+  var traceAgent = require('../../..').start().private_();
   // We want to drop all spans and avoid network ops
   traceAgent.traceWriter.writeSpan = function() {};
 }