├── .prettierignore ├── .travis.yml ├── types ├── tsconfig.json └── index.d.ts ├── test ├── sandbox-coverage.js └── tap │ └── index-test.js ├── .eslintrc ├── .github └── workflows │ ├── node.js.yml │ ├── npm-publish.yml │ └── codeql-analysis.yml ├── .gitignore ├── README.md ├── lib └── index.js ├── package.json └── LICENSE /.prettierignore: -------------------------------------------------------------------------------- 1 | coverage 2 | .github 3 | .nyc_output 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | dist: trusty 3 | sudo: false 4 | node_js: 5 | - "10" 6 | - "8" 7 | - "6" 8 | after_success: 9 | - npm run codecov 10 | -------------------------------------------------------------------------------- /types/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compileOnSave": false, 3 | "compilerOptions": { 4 | "strict": true, 5 | "noUnusedParameters": true, 6 | "noUnusedLocals": false, 7 | "noEmit": true 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /test/sandbox-coverage.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const sandbox = require("@log4js-node/sandboxed-module"); 4 | const NYC = require("nyc"); 5 | 6 | sandbox.configure({ 7 | sourceTransformers: { 8 | nyc(source) { 9 | if (this.filename.indexOf("node_modules") > -1) { 10 | return source; 11 | } 12 | const nyc = new NYC({}); 13 | return nyc 14 | .instrumenter() 15 | .instrumentSync(source, this.filename, { registerMap: () => {} }); 16 | }, 17 | }, 18 | }); 19 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "extends": ["airbnb-base", "prettier"], 4 | "plugins": ["import"], 5 | "rules": { 6 | "comma-dangle": 0, 7 | "indent": 2, 8 | "object-shorthand": 0, 9 | "func-names": 0, 10 | "max-len": [1, 120, 2], 11 | "no-use-before-define": ["warn"], 12 | "no-param-reassign": 0, 13 | "strict": 0, 14 | "import/no-extraneous-dependencies": 1, 15 | "prefer-spread": 0, 16 | "prefer-rest-params": 0, 17 | "prefer-destructuring": 0 18 | }, 19 | "parserOptions": { 20 | "ecmaVersion": 6 21 | }, 22 | "ignorePatterns": ["coverage/**/*", "commitlint.config.js"] 23 | } 24 | -------------------------------------------------------------------------------- /types/index.d.ts: -------------------------------------------------------------------------------- 1 | import type { Agent as httpAgent } from "http"; 2 | import type { Agent as httpsAgent } from "https"; 3 | 4 | export interface LogstashHTTPAppender { 5 | type: "@log4js-node/logstash-http"; 6 | url: string; 7 | timeout?: number; //defaults to 5000 8 | application?: string; 9 | logChannel?: string; 10 | logType?: string; 11 | /** An http.Agent or https.Agent to allow configuring behavior as needed. 12 | * Make sure you use the correct type base on your url 13 | */ 14 | agent?: httpAgent | httpsAgent; 15 | } 16 | 17 | // Add the LogstashHTTPAppender to the list of appenders in log4js for better type support 18 | declare module "log4js" { 19 | export interface Appenders { 20 | LogstashHTTPAppender: LogstashHTTPAppender; 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /.github/workflows/node.js.yml: -------------------------------------------------------------------------------- 1 | # This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions 3 | 4 | name: Node.js CI 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | strategy: 18 | matrix: 19 | node-version: [12.x, 14.x, 16.x] 20 | # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ 21 | 22 | steps: 23 | - uses: actions/checkout@v2 24 | - name: Use Node.js ${{ matrix.node-version }} 25 | uses: actions/setup-node@v2 26 | with: 27 | node-version: ${{ matrix.node-version }} 28 | cache: 'npm' 29 | - run: npm ci 30 | - run: npm run build --if-present 31 | - run: npm test 32 | - run: npm run typings 33 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /.github/workflows/npm-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflow will run tests using node and then publish a package to GitHub Packages when a milestone is closed 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages 3 | 4 | name: Node.js Package 5 | 6 | on: 7 | milestone: 8 | types: [closed] 9 | 10 | jobs: 11 | build: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v2 15 | - uses: actions/setup-node@v2 16 | with: 17 | node-version: 16 18 | - run: npm ci 19 | - run: npm test 20 | - run: npm run typings 21 | 22 | publish-npm: 23 | needs: build 24 | runs-on: ubuntu-latest 25 | steps: 26 | - uses: actions/checkout@v2 27 | - uses: actions/setup-node@v2 28 | with: 29 | node-version: 16 30 | registry-url: https://registry.npmjs.org/ 31 | - run: npm ci 32 | - run: | 33 | git config user.name github-actions 34 | git config user.email github-actions@github.com 35 | - run: npm version ${{ github.event.milestone.title }} 36 | - run: git push && git push --tags 37 | - run: npm publish 38 | env: 39 | NODE_AUTH_TOKEN: ${{secrets.npm_token}} 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # logstash Appender (HTTP) for log4js-node 2 | 3 | The logstash appenders for [log4js](https://log4js-node.github.io/log4js-node) send NDJSON formatted log events to [logstash](https://www.elastic.co/products/logstash) receivers. This appender uses HTTP to send the events (there is another logstash appender that uses [UDP](https://github.com/log4js-node/logstashUDP)). 4 | 5 | ```bash 6 | npm install log4js @log4js-node/logstash-http 7 | ``` 8 | 9 | ## Configuration 10 | 11 | - `type` - `@log4js-node/logstash-http` 12 | - `url` - `string` - logFaces receiver servlet URL 13 | - `application` - `string` (optional) - used to identify your application's logs 14 | - `logChannel` - `string` (optional) - also used to identify your application's logs [but in a more specific way] 15 | - `logType` - `string` (optional) - used for the `type` field in the logstash data 16 | - `timeout` - `integer` (optional, defaults to 5000ms) - the timeout for the HTTP request. 17 | - `agent` - `http.Agent | https.Agent` (optional) - used to configure the requests being sent out if needed. 18 | 19 | This appender will also pick up Logger context values from the events, and add them as `p_` values in the logFaces event. See the example below for more details. 20 | 21 | # Example (default config) 22 | 23 | ```javascript 24 | log4js.configure({ 25 | appenders: { 26 | logstash: { 27 | type: "@log4js-node/logstash-http", 28 | url: "http://localhost:9200/_bulk", 29 | application: "logstash-log4js", 30 | logType: "application", 31 | logChannel: "node", 32 | }, 33 | }, 34 | categories: { 35 | default: { appenders: ["logstash"], level: "info" }, 36 | }, 37 | }); 38 | 39 | const logger = log4js.getLogger(); 40 | logger.addContext("requestId", "123"); 41 | logger.info("some interesting log message"); 42 | logger.error("something has gone wrong"); 43 | ``` 44 | 45 | This example will result in two log events being sent to your `localhost:9200`. Both events will have a `context.requestId` property with a value of `123`. 46 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | # For most projects, this workflow file will not need changing; you simply need 2 | # to commit it to your repository. 3 | # 4 | # You may wish to alter this file to override the set of languages analyzed, 5 | # or to provide custom queries or build logic. 6 | # 7 | # ******** NOTE ******** 8 | # We have attempted to detect the languages in your repository. Please check 9 | # the `language` matrix defined below to confirm you have the correct set of 10 | # supported CodeQL languages. 11 | # 12 | name: "CodeQL" 13 | 14 | on: 15 | push: 16 | branches: [ master ] 17 | pull_request: 18 | # The branches below must be a subset of the branches above 19 | branches: [ master ] 20 | schedule: 21 | - cron: '37 17 * * 4' 22 | 23 | jobs: 24 | analyze: 25 | name: Analyze 26 | runs-on: ubuntu-latest 27 | permissions: 28 | actions: read 29 | contents: read 30 | security-events: write 31 | 32 | strategy: 33 | fail-fast: false 34 | matrix: 35 | language: [ 'javascript' ] 36 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] 37 | # Learn more about CodeQL language support at https://git.io/codeql-language-support 38 | 39 | steps: 40 | - name: Checkout repository 41 | uses: actions/checkout@v2 42 | 43 | # Initializes the CodeQL tools for scanning. 44 | - name: Initialize CodeQL 45 | uses: github/codeql-action/init@v1 46 | with: 47 | languages: ${{ matrix.language }} 48 | # If you wish to specify custom queries, you can do so here or in a config file. 49 | # By default, queries listed here will override any specified in a config file. 50 | # Prefix the list here with "+" to use these queries and those in the config file. 51 | # queries: ./path/to/local/query, your-org/your-repo/queries@main 52 | 53 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 54 | # If this step fails, then you should remove it and run the build manually (see below) 55 | - name: Autobuild 56 | uses: github/codeql-action/autobuild@v1 57 | 58 | # ℹ️ Command-line programs to run using the OS shell. 59 | # 📚 https://git.io/JvXDl 60 | 61 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 62 | # and modify them (or add more) to build your code if your project 63 | # uses a compiled language 64 | 65 | #- run: | 66 | # make bootstrap 67 | # make release 68 | 69 | - name: Perform CodeQL Analysis 70 | uses: github/codeql-action/analyze@v1 71 | -------------------------------------------------------------------------------- /lib/index.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | /** 4 | * logstashHTTP appender sends JSON formatted log events to logstashHTTP receivers. 5 | */ 6 | const util = require("util"); 7 | const axios = require("axios"); 8 | 9 | function format(logData) { 10 | return util.format(...logData); 11 | } 12 | 13 | /** 14 | * 15 | * For HTTP (browsers or node.js) use the following configuration params: 16 | * { 17 | * "type": "@log4js-node/logstash-http", // must be present for instantiation 18 | * "application": "logstash-test", // name of the application 19 | * "logType": "application", // type of the application 20 | * "logChannel": "test", // channel of the application 21 | * "url": "http://lfs-server/_bulk", // logstash receiver servlet URL 22 | * } 23 | * @param {import('../types').LogstashHTTPAppender} config 24 | */ 25 | function logstashHTTPAppender(config) { 26 | const sender = axios.create({ 27 | baseURL: config.url, 28 | timeout: config.timeout || 5000, 29 | headers: { "Content-Type": "application/x-ndjson" }, 30 | withCredentials: true, 31 | // The user should pass in the correct Agent type for their url 32 | // since their url won't change after config this should be fine 33 | httpAgent: config.agent, 34 | httpsAgent: config.agent, 35 | }); 36 | 37 | return function log(event) { 38 | const logstashEvent = [ 39 | { 40 | index: { 41 | _index: config.application, 42 | _type: config.logType, 43 | }, 44 | }, 45 | { 46 | message: format(event.data), 47 | context: event.context, 48 | level: event.level.level / 100, 49 | level_name: event.level.levelStr, 50 | channel: config.logChannel, 51 | datetime: new Date(event.startTime).toISOString(), 52 | extra: {}, 53 | }, 54 | ]; 55 | const logstashJSON = `${JSON.stringify(logstashEvent[0])}\n${JSON.stringify( 56 | logstashEvent[1] 57 | )}\n`; 58 | 59 | // send to server 60 | sender.post("", logstashJSON).catch((error) => { 61 | if (error.response) { 62 | // eslint-disable-next-line 63 | console.error( 64 | `log4js.logstashHTTP Appender error posting to ${config.url}: ${ 65 | error.response.status 66 | } - ${JSON.stringify(error.response.data)}` 67 | ); 68 | } else { 69 | // eslint-disable-next-line 70 | console.error(`log4js.logstashHTTP Appender error: ${error.message}`); 71 | } 72 | }); 73 | }; 74 | } 75 | 76 | function configure(config) { 77 | return logstashHTTPAppender(config); 78 | } 79 | 80 | module.exports.configure = configure; 81 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@log4js-node/logstash-http", 3 | "version": "1.1.0", 4 | "description": "Logstash HTTP Appender for log4js-node", 5 | "homepage": "https://log4js-node.github.io/log4js-node/", 6 | "files": [ 7 | "lib", 8 | "types" 9 | ], 10 | "keywords": [ 11 | "logging", 12 | "log", 13 | "log4j", 14 | "node", 15 | "logstash" 16 | ], 17 | "license": "Apache-2.0", 18 | "main": "./lib/index.js", 19 | "types": "./types/index.d.ts", 20 | "author": "Gareth Jones ", 21 | "repository": { 22 | "type": "git", 23 | "url": "https://github.com/log4js-node/logstashHTTP.git" 24 | }, 25 | "bugs": { 26 | "url": "http://github.com/log4js-node/logstashHTTP/issues" 27 | }, 28 | "engines": { 29 | "node": ">=6.0" 30 | }, 31 | "scripts": { 32 | "prepush": "npm test", 33 | "commitmsg": "validate-commit-msg", 34 | "prettier:fix": "prettier --write .", 35 | "pretest": "prettier --check . && eslint \"lib/**/*.js\" \"test/**/*.js\"", 36 | "test": "tap test/tap/**/*.js --100", 37 | "typings": "tsc -p types/tsconfig.json", 38 | "codecov": "tap 'test/tap/**/*.js' --cov --coverage-report=lcov && codecov" 39 | }, 40 | "directories": { 41 | "test": "test", 42 | "lib": "lib" 43 | }, 44 | "dependencies": { 45 | "axios": "^0.27.2" 46 | }, 47 | "devDependencies": { 48 | "@log4js-node/sandboxed-module": "^2.2.1", 49 | "@types/node": "^18.11.12", 50 | "codecov": "^3.0.0", 51 | "conventional-changelog": "^3.1.25", 52 | "eslint": "^8.29.0", 53 | "eslint-config-airbnb-base": "^15.0.0", 54 | "eslint-config-prettier": "^8.5.0", 55 | "eslint-import-resolver-node": "^0.3.6", 56 | "eslint-plugin-import": "^2.26.0", 57 | "husky": "^8.0.1", 58 | "log4js": "^6.5.2", 59 | "nyc": "^15.1.0", 60 | "prettier": "^2.7.0", 61 | "tap": "^16.3.2", 62 | "typescript": "^4.7.2", 63 | "validate-commit-msg": "^2.14.0" 64 | }, 65 | "browser": { 66 | "os": false 67 | }, 68 | "config": { 69 | "validate-commit-msg": { 70 | "types": [ 71 | "feat", 72 | "fix", 73 | "docs", 74 | "style", 75 | "refactor", 76 | "example", 77 | "perf", 78 | "test", 79 | "chore", 80 | "revert" 81 | ], 82 | "warnOnFail": false, 83 | "maxSubjectLength": 72, 84 | "subjectPattern": ".+", 85 | "subjectPatternErrorMsg": "subject does not match subject pattern!", 86 | "helpMessage": "\n# allowed type: feat, fix, docs, style, refactor, example, perf, test, chore, revert\n# subject no more than 50 chars\n# a body line no more than 72 chars" 87 | } 88 | }, 89 | "nyc": { 90 | "all": true, 91 | "include": [ 92 | "lib/**/*.js" 93 | ], 94 | "require": [ 95 | "./test/sandbox-coverage" 96 | ] 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /test/tap/index-test.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const { Agent } = require("http"); 4 | const test = require("tap").test; 5 | const sandbox = require("@log4js-node/sandboxed-module"); 6 | const appender = require("../../lib"); 7 | 8 | function setupLogging(category, options) { 9 | const fakeAxios = { 10 | create: function (config) { 11 | fakeAxios.config = config; 12 | return { 13 | post: function (emptyString, event) { 14 | fakeAxios.args = [emptyString, event]; 15 | return { 16 | catch: function (cb) { 17 | fakeAxios.errorCb = cb; 18 | }, 19 | }; 20 | }, 21 | }; 22 | }, 23 | }; 24 | 25 | const fakeConsole = { 26 | log: () => {}, 27 | error: function (msg) { 28 | this.msg = msg; 29 | }, 30 | }; 31 | 32 | const appenderModule = sandbox.require("../../lib", { 33 | requires: { 34 | axios: fakeAxios, 35 | }, 36 | globals: { 37 | console: fakeConsole, 38 | }, 39 | }); 40 | 41 | const log4js = sandbox.require("log4js", { 42 | requires: { 43 | "@log4js-node/logstash-http": appenderModule, 44 | }, 45 | ignoreMissing: true, 46 | }); 47 | 48 | options.type = "@log4js-node/logstash-http"; 49 | log4js.configure({ 50 | appenders: { http: options }, 51 | categories: { default: { appenders: ["http"], level: "trace" } }, 52 | }); 53 | 54 | return { 55 | logger: log4js.getLogger(category), 56 | fakeAxios: fakeAxios, 57 | fakeConsole: fakeConsole, 58 | }; 59 | } 60 | 61 | test("logstashappender", (batch) => { 62 | batch.test("should export a configure function", (t) => { 63 | t.type(appender.configure, "function"); 64 | t.end(); 65 | }); 66 | 67 | batch.test("when using HTTP receivers", (t) => { 68 | const agent = new Agent(); 69 | const setup = setupLogging("myCategory", { 70 | application: "logstash-sample", 71 | logType: "application", 72 | logChannel: "sample", 73 | url: "http://localhost/receivers/rx1", 74 | agent, 75 | }); 76 | 77 | t.test("axios should be configured", (assert) => { 78 | assert.equal( 79 | setup.fakeAxios.config.baseURL, 80 | "http://localhost/receivers/rx1" 81 | ); 82 | assert.equal(setup.fakeAxios.config.timeout, 5000); 83 | assert.equal(setup.fakeAxios.config.withCredentials, true); 84 | assert.same(setup.fakeAxios.config.headers, { 85 | "Content-Type": "application/x-ndjson", 86 | }); 87 | // For some reason with the sandboxed tests, the instanceof Agent doesn't exist. 88 | assert.match(setup.fakeAxios.config, { 89 | httpAgent: Object, 90 | httpsAgent: Object, 91 | }); 92 | assert.end(); 93 | }); 94 | 95 | setup.logger.addContext("foo", "bar"); 96 | setup.logger.addContext("bar", "foo"); 97 | setup.logger.warn("Log event #1"); 98 | 99 | t.test("an event should be sent", (assert) => { 100 | const packet = setup.fakeAxios.args[1].split("\n"); 101 | const eventHeader = JSON.parse(packet[0]); 102 | const eventBody = JSON.parse(packet[1]); 103 | assert.equal(eventHeader.index._index, "logstash-sample"); //eslint-disable-line 104 | assert.equal(eventHeader.index._type, "application"); //eslint-disable-line 105 | 106 | assert.equal(eventBody.channel, "sample"); 107 | assert.equal(eventBody.message, "Log event #1"); 108 | assert.equal(eventBody.level_name, "WARN"); 109 | assert.equal(eventBody.context.foo, "bar"); 110 | assert.equal(eventBody.context.bar, "foo"); 111 | 112 | // Assert timestamp, up to hours resolution. 113 | const date = new Date(eventBody.datetime); 114 | assert.equal( 115 | date.toISOString().substring(0, 14), 116 | new Date().toISOString().substring(0, 14) 117 | ); 118 | assert.end(); 119 | }); 120 | 121 | t.test("errors should be sent to console.error", (assert) => { 122 | setup.fakeAxios.errorCb({ response: { status: 500, data: "oh no" } }); 123 | assert.equal( 124 | setup.fakeConsole.msg, 125 | 'log4js.logstashHTTP Appender error posting to http://localhost/receivers/rx1: 500 - "oh no"' 126 | ); 127 | setup.fakeAxios.errorCb(new Error("oh dear")); 128 | assert.equal( 129 | setup.fakeConsole.msg, 130 | "log4js.logstashHTTP Appender error: oh dear" 131 | ); 132 | assert.end(); 133 | }); 134 | t.end(); 135 | }); 136 | 137 | batch.test("should include stack traces in errors", (t) => { 138 | const setup = setupLogging("myCategory", { 139 | application: "logstash-sample", 140 | logType: "application", 141 | logChannel: "sample", 142 | url: "http://localhost/receivers/rx1", 143 | }); 144 | 145 | setup.logger.error("Log event #1", new Error("something happened")); 146 | 147 | const packet = setup.fakeAxios.args[1].split("\n"); 148 | const eventBody = JSON.parse(packet[1]); 149 | 150 | t.match(eventBody.message, /Log event #1 Error: something happened/); 151 | t.match(eventBody.message, /at (Test.batch.test|Test.)/); 152 | t.end(); 153 | }); 154 | 155 | batch.end(); 156 | }); 157 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------