Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support hapi tracing through the plugin API #379

Merged
merged 7 commits into from
Feb 17, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions config.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,12 @@ module.exports = {
// This field is experimental.
plugins: {
'connect': path.join(__dirname, 'src/plugins/plugin-connect.js'),
'hapi': path.join(__dirname, 'src/plugins/plugin-hapi.js'),
'koa': path.join(__dirname, 'src/plugins/plugin-koa.js'),
'mongodb-core': path.join(__dirname, 'src/plugins/plugin-mongodb-core.js'),
'redis': path.join(__dirname, 'src/plugins/plugin-redis.js'),
'restify': path.join(__dirname, 'src/plugins/plugin-restify.js'),
'mysql': path.join(__dirname, 'src/plugins/plugin-mysql.js'),
'redis': path.join(__dirname, 'src/plugins/plugin-redis.js'),
'restify': path.join(__dirname, 'src/plugins/plugin-restify.js')
},

// Valid entries are:
Expand Down
2 changes: 0 additions & 2 deletions src/hooks/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ var toInstrument = Object.create(null, {
patches: {} } },
'grpc': { enumerable: true, value: { file: './userspace/hook-grpc.js',
patches: {} } },
'hapi': { enumerable: true, value: { file: './userspace/hook-hapi.js',
patches: {} } },
'http': { enumerable: true, value: { file: './core/hook-http.js',
patches: {} } }
});
Expand Down
135 changes: 0 additions & 135 deletions src/hooks/userspace/hook-hapi.js

This file was deleted.

94 changes: 94 additions & 0 deletions src/plugins/plugin-hapi.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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.
*/
'use strict';

var shimmer = require('shimmer');
var urlParse = require('url').parse;

var SUPPORTED_VERSIONS = '8 - 16';

function connectionWrap(api, connection) {
return function connectionTrace() {
var server = connection.apply(this, arguments);
server.ext('onRequest', middleware.bind(null, api));
return server;
};
}

function middleware(api, request, reply) {
var req = request.raw.req;
var res = request.raw.res;
var originalEnd = res.end;
var options = {
name: urlParse(req.url).pathname,
traceContext: req.headers[api.constants.TRACE_CONTEXT_HEADER_NAME],
skipFrames: 3
};
api.runInRootSpan(options, function(root) {
if (!root) {
return reply.continue();
}

api.wrapEmitter(req);
api.wrapEmitter(res);

var url = (req.headers['X-Forwarded-Proto'] || 'http') +
'://' + req.headers.host + req.url;

// we use the path part of the url as the span name and add the full
// url as a label
// req.path would be more desirable but is not set at the time our middlewear runs.
root.addLabel(api.labels.HTTP_METHOD_LABEL_KEY, req.method);
root.addLabel(api.labels.HTTP_URL_LABEL_KEY, url);
root.addLabel(api.labels.HTTP_SOURCE_IP, req.connection.remoteAddress);

var context = root.getTraceContext();
res.setHeader(api.constants.TRACE_CONTEXT_HEADER_NAME, context);

// wrap end
res.end = function(chunk, encoding) {
res.end = originalEnd;
var returned = res.end(chunk, encoding);

if (req.route && req.route.path) {
root.addLabel(
'hapi/request.route.path', req.route.path);
}
root.addLabel(
api.labels.HTTP_RESPONSE_CODE_LABEL_KEY, res.statusCode);
root.endSpan();

return returned;
};

return reply.continue();
});
}

module.exports = [
{
file: '',
versions: SUPPORTED_VERSIONS,
patch: function(hapi, api) {
shimmer.wrap(hapi.Server.prototype,
'connection',
connectionWrap.bind(null, api));
},
unpatch: function(hapi) {
shimmer.unwrap(hapi.Server.prototype, 'connection');
}
}
];