This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking-nodejs.git
The following commit(s) were added to refs/heads/master by this push:
new cc14cbe Add AzureHttpTriggerPlugin (#51)
cc14cbe is described below
commit cc14cbe0cc378c28c31980fe24de16c4d8a4b9ed
Author: Tomasz Pytel <[email protected]>
AuthorDate: Sun May 16 22:38:08 2021 -0300
Add AzureHttpTriggerPlugin (#51)
---
README.md | 21 ++++++
src/azure/AzureHttpTriggerPlugin.ts | 133 ++++++++++++++++++++++++++++++++++++
src/index.ts | 1 +
src/trace/Component.ts | 1 +
4 files changed, 156 insertions(+)
diff --git a/README.md b/README.md
index 8757c90..b63680c 100644
--- a/README.md
+++ b/README.md
@@ -94,6 +94,27 @@ Library | Underlying Plugin Name
| [`request-promise`](https://github.com/request/request-promise) | `http` /
`https` |
| [`koa`](https://github.com/koajs/koa) | `http` / `https` |
+## Experimental Azure Functions Support
+
+The plugin `AzureHttpTriggerPlugin` provides a wrapper function for an Azure
Functions Javascript HttpTrigger endpoint. This is an http server endpoint and
it must be instrumented manually currently. So far all other plugins tested
work within the HttpTrigger and so a trace can pass through the Function and on
to other endpoints called by the function. How much sense it makes to
instrument an Azure Function which already lives in the cloud and has robust
monitoring incorporated is a good [...]
+
+### Usage:
+
+```javascript
+const {default: agent, AzureHttpTriggerPlugin} =
require('skywalking-backend-js');
+
+agent.start({ ... });
+
+module.exports = AzureHttpTriggerPlugin.wrap(async function (context, req) {
+
+ /* contents of http trigger function */
+
+});
+```
+
+All that needs to be done is the actual trigger function needs to be wrapped
with `azureHttpTriggerPlugin.wrap()`, whether that function is a default export
or an explicitly named `entryPoint` or `run` or `index`.
+
+
## Contact Us
* Submit [an issue](https://github.com/apache/skywalking/issues/new) by using
[Nodejs] as title prefix.
* Mail list: **[email protected]**. Mail to
`[email protected]`, follow the reply to subscribe the mail
list.
diff --git a/src/azure/AzureHttpTriggerPlugin.ts
b/src/azure/AzureHttpTriggerPlugin.ts
new file mode 100644
index 0000000..30dafad
--- /dev/null
+++ b/src/azure/AzureHttpTriggerPlugin.ts
@@ -0,0 +1,133 @@
+/*!
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ *
+ */
+
+import { URL } from 'url';
+import ContextManager from '../trace/context/ContextManager';
+import { Component } from '../trace/Component';
+import Tag from '../Tag';
+import { SpanLayer } from '../proto/language-agent/Tracing_pb';
+import { ContextCarrier } from '../trace/context/ContextCarrier';
+import DummySpan from '../trace/span/DummySpan';
+import { ignoreHttpMethodCheck } from '../config/AgentConfig';
+
+class AzureHttpTriggerPlugin {
+ wrap(func: any) {
+ return function(this: any, context: any) {
+ let outRet = true;
+ let outName: any;
+
+ for (const def of context.bindingDefinitions || []) {
+ if (def.type === 'http' && def.directioun === 'out') {
+ outName = def.name;
+ outRet = outName === '$return'
+ }
+ }
+
+ const req = context.req;
+ const url = new URL(req.url);
+ const operation = url.pathname.replace(/\?.*$/g, '');
+ const carrier = ContextCarrier.from(req.headers);
+
+ const span: any = ignoreHttpMethodCheck(req.method)
+ ? DummySpan.create()
+ : ContextManager.current.newEntrySpan(operation, carrier);
+
+ span.layer = SpanLayer.HTTP;
+ span.component = Component.AZURE_HTTPTRIGGER ;
+ span.peer = (req.headers['x-forwarded-for'] || '???').split(',').shift();
+
+ span.tag(Tag.httpMethod(req.method));
+ span.tag(Tag.httpURL(url.origin + url.pathname));
+
+ span.start();
+
+ let stop = (_ret?: any) => {
+ stop = (v: any) => v;
+
+ const res = outRet ? _ret : context.bindings[outName] || context.res;
+ const status = span.errored ? 500 : !res ? 0 : res.status || 200;
+
+ if (status) {
+ span.tag(Tag.httpStatusCode(status));
+
+ if (status >= 400)
+ span.errored = true;
+ }
+
+ span.stop();
+
+ return _ret;
+ };
+
+ const done = context.done;
+ let did = false;
+
+ context.done = function(err: any, _ret: any) {
+ if (!did) {
+ if (err)
+ span.error(err);
+
+ if (arguments.length >= 2)
+ arguments[1] = stop(_ret);
+ else
+ stop();
+
+ did = true;
+ }
+
+ return done.apply(this, arguments);
+ };
+
+ let ret;
+
+ try {
+ ret = func.apply(this, arguments);
+
+ } catch (err) {
+ span.error(err);
+ stop();
+
+ throw err;
+ }
+
+ if (ret && typeof ret.then === 'function') { // generic Promise check
+ ret = ret.then(
+ (_ret: any) => {
+
+ return stop(_ret);
+ },
+
+ (err: any) => {
+ span.error(err);
+ stop();
+
+ return Promise.reject(err);
+ }
+ );
+ }
+
+ span.async();
+
+ return ret;
+ };
+ }
+}
+
+// noinspection JSUnusedGlobalSymbols
+export default new AzureHttpTriggerPlugin();
diff --git a/src/index.ts b/src/index.ts
index 3f455b8..7d9371b 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -53,3 +53,4 @@ class Agent {
export default new Agent();
export { default as ContextManager } from './trace/context/ContextManager';
+export { default as AzureHttpTriggerPlugin } from
'./azure/AzureHttpTriggerPlugin';
diff --git a/src/trace/Component.ts b/src/trace/Component.ts
index 64d47bf..f45bf0d 100644
--- a/src/trace/Component.ts
+++ b/src/trace/Component.ts
@@ -26,6 +26,7 @@ export class Component {
static readonly HTTP_SERVER = new Component(49);
static readonly RABBITMQ_PRODUCER = new Component(52);
static readonly RABBITMQ_CONSUMER = new Component(53);
+ static readonly AZURE_HTTPTRIGGER = new Component(111);
static readonly EXPRESS = new Component(4002);
static readonly AXIOS = new Component(4005);
static readonly MONGOOSE = new Component(4006);
