feat(index.js): first release

Author: ranrib

.eslintignore

@@ -0,0 +1,2 @@
+**/node_modules/**
+examples/**

.eslintrc

@@ -0,0 +1,34 @@
+{
+    "extends": "airbnb",
+    "env": {
+        "node": true,
+        "browser": false
+    },
+    "plugins": [
+        "json"
+    ],
+    "rules": {
+        "indent": ["error", 4],
+        "function-paren-newline": ["error", "consistent"],
+        "require-jsdoc": ["error", {
+            "require": {
+                "FunctionDeclaration": true,
+                "MethodDefinition": true,
+                "ClassDeclaration": true,
+                "ArrowFunctionExpression": false,
+                "FunctionExpression": true
+            }
+        }],
+        "operator-linebreak": ["error", "after"],
+        "valid-jsdoc": ["error", {
+            "requireReturn": false
+        }],
+        "comma-dangle": ["error", {
+            "arrays": "always-multiline",
+            "objects": "always-multiline",
+            "imports": "never",
+            "exports": "never",
+            "functions": "never"
+        }]
+    }
+}

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+node_modules/
+dist/

.npmignore

@@ -0,0 +1,2 @@
+node_modules/
+.idea/

.travis.yml

@@ -0,0 +1,29 @@
+language: node_js
+
+branches:
+  only:
+    - master
+
+install:
+  - npm install
+  - npm install -g serverless
+
+node_js:
+  - "8.10"
+  - "10.15"
+
+script:
+  - npm run lint
+
+
+jobs:
+  include:
+    - stage: build-and-deploy
+      node_js: "8.10"
+      script:
+        - npm run build && npm run semantic-release
+
+stages:
+  - Test
+#  - name: build-and-deploy
+#    if: branch = master AND type = push

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Epsagon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,135 @@
+# Epsagon Instrumentation for Node.js
+[![Build Status](https://travis-ci.com/epsagon/epsagon-node-frameworks.svg?token=wsveVqcNtBtmq6jpZfSf&branch=master)](https://travis-ci.com/epsagon/epsagon-node-frameworks)
+[![npm version](https://badge.fury.io/js/epsagon-frameworks.svg)](https://badge.fury.io/js/epsagon-frameworks)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+This package provides an instrumentation to Node.js code running on functions for collection of distributed tracing and performance monitoring.
+
+## Installation
+
+From your project directory:
+
+```sh
+npm install --save epsagon
+```
+
+## Getting started
+
+Simply use the wrapper to send traces from your code:
+
+```node
+const epsagon = require('epsagon');
+epsagon.init({
+    token: 'my-secret-token',
+    appName: 'my-app-name',
+    metadataOnly: false, // Optional, send more trace data
+});
+
+function handler(event, context, callback) {
+    callback(null, 'It worked!')
+}
+
+handler = epsagon.lambdaWrapper(handler)
+```
+
+## Custom labels
+
+You can add custom labels to your traces. Filters can later be used for filtering
+traces that contains specific labels:
+```node
+function handler(event, context, callback) {
+    epsagon.label('myCustomLabel', 'labelValue');
+    callback(null, 'It worked!')
+}
+```
+
+## Custom errors
+
+You can set a trace as an error (although handled correctly) by catching an error:
+```node
+function handler(event, context, callback) {
+    try {
+        // something bad happens
+    } catch (err) {
+        epsagon.setError(err);
+    }
+
+    callback(null, 'It worked!')
+}
+```
+
+Or manually specify Error object:
+```node
+function handler(event, context, callback) {
+    epsagon.setError(Error('My custom error'));
+    callback(null, 'It worked!')
+}
+```
+
+## Express application
+
+If you're running express.js application on any non Lambda environment, you can still use Epsagon!
+Note: Only Express 4 and above is supported
+You can accomplish that with the following example:
+
+```node
+const express = require('express');
+const epsagon = require('epsagon');
+
+epsagon.init({
+    token: 'my-secret-token',
+    appName: 'my-app-name',
+    metadataOnly: false,
+});
+
+const app = express()
+
+app.get('/', (req, res) => res.send('Hello World!'))
+
+app.listen(3000)
+```
+
+## Hapi application
+
+If you're running Hapi.js application on any non Lambda environment, you can still use Epsagon!
+Note: Only Hapi 17 and above is supported
+You can accomplish that with the following example:
+
+```node
+const Hapi = require('hapi');
+const epsagon = require('epsagon');
+
+epsagon.init({
+    token: 'my-secret-token',
+    appName: 'my-app-name',
+    metadataOnly: false,
+});
+
+const init = async () => {
+
+    const server = Hapi.server({
+        port: 3000,
+        host: 'localhost'
+    });
+
+    server.route({
+        method: 'GET',
+        path:'/',
+        handler: (request, h) => {
+            return 'Hello World!';
+        }
+    });
+
+    await server.start();
+    console.log('Server running on %ss', server.info.uri);
+};
+
+init();
+```
+
+
+## Copyright
+
+Provided under the MIT license. See LICENSE for details.
+
+Copyright 2019, Epsagon

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-angular']}

examples/.eslintrc

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "import/no-unresolved": 0
+    }
+}

examples/express_example.js

@@ -0,0 +1,20 @@
+const express = require('express');
+const epsagon = require('epsagon-frameworks');
+
+epsagon.init({
+    token: 'my-secret-token',
+    appName: 'my-app-name',
+    metadataOnly: false,
+});
+
+const app = express()
+
+app.get('/', (req, res) => res.send('Hello World!'))
+
+app.get('/label_example', (req, res) => {
+    // Example label usage
+    req.epsagon.label('myFirstLabel', 'customValue1');
+    res.send('Hello World!'))
+}
+
+app.listen(3000)

examples/hapi_example.js

@@ -0,0 +1,38 @@
+const Hapi = require('hapi');
+const epsagon = require('epsagon-frameworks');
+
+epsagon.init({
+    token: 'my-secret-token',
+    appName: 'my-app-name',
+    metadataOnly: false,
+});
+
+const init = async () => {
+
+    const server = Hapi.server({
+        port: 3000,
+        host: 'localhost'
+    });
+
+    server.route({
+        method: 'GET',
+        path:'/',
+        handler: (request, h) => {
+            return 'Hello World!';
+        }
+    });
+
+    server.route({
+        method: 'GET',
+        path:'/label_example',
+        handler: (request, h) => {
+            request.epsagon.label('myFirstLabel', 'customValue1');
+            return 'Hello World!';
+        }
+    });
+
+    await server.start();
+    console.log('Server running on %ss', server.info.uri);
+};
+
+init();