diff --git a/.github/component_owners.yml b/.github/component_owners.yml index de29dcab29..18338d7177 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -7,6 +7,9 @@ components: - willarmiros detectors/node/opentelemetry-resource-detector-docker: - abhee11 + detectors/node/opentelemetry-resource-detector-instana: + - basti1302 + - kirrg001 metapackages/auto-instrumentations-node: - obecny metapackages/auto-instrumentations-web: diff --git a/detectors/node/opentelemetry-resource-detector-instana/.eslintignore b/detectors/node/opentelemetry-resource-detector-instana/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/.eslintignore @@ -0,0 +1 @@ +build diff --git a/detectors/node/opentelemetry-resource-detector-instana/.eslintrc.js b/detectors/node/opentelemetry-resource-detector-instana/.eslintrc.js new file mode 100644 index 0000000000..7b832129ab --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/detectors/node/opentelemetry-resource-detector-instana/.npmignore b/detectors/node/opentelemetry-resource-detector-instana/.npmignore new file mode 100644 index 0000000000..42eabef04c --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/.npmignore @@ -0,0 +1,3 @@ +/bin +/coverage +/test diff --git a/detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md new file mode 100644 index 0000000000..825c32f0d0 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/CHANGELOG.md @@ -0,0 +1 @@ +# Changelog diff --git a/detectors/node/opentelemetry-resource-detector-instana/LICENSE b/detectors/node/opentelemetry-resource-detector-instana/LICENSE new file mode 100644 index 0000000000..6b91a297c8 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2020] OpenTelemetry Authors + + 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. diff --git a/detectors/node/opentelemetry-resource-detector-instana/README.md b/detectors/node/opentelemetry-resource-detector-instana/README.md new file mode 100644 index 0000000000..45ce06f60f --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/README.md @@ -0,0 +1,66 @@ +# OpenTelemetry Resource Detector for Instana + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +This resource detector will detect the Instana agent and register the Opentelemetry process to correlate traces. + +## Installation + +```bash +npm install --save @opentelemetry/resource-detector-instana +``` + +## Environment variables + +- INSTANA_AGENT_HOST: The Instana agent hostname. +- INSTANA_AGENT_PORT: The Instana agent port. +- INSTANA_RETRY_TIMEOUT: The resource detector does three retries to connect to the Instana agent. This is the timeout between the retries. +- INSTANA_AGENT_TIMEOUT: The client timeout when connecting the Instana agent. + +## Usage + +```typescript +import { + Resource, + processDetector, + envDetector, +} from "@opentelemetry/resources"; +import { SemanticResourceAttributes } from "@opentelemetry/semantic-conventions"; +import { NodeSDK } from "@opentelemetry/sdk-node"; +import { instanaAgentDetector } from "@opentelemetry/resource-detector-instana"; + +const globalResource = new Resource({ + [SemanticResourceAttributes.SERVICE_NAME]: "TestService", +}); + +const sdk = new NodeSDK({ + autoDetectResources: false, + resource: globalResource, +}); + +await sdk.detectResources({ + detectors: [envDetector, processDetector, instanaAgentDetector], +}); + +// console.log(sdk['_resource']) +// start SDK etc. +``` + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[`gcp-metadata`]: https://www.npmjs.com/package/gcp-metadata +[GCP Metadata Documentation]: https://cloud.google.com/compute/docs/metadata/overview +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-gcp +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-gcp.svg diff --git a/detectors/node/opentelemetry-resource-detector-instana/package.json b/detectors/node/opentelemetry-resource-detector-instana/package.json new file mode 100644 index 0000000000..7025852630 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/package.json @@ -0,0 +1,59 @@ +{ + "name": "@opentelemetry/resource-detector-instana", + "version": "0.0.1", + "description": "OpenTelemetry SDK resource detector for Instana", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "rimraf build/*", + "compile": "tsc -p .", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/resource-detector-instana --include-dependencies", + "prewatch": "npm run precompile", + "prepare": "npm run compile", + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "tdd": "npm run test -- --watch-extensions ts --watch", + "watch": "tsc -w" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "resources", + "instana" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.12.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/contrib-test-utils": "^0.31.0", + "@opentelemetry/sdk-node": "^0.30.0", + "@types/mocha": "8.2.3", + "@types/node": "16.11.21", + "@types/semver": "7.3.8", + "mocha": "7.2.0", + "nock": "12.0.3", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "ts-mocha": "10.0.0", + "typescript": "4.3.5" + }, + "dependencies": { + "@opentelemetry/resources": "^1.0.0", + "@opentelemetry/semantic-conventions": "^1.0.0" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-instana#readme" +} diff --git a/detectors/node/opentelemetry-resource-detector-instana/src/detectors/InstanaAgentDetector.ts b/detectors/node/opentelemetry-resource-detector-instana/src/detectors/InstanaAgentDetector.ts new file mode 100644 index 0000000000..04ac721afa --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/src/detectors/InstanaAgentDetector.ts @@ -0,0 +1,145 @@ +/* + * Copyright The OpenTelemetry Authors + * + * 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 + * + * https://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 { + Detector, + Resource, + ResourceDetectionConfig, +} from "@opentelemetry/resources"; +import { SemanticResourceAttributes } from "@opentelemetry/semantic-conventions"; +import * as http from "http"; + +class InstanaAgentDetector implements Detector { + readonly INSTANA_AGENT_DEFAULT_HOST = "localhost"; + readonly INSTANA_AGENT_DEFAULT_PORT = 42699; + + async detect(_config?: ResourceDetectionConfig): Promise { + const host = + process.env.INSTANA_AGENT_HOST || this.INSTANA_AGENT_DEFAULT_HOST; + const port = Number( + process.env.INSTANA_AGENT_PORT || this.INSTANA_AGENT_DEFAULT_PORT + ); + + const data = await this._retryHandler(host, port, 0); + + return new Resource({ + [SemanticResourceAttributes.PROCESS_PID]: data.pid, + "instana.host.id": data.agentUuid, + // NOTE: The agent reads this property to correlate the process with the service + "service.instance.id": data.pid.toString(), + }); + } + + private async _retryHandler( + host: string, + port: number, + tries: number + ): Promise { + const MAX_TRIES = 3; + + try { + return await this._fetchAgentData(host, port); + } catch (err) { + if (tries < MAX_TRIES) { + console.log( + `Retrying to connect to the Instana agent on ${host}:${port}....` + ); + + function timeout(ms: number) { + return new Promise((resolve) => setTimeout(resolve, ms)); + } + + const retryTimeout = process.env.INSTANA_RETRY_TIMEOUT + ? Number(process.env.INSTANA_RETRY_TIMEOUT) + : 1000; + + await timeout(retryTimeout); + return await this._retryHandler(host, port, tries + 1); + } + + throw err; + } + } + + private async _fetchAgentData(host: string, port: number): Promise { + const agentTimeout = process.env.INSTANA_AGENT_TIMEOUT + ? Number(process.env.INSTANA_AGENT_TIMEOUT) + : 3 * 1000; + + const payload = { + pid: process.pid, + }; + + let payloadStr = JSON.stringify(payload); + const contentLength = Buffer.from(payloadStr, "utf8").length; + + return new Promise(function (resolve, reject) { + // agent needs more than 1s! + const timeoutId = setTimeout(() => { + req.destroy(); + reject(new Error("Instana Agent request timed out.")); + }, agentTimeout); + + const req = http.request( + { + host, + port, + method: "PUT", + path: "/com.instana.plugin.nodejs.discovery", + headers: { + Accept: "application/json", + "Content-Type": "application/json; charset=UTF-8", + "Content-Length": contentLength, + }, + }, + (res) => { + clearTimeout(timeoutId); + res.setEncoding("utf8"); + let rawData = ""; + + res.on("data", (chunk) => (rawData += chunk)); + res.on("end", () => { + if ( + res.statusCode && + res.statusCode >= 200 && + res.statusCode < 300 + ) { + try { + resolve(JSON.parse(rawData)); + } catch (e) { + reject(e); + } + } else { + return reject( + new Error("Failed to load page, status code: " + res.statusCode) + ); + } + }); + } + ); + + req.on("error", (err) => { + clearTimeout(timeoutId); + reject(err); + }); + + req.write(Buffer.from(payloadStr), "utf8"); + req.end(); + }); + } +} + +export const instanaAgentDetector = new InstanaAgentDetector(); diff --git a/detectors/node/opentelemetry-resource-detector-instana/src/detectors/index.ts b/detectors/node/opentelemetry-resource-detector-instana/src/detectors/index.ts new file mode 100644 index 0000000000..149c207602 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/src/detectors/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright The OpenTelemetry Authors + * + * 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 + * + * https://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. + */ + +export * from "./InstanaAgentDetector"; diff --git a/detectors/node/opentelemetry-resource-detector-instana/src/index.ts b/detectors/node/opentelemetry-resource-detector-instana/src/index.ts new file mode 100644 index 0000000000..60f5c3536d --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/src/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright The OpenTelemetry Authors + * + * 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 + * + * https://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. + */ + +export * from "./detectors"; diff --git a/detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorIntegrationTest.test.ts b/detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorIntegrationTest.test.ts new file mode 100644 index 0000000000..fa41c00662 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorIntegrationTest.test.ts @@ -0,0 +1,77 @@ +/* + * Copyright The OpenTelemetry Authors + * + * 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 + * + * https://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 * as nock from "nock"; +import * as assert from "assert"; +import { + Resource, + processDetector, + envDetector, +} from "@opentelemetry/resources"; +import { SemanticResourceAttributes } from "@opentelemetry/semantic-conventions"; +import { NodeSDK } from "@opentelemetry/sdk-node"; +import { instanaAgentDetector } from "../src"; + +describe("[Integration] instanaAgentDetector", () => { + beforeEach(() => { + nock.disableNetConnect(); + nock.cleanAll(); + }); + + afterEach(() => { + nock.enableNetConnect(); + nock.cleanAll(); + }); + + it("should return merged resource", async () => { + const mockedReply = { + pid: 123, + agentUuid: "14:7d:da:ff:fe:e4:08:d5", + }; + + const scope = nock("http://localhost:42699") + .persist() + .put("/com.instana.plugin.nodejs.discovery") + .reply(200, () => mockedReply); + + const serviceName = "TestService"; + const globalResource = new Resource({ + [SemanticResourceAttributes.SERVICE_NAME]: serviceName, + }); + + const sdk = new NodeSDK({ + autoDetectResources: false, + resource: globalResource, + }); + + // attributes are automatically merged! + await sdk.detectResources({ + detectors: [envDetector, processDetector, instanaAgentDetector], + }); + + const resource = sdk["_resource"]; + + assert.equal(resource.attributes["process.pid"], 123); + assert.equal(resource.attributes["process.runtime.name"], "nodejs"); + assert.equal(resource.attributes["service.name"], "TestService"); + assert.equal( + resource.attributes["instana.host.id"], + "14:7d:da:ff:fe:e4:08:d5" + ); + + scope.done(); + }); +}); diff --git a/detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorUnitTest.test.ts b/detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorUnitTest.test.ts new file mode 100644 index 0000000000..11e31b468b --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorUnitTest.test.ts @@ -0,0 +1,143 @@ +/* + * Copyright The OpenTelemetry Authors + * + * 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 + * + * https://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 * as nock from "nock"; +import * as assert from "assert"; +import { Resource } from "@opentelemetry/resources"; +import { instanaAgentDetector } from "../src"; + +describe("[UNIT] instanaAgentDetector", () => { + describe("when agent is running", function () { + before(() => { + process.env.INSTANA_RETRY_TIMEOUT = "100"; + }); + + beforeEach(() => { + nock.disableNetConnect(); + nock.cleanAll(); + }); + + afterEach(() => { + nock.enableNetConnect(); + nock.cleanAll(); + }); + + it("should return agent resource with default host/port", async () => { + const mockedReply = { + pid: 123, + agentUuid: "14:7d:da:ff:fe:e4:08:d5", + }; + + const scope = nock("http://localhost:42699") + .persist() + .put("/com.instana.plugin.nodejs.discovery") + .reply(200, () => mockedReply); + + const resource: Resource = await instanaAgentDetector.detect(); + + scope.done(); + + assert.deepEqual(resource.attributes, { + "process.pid": 123, + "instana.host.id": "14:7d:da:ff:fe:e4:08:d5", + "service.instance.id": "123", + }); + }); + + it("should return agent resource with env variables", async () => { + process.env.INSTANA_AGENT_PORT = "88866"; + process.env.INSTANA_AGENT_HOST = "instanaagent"; + + const mockedReply = { + pid: 222, + agentUuid: "14:7d:da:ff:fe:e4:08:d5", + }; + + const scope = nock( + `http://${process.env.INSTANA_AGENT_HOST}:${process.env.INSTANA_AGENT_PORT}` + ) + .persist() + .put("/com.instana.plugin.nodejs.discovery") + .reply(200, () => mockedReply); + + const resource: Resource = await instanaAgentDetector.detect(); + + scope.done(); + + assert.deepEqual(resource.attributes, { + "process.pid": 222, + "instana.host.id": "14:7d:da:ff:fe:e4:08:d5", + "service.instance.id": "222", + }); + + delete process.env.INSTANA_AGENT_PORT; + delete process.env.INSTANA_AGENT_HOST; + }); + + it("agent throws error", async () => { + const expectedError = new Error("Failed to load page, status code: 500"); + const scope = nock("http://localhost:42699") + .persist() + .put("/com.instana.plugin.nodejs.discovery") + .reply(500, () => new Error()); + + try { + await instanaAgentDetector.detect(); + assert.ok(false, "Expected to throw"); + } catch (err) { + assert.deepStrictEqual(err, expectedError); + } + + scope.done(); + }); + + it("agent timeout", async () => { + process.env.INSTANA_AGENT_TIMEOUT = "200"; + const expectedError = new Error("Instana Agent request timed out."); + + nock("http://localhost:42699") + .persist() + .put("/com.instana.plugin.nodejs.discovery") + .reply((uri, requestBody, cb) => { + setTimeout(() => cb(null, [200, {}]), 500); + }); + + try { + await instanaAgentDetector.detect(); + assert.ok(false, "Expected to throw"); + } catch (err) { + assert.deepStrictEqual(err, expectedError); + } + + delete process.env.INSTANA_AGENT_TIMEOUT; + }); + }); + + describe("when agent is not running", function () { + it("should not return agent resource", async () => { + process.env.INSTANA_AGENT_PORT = "1111"; + + try { + await instanaAgentDetector.detect(); + assert.ok(false, "Expected to throw"); + } catch (err) { + assert.equal(err.code, "ECONNREFUSED"); + } + + delete process.env.INSTANA_AGENT_PORT; + }); + }); +}); diff --git a/detectors/node/opentelemetry-resource-detector-instana/tsconfig.json b/detectors/node/opentelemetry-resource-detector-instana/tsconfig.json new file mode 100644 index 0000000000..c87523782b --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-instana/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": ["src/**/*.ts", "test/**/*.ts"] +} diff --git a/release-please-config.json b/release-please-config.json index 5adc2a410e..6bb3c3203f 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -1,8 +1,6 @@ { "bootstrap-sha": "798fb2d5c585f6fdee10146bfe15e03409bdddfe", - "plugins": [ - "node-workspace" - ], + "plugins": ["node-workspace"], "bump-minor-pre-major": true, "sequential-calls": true, "packages": { @@ -11,6 +9,7 @@ "detectors/node/opentelemetry-resource-detector-gcp": {}, "detectors/node/opentelemetry-resource-detector-github": {}, "detectors/node/opentelemetry-resource-detector-docker": {}, + "detectors/node/opentelemetry-resource-detector-instana": {}, "metapackages/auto-instrumentations-node": {}, "metapackages/auto-instrumentations-web": {}, "packages/opentelemetry-browser-extension-autoinjection": {}, @@ -57,4 +56,4 @@ "propagators/opentelemetry-propagator-grpc-census-binary": {}, "propagators/opentelemetry-propagator-ot-trace": {} } -} \ No newline at end of file +}