From c1282dd5fff71a76935026f885fa1f23da6b5ad2 Mon Sep 17 00:00:00 2001 From: legendecas Date: Wed, 28 Jul 2021 11:49:55 +0800 Subject: [PATCH 1/9] feat(detectors): add alibaba cloud detector --- .../.eslintignore | 1 + .../.eslintrc.js | 7 + .../.npmignore | 4 + .../LICENSE | 201 ++++++++++++++++++ .../README.md | 31 +++ .../package.json | 67 ++++++ .../src/detectors/AlibabaCloudEcsDetector.ts | 141 ++++++++++++ .../src/detectors/index.ts | 17 ++ .../src/index.ts | 17 ++ .../src/semantic-conventions.ts | 23 ++ .../src/version.ts | 18 ++ .../detectors/AlibabaCloudEcsDetector.test.ts | 139 ++++++++++++ .../tsconfig.json | 11 + 13 files changed, 677 insertions(+) create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/.eslintignore create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/.eslintrc.js create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/.npmignore create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/LICENSE create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/index.ts create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/index.ts create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts create mode 100644 detectors/node/opentelemetry-resource-detector-alibaba-cloud/tsconfig.json diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.eslintignore b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.eslintignore @@ -0,0 +1 @@ +build diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.eslintrc.js b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.eslintrc.js new file mode 100644 index 0000000000..7b832129ab --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.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-alibaba-cloud/.npmignore b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/LICENSE b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/LICENSE new file mode 100644 index 0000000000..6b91a297c8 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/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-alibaba-cloud/README.md b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md new file mode 100644 index 0000000000..2fbf4716a2 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md @@ -0,0 +1,31 @@ +# OpenTelemetry Resource Detector for Alibaba Cloud + +Resource detector for Alibaba Cloud. + +The OpenTelemetry Resource is an immutable representation of the entity producing telemetry. For example, a process producing telemetry that is running in a container on Kubernetes has a Pod name, it is in a namespace and possibly is part of a Deployment which also has a name. All three of these attributes can be included in the `Resource`. + +[This document][resource-semantic_conventions] defines standard attributes for resources. + +## Installation + +```bash +npm install --save @opentelemetry/resource-detector-alibaba-cloud +``` + +## Usage + +```typescript +import { detectResources } from '@opentelemetry/resources'; +import { alibabaCloudEcsDetector } from '@opentelemetry/resource-detector-alibaba-cloud' +const resource = await detectResources({ + detectors: [alibabaCloudEcsDetector], +}) + +const tracerProvider = new NodeTracerProvider({ resource }); +``` + +## Available detectors + +- `alibabaCloudEcsDetector`: Populates `cloud` and `host` for processes running on [Alibaba Cloud ECS](https://www.alibabacloud.com/product/ecs). + +[resource-semantic_conventions]: https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json new file mode 100644 index 0000000000..b7193bcabe --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json @@ -0,0 +1,67 @@ +{ + "name": "@opentelemetry/resource-detector-alibaba-cloud", + "version": "0.23.0", + "description": "OpenTelemetry SDK resource detector for Alibaba Cloud", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "rimraf build/*", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../", + "compile": "npm run version:update && tsc -p .", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version", + "prepare": "npm run compile", + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "tdd": "npm run test -- --watch-extensions ts --watch", + "version:update": "node ../../../scripts/version-update.js", + "watch": "tsc -w" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "resources", + "stats", + "alibaba-cloud", + "profiling" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.0.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.1", + "@types/mocha": "8.2.3", + "@types/node": "14.17.5", + "@types/sinon": "10.0.2", + "codecov": "3.8.3", + "mocha": "7.2.0", + "nock": "12.0.3", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "sinon": "10.0.0", + "ts-mocha": "8.0.0", + "typescript": "4.3.5" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.1" + }, + "dependencies": { + "@opentelemetry/core": "0.23.0", + "@opentelemetry/resources": "0.23.0", + "@opentelemetry/semantic-conventions": "0.23.0" + } +} diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts new file mode 100644 index 0000000000..7f5f3abfd5 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -0,0 +1,141 @@ +/* + * 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 { + ResourceAttributes, +} from '@opentelemetry/semantic-conventions'; +import * as http from 'http'; +import { + CloudProviderValues, + CloudPlatformValues, +} from '../semantic-conventions'; + +/** + * The AlibabaCloudEcsDetector can be used to detect if a process is running in + * AlibabaCloud ECS and return a {@link Resource} populated with metadata about + * the ECS instance. Returns an empty Resource if detection fails. + */ +class AlibabaCloudEcsDetector implements Detector { + /** + * See https://www.alibabacloud.com/help/doc-detail/67254.htm for + * documentation about the AlibabaCloud instance identity document. + */ + readonly ALIBABA_CLOUD_IDMS_ENDPOINT = '100.100.100.200'; + readonly ALIBABA_CLOUD_INSTANCE_IDENTITY_DOCUMENT_PATH = + '/latest/dynamic/instance-identity/document'; + readonly ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH = '/latest/meta-data/hostname'; + readonly MILLISECOND_TIME_OUT = 1000; + + /** + * Attempts to connect and obtain an AlibabaCloud instance Identity document. + * If the connection is successful it returns a promise containing a + * {@link Resource} populated with instance metadata. Returns a promise + * containing an empty {@link Resource} if the connection or parsing of the + * identity document fails. + * + * @param config (unused) The resource detection config + */ + async detect(_config?: ResourceDetectionConfig): Promise { + const { + 'owner-account-id': accountId, + 'instance-id': instanceId, + 'instance-type': instanceType, + 'region-id': region, + 'zone-id': availabilityZone, + } = await this._fetchIdentity(); + const hostname = await this._fetchHost(); + + return new Resource({ + [ResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.ALIBABA_CLOUD, + [ResourceAttributes.CLOUD_PLATFORM]: CloudPlatformValues.ALIBABA_CLOUD_ECS, + [ResourceAttributes.CLOUD_ACCOUNT_ID]: accountId, + [ResourceAttributes.CLOUD_REGION]: region, + [ResourceAttributes.CLOUD_AVAILABILITY_ZONE]: availabilityZone, + [ResourceAttributes.HOST_ID]: instanceId, + [ResourceAttributes.HOST_TYPE]: instanceType, + [ResourceAttributes.HOST_NAME]: hostname, + }); + } + + /** + * Fetch AlibabaCloud instance document url with http requests. If the + * application is running on an ECS instance, we should be able to get back a + * valid JSON document. Parses that document and stores the identity + * properties in a local map. + */ + private async _fetchIdentity(): Promise { + const options = { + host: this.ALIBABA_CLOUD_IDMS_ENDPOINT, + path: this.ALIBABA_CLOUD_INSTANCE_IDENTITY_DOCUMENT_PATH, + method: 'GET', + timeout: this.MILLISECOND_TIME_OUT, + }; + const identity = await this._fetchString(options); + return JSON.parse(identity); + } + + private async _fetchHost(): Promise { + const options = { + host: this.ALIBABA_CLOUD_IDMS_ENDPOINT, + path: this.ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH, + method: 'GET', + timeout: this.MILLISECOND_TIME_OUT, + }; + return await this._fetchString(options); + } + + private async _fetchString(options: http.RequestOptions): Promise { + return new Promise((resolve, reject) => { + const timeoutId = setTimeout(() => { + req.abort(); + reject(new Error('ECS metadata api request timed out.')); + }, 1000); + + const req = http.request(options, res => { + clearTimeout(timeoutId); + const { statusCode } = res; + res.setEncoding('utf8'); + let rawData = ''; + res.on('data', chunk => (rawData += chunk)); + res.on('end', () => { + if (statusCode && statusCode >= 200 && statusCode < 300) { + try { + resolve(rawData); + } catch (e) { + reject(e); + } + } else { + reject( + new Error('Failed to load page, status code: ' + statusCode) + ); + } + }); + }); + req.on('error', err => { + clearTimeout(timeoutId); + reject(err); + }); + req.end(); + }); + } +} + +export const alibabaCloudEcsDetector = new AlibabaCloudEcsDetector(); diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/index.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/index.ts new file mode 100644 index 0000000000..362ed6ecb7 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/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 './AlibabaCloudEcsDetector'; diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/index.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/index.ts new file mode 100644 index 0000000000..0acba8788c --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/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-alibaba-cloud/src/semantic-conventions.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts new file mode 100644 index 0000000000..1b3e580fef --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts @@ -0,0 +1,23 @@ +/* + * 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 enum CloudProviderValues { + ALIBABA_CLOUD = 'alibaba_cloud', +}; + +export enum CloudPlatformValues { + ALIBABA_CLOUD_ECS = 'alibaba_cloud_ecs', +}; diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts new file mode 100644 index 0000000000..113a67d8b1 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts @@ -0,0 +1,18 @@ +/* + * 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. + */ + +// this is autogenerated file, see scripts/version-update.js +export const VERSION = '0.23.0'; diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts new file mode 100644 index 0000000000..bb21a8c952 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts @@ -0,0 +1,139 @@ +/* + * 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 { alibabaCloudEcsDetector } from '../../src'; +import { ResourceAttributes } from '@opentelemetry/semantic-conventions'; + +const ALIYUN_HOST = 'http://' + alibabaCloudEcsDetector + .ALIBABA_CLOUD_IDMS_ENDPOINT; +const ALIYUN_IDENTITY_PATH = alibabaCloudEcsDetector + .ALIBABA_CLOUD_INSTANCE_IDENTITY_DOCUMENT_PATH; +const ALIYUN_HOST_PATH = alibabaCloudEcsDetector + .ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH; + +const mockedIdentityResponse = { + 'image-id': 'my-image-id', + 'instance-id': 'my-instance-id', + 'instance-type': 'my-instance-type', + 'mac': 'my-mac', + 'owner-account-id': 'my-owner-account-id', + 'private-ipv4': 'my-private-ipv4', + 'region-id': 'my-region-id', + 'serial-number': 'my-serial-number', + 'zone-id': 'my-zone-id', +}; +const mockedHostResponse = 'my-hostname'; + +describe('alibabaCloudEcsDetector', () => { + beforeEach(() => { + nock.disableNetConnect(); + nock.cleanAll(); + }); + + afterEach(() => { + nock.enableNetConnect(); + }); + + describe('with successful request', () => { + it('should return alibaba cloud ecs instance resource', async () => { + const scope = nock(ALIYUN_HOST) + .persist() + .get(ALIYUN_IDENTITY_PATH) + .reply(200, () => mockedIdentityResponse) + .get(ALIYUN_HOST_PATH) + .reply(200, () => mockedHostResponse); + + const resource: Resource = await alibabaCloudEcsDetector.detect(); + + scope.done(); + + assert.ok(resource); + + assert.deepStrictEqual(resource.attributes, { + // cloud resources + [ResourceAttributes.CLOUD_PROVIDER]: 'alibaba_cloud', + [ResourceAttributes.CLOUD_PLATFORM]: 'alibaba_cloud_ecs', + [ResourceAttributes.CLOUD_ACCOUNT_ID]: 'my-owner-account-id', + [ResourceAttributes.CLOUD_REGION]: 'my-region-id', + [ResourceAttributes.CLOUD_AVAILABILITY_ZONE]: 'my-zone-id', + + // host resources + [ResourceAttributes.HOST_ID]: 'my-instance-id', + [ResourceAttributes.HOST_TYPE]: 'my-instance-type', + [ResourceAttributes.HOST_NAME]: 'my-hostname', + }); + }); + }); + + describe('with unsuccessful request', () => { + it('should throw when receiving error response code', async () => { + const expectedError = new Error('Failed to load page, status code: 404'); + const scope = nock(ALIYUN_HOST) + .persist() + .get(ALIYUN_IDENTITY_PATH) + .reply(200, () => mockedIdentityResponse) + .get(ALIYUN_HOST_PATH) + .reply(404, () => new Error()); + + try { + await alibabaCloudEcsDetector.detect(); + assert.ok(false, 'Expected to throw'); + } catch (err) { + assert.deepStrictEqual(err, expectedError); + } + + scope.done(); + }); + + it('should throw when timed out', async () => { + const expectedError = new Error('ECS metadata api request timed out.'); + const scope = nock(ALIYUN_HOST) + .get(ALIYUN_IDENTITY_PATH) + .reply(200, () => mockedIdentityResponse) + .get(ALIYUN_HOST_PATH) + .delayConnection(2000) + .reply(200, () => mockedHostResponse); + + try { + await alibabaCloudEcsDetector.detect(); + assert.ok(false, 'Expected to throw'); + } catch (err) { + assert.deepStrictEqual(err, expectedError); + } + + scope.done(); + }); + + it('should throw when replied with an Error', async () => { + const expectedError = new Error('NOT FOUND'); + const scope = nock(ALIYUN_HOST) + .get(ALIYUN_IDENTITY_PATH) + .replyWithError(expectedError.message); + + try { + await alibabaCloudEcsDetector.detect(); + assert.ok(false, 'Expected to throw'); + } catch (err) { + assert.deepStrictEqual(err, expectedError); + } + + scope.done(); + }); + }); +}); diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/tsconfig.json b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} From 84a7de01a7292be9f7e0aad0338fa4bed94e8dde Mon Sep 17 00:00:00 2001 From: legendecas Date: Thu, 5 Aug 2021 11:34:20 +0800 Subject: [PATCH 2/9] fixup! --- .../package.json | 16 ++++++----- .../src/detectors/AlibabaCloudEcsDetector.ts | 18 ++++++------- .../src/semantic-conventions.ts | 2 ++ .../src/version.ts | 2 +- .../detectors/AlibabaCloudEcsDetector.test.ts | 27 ++++++++++--------- 5 files changed, 35 insertions(+), 30 deletions(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json index b7193bcabe..84a53bc9aa 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json @@ -1,6 +1,6 @@ { "name": "@opentelemetry/resource-detector-alibaba-cloud", - "version": "0.23.0", + "version": "0.24.0", "description": "OpenTelemetry SDK resource detector for Alibaba Cloud", "main": "build/src/index.js", "types": "build/src/index.d.ts", @@ -43,11 +43,13 @@ "access": "public" }, "devDependencies": { - "@opentelemetry/api": "^1.0.1", + "@opentelemetry/api": "1.0.2", + "@opentelemetry/test-utils": "^0.24.0", "@types/mocha": "8.2.3", - "@types/node": "14.17.5", + "@types/node": "14.17.9", "@types/sinon": "10.0.2", "codecov": "3.8.3", + "gts": "3.1.0", "mocha": "7.2.0", "nock": "12.0.3", "nyc": "15.1.0", @@ -57,11 +59,11 @@ "typescript": "4.3.5" }, "peerDependencies": { - "@opentelemetry/api": "^1.0.1" + "@opentelemetry/api": "^1.0.2" }, "dependencies": { - "@opentelemetry/core": "0.23.0", - "@opentelemetry/resources": "0.23.0", - "@opentelemetry/semantic-conventions": "0.23.0" + "@opentelemetry/core": "^0.24.0", + "@opentelemetry/resources": "^0.24.0", + "@opentelemetry/semantic-conventions": "^0.24.0" } } diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts index 7f5f3abfd5..52dc948971 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -20,7 +20,7 @@ import { ResourceDetectionConfig, } from '@opentelemetry/resources'; import { - ResourceAttributes, + SemanticResourceAttributes, } from '@opentelemetry/semantic-conventions'; import * as http from 'http'; import { @@ -64,14 +64,14 @@ class AlibabaCloudEcsDetector implements Detector { const hostname = await this._fetchHost(); return new Resource({ - [ResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.ALIBABA_CLOUD, - [ResourceAttributes.CLOUD_PLATFORM]: CloudPlatformValues.ALIBABA_CLOUD_ECS, - [ResourceAttributes.CLOUD_ACCOUNT_ID]: accountId, - [ResourceAttributes.CLOUD_REGION]: region, - [ResourceAttributes.CLOUD_AVAILABILITY_ZONE]: availabilityZone, - [ResourceAttributes.HOST_ID]: instanceId, - [ResourceAttributes.HOST_TYPE]: instanceType, - [ResourceAttributes.HOST_NAME]: hostname, + [SemanticResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.ALIBABA_CLOUD, + [SemanticResourceAttributes.CLOUD_PLATFORM]: CloudPlatformValues.ALIBABA_CLOUD_ECS, + [SemanticResourceAttributes.CLOUD_ACCOUNT_ID]: accountId, + [SemanticResourceAttributes.CLOUD_REGION]: region, + [SemanticResourceAttributes.CLOUD_AVAILABILITY_ZONE]: availabilityZone, + [SemanticResourceAttributes.HOST_ID]: instanceId, + [SemanticResourceAttributes.HOST_TYPE]: instanceType, + [SemanticResourceAttributes.HOST_NAME]: hostname, }); } diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts index 1b3e580fef..5fb5cb3299 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts @@ -14,6 +14,8 @@ * limitations under the License. */ +// TODO(legendecas): migrate to @opentelemetry/semantic-conventions when +// these values are released. export enum CloudProviderValues { ALIBABA_CLOUD = 'alibaba_cloud', }; diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts index 113a67d8b1..2902e7d262 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/version.ts @@ -15,4 +15,4 @@ */ // this is autogenerated file, see scripts/version-update.js -export const VERSION = '0.23.0'; +export const VERSION = '0.24.0'; diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts index bb21a8c952..75acbd9069 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts @@ -18,7 +18,10 @@ import * as nock from 'nock'; import * as assert from 'assert'; import { Resource } from '@opentelemetry/resources'; import { alibabaCloudEcsDetector } from '../../src'; -import { ResourceAttributes } from '@opentelemetry/semantic-conventions'; +import { + assertCloudResource, + assertHostResource, +} from '@opentelemetry/test-utils'; const ALIYUN_HOST = 'http://' + alibabaCloudEcsDetector .ALIBABA_CLOUD_IDMS_ENDPOINT; @@ -65,18 +68,16 @@ describe('alibabaCloudEcsDetector', () => { assert.ok(resource); - assert.deepStrictEqual(resource.attributes, { - // cloud resources - [ResourceAttributes.CLOUD_PROVIDER]: 'alibaba_cloud', - [ResourceAttributes.CLOUD_PLATFORM]: 'alibaba_cloud_ecs', - [ResourceAttributes.CLOUD_ACCOUNT_ID]: 'my-owner-account-id', - [ResourceAttributes.CLOUD_REGION]: 'my-region-id', - [ResourceAttributes.CLOUD_AVAILABILITY_ZONE]: 'my-zone-id', - - // host resources - [ResourceAttributes.HOST_ID]: 'my-instance-id', - [ResourceAttributes.HOST_TYPE]: 'my-instance-type', - [ResourceAttributes.HOST_NAME]: 'my-hostname', + assertCloudResource(resource, { + provider: 'alibaba_cloud', + accountId: 'my-owner-account-id', + region: 'my-region-id', + zone: 'my-zone-id', + }); + assertHostResource(resource, { + id: 'my-instance-id', + hostType: 'my-instance-type', + name: 'my-hostname', }); }); }); From 60efe46ef601579b39edab7f9e478972c53725ba Mon Sep 17 00:00:00 2001 From: legendecas Date: Thu, 5 Aug 2021 11:35:14 +0800 Subject: [PATCH 3/9] fixup! linter autofix --- .../src/detectors/AlibabaCloudEcsDetector.ts | 13 +++++++------ .../src/semantic-conventions.ts | 4 ++-- .../test/detectors/AlibabaCloudEcsDetector.test.ts | 14 +++++++------- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts index 52dc948971..d8a40e8bcd 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -19,9 +19,7 @@ import { Resource, ResourceDetectionConfig, } from '@opentelemetry/resources'; -import { - SemanticResourceAttributes, -} from '@opentelemetry/semantic-conventions'; +import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'; import * as http from 'http'; import { CloudProviderValues, @@ -41,7 +39,8 @@ class AlibabaCloudEcsDetector implements Detector { readonly ALIBABA_CLOUD_IDMS_ENDPOINT = '100.100.100.200'; readonly ALIBABA_CLOUD_INSTANCE_IDENTITY_DOCUMENT_PATH = '/latest/dynamic/instance-identity/document'; - readonly ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH = '/latest/meta-data/hostname'; + readonly ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH = + '/latest/meta-data/hostname'; readonly MILLISECOND_TIME_OUT = 1000; /** @@ -64,8 +63,10 @@ class AlibabaCloudEcsDetector implements Detector { const hostname = await this._fetchHost(); return new Resource({ - [SemanticResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.ALIBABA_CLOUD, - [SemanticResourceAttributes.CLOUD_PLATFORM]: CloudPlatformValues.ALIBABA_CLOUD_ECS, + [SemanticResourceAttributes.CLOUD_PROVIDER]: + CloudProviderValues.ALIBABA_CLOUD, + [SemanticResourceAttributes.CLOUD_PLATFORM]: + CloudPlatformValues.ALIBABA_CLOUD_ECS, [SemanticResourceAttributes.CLOUD_ACCOUNT_ID]: accountId, [SemanticResourceAttributes.CLOUD_REGION]: region, [SemanticResourceAttributes.CLOUD_AVAILABILITY_ZONE]: availabilityZone, diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts index 5fb5cb3299..9f56a04d20 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/semantic-conventions.ts @@ -18,8 +18,8 @@ // these values are released. export enum CloudProviderValues { ALIBABA_CLOUD = 'alibaba_cloud', -}; +} export enum CloudPlatformValues { ALIBABA_CLOUD_ECS = 'alibaba_cloud_ecs', -}; +} diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts index 75acbd9069..032fdf0eeb 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts @@ -23,18 +23,18 @@ import { assertHostResource, } from '@opentelemetry/test-utils'; -const ALIYUN_HOST = 'http://' + alibabaCloudEcsDetector - .ALIBABA_CLOUD_IDMS_ENDPOINT; -const ALIYUN_IDENTITY_PATH = alibabaCloudEcsDetector - .ALIBABA_CLOUD_INSTANCE_IDENTITY_DOCUMENT_PATH; -const ALIYUN_HOST_PATH = alibabaCloudEcsDetector - .ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH; +const ALIYUN_HOST = + 'http://' + alibabaCloudEcsDetector.ALIBABA_CLOUD_IDMS_ENDPOINT; +const ALIYUN_IDENTITY_PATH = + alibabaCloudEcsDetector.ALIBABA_CLOUD_INSTANCE_IDENTITY_DOCUMENT_PATH; +const ALIYUN_HOST_PATH = + alibabaCloudEcsDetector.ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH; const mockedIdentityResponse = { 'image-id': 'my-image-id', 'instance-id': 'my-instance-id', 'instance-type': 'my-instance-type', - 'mac': 'my-mac', + mac: 'my-mac', 'owner-account-id': 'my-owner-account-id', 'private-ipv4': 'my-private-ipv4', 'region-id': 'my-region-id', From 4d93dc6693eaf97f54cacd4f400d5274ead95cd5 Mon Sep 17 00:00:00 2001 From: legendecas Date: Thu, 5 Aug 2021 11:41:54 +0800 Subject: [PATCH 4/9] fixup! pin engine node requirement to >= 8.5.0 --- .../opentelemetry-resource-detector-alibaba-cloud/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json index 84a53bc9aa..8b01b2acd6 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json @@ -29,7 +29,7 @@ "author": "OpenTelemetry Authors", "license": "Apache-2.0", "engines": { - "node": ">=8.0.0" + "node": ">=8.5.0" }, "files": [ "build/src/**/*.js", From 9c77d30f504a8c261aa8198e45d4f75b1bbf14a3 Mon Sep 17 00:00:00 2001 From: legendecas Date: Fri, 6 Aug 2021 10:30:13 +0800 Subject: [PATCH 5/9] fixup! --- .../LICENSE | 2 +- .../package.json | 3 +-- .../src/detectors/AlibabaCloudEcsDetector.ts | 24 +++++++++---------- 3 files changed, 13 insertions(+), 16 deletions(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/LICENSE b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/LICENSE index 6b91a297c8..a42588e10f 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/LICENSE +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [2020] OpenTelemetry Authors + Copyright [2021] OpenTelemetry Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json index 8b01b2acd6..2f2cfd879b 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json @@ -54,7 +54,7 @@ "nock": "12.0.3", "nyc": "15.1.0", "rimraf": "3.0.2", - "sinon": "10.0.0", + "sinon": "11.1.2", "ts-mocha": "8.0.0", "typescript": "4.3.5" }, @@ -62,7 +62,6 @@ "@opentelemetry/api": "^1.0.2" }, "dependencies": { - "@opentelemetry/core": "^0.24.0", "@opentelemetry/resources": "^0.24.0", "@opentelemetry/semantic-conventions": "^0.24.0" } diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts index d8a40e8bcd..0aed928d09 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -106,28 +106,26 @@ class AlibabaCloudEcsDetector implements Detector { private async _fetchString(options: http.RequestOptions): Promise { return new Promise((resolve, reject) => { const timeoutId = setTimeout(() => { - req.abort(); - reject(new Error('ECS metadata api request timed out.')); + req.destroy(new Error('ECS metadata api request timed out.')); }, 1000); const req = http.request(options, res => { clearTimeout(timeoutId); const { statusCode } = res; + if (statusCode && statusCode >= 200 && statusCode < 300) { + return reject( + new Error('Failed to load page, status code: ' + statusCode) + ); + } + res.setEncoding('utf8'); let rawData = ''; res.on('data', chunk => (rawData += chunk)); + res.on('error', err => { + reject(err); + }); res.on('end', () => { - if (statusCode && statusCode >= 200 && statusCode < 300) { - try { - resolve(rawData); - } catch (e) { - reject(e); - } - } else { - reject( - new Error('Failed to load page, status code: ' + statusCode) - ); - } + resolve(rawData); }); }); req.on('error', err => { From 54ef2289d984a3a2561c3abbb4d5dbf34a985053 Mon Sep 17 00:00:00 2001 From: legendecas Date: Fri, 6 Aug 2021 10:58:19 +0800 Subject: [PATCH 6/9] fixup! --- .../src/detectors/AlibabaCloudEcsDetector.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts index 0aed928d09..75fb5d6b9c 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -112,7 +112,11 @@ class AlibabaCloudEcsDetector implements Detector { const req = http.request(options, res => { clearTimeout(timeoutId); const { statusCode } = res; - if (statusCode && statusCode >= 200 && statusCode < 300) { + if ( + typeof statusCode !== 'number' || + !(statusCode >= 200 && statusCode < 300) + ) { + res.destroy(); return reject( new Error('Failed to load page, status code: ' + statusCode) ); From cfbf28858f78a0e746ba86680fe9edb5af9ea28d Mon Sep 17 00:00:00 2001 From: legendecas Date: Fri, 6 Aug 2021 16:39:06 +0800 Subject: [PATCH 7/9] fixup! remove outdated comment --- .../src/detectors/AlibabaCloudEcsDetector.ts | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts index 75fb5d6b9c..657e78bdd6 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -46,9 +46,7 @@ class AlibabaCloudEcsDetector implements Detector { /** * Attempts to connect and obtain an AlibabaCloud instance Identity document. * If the connection is successful it returns a promise containing a - * {@link Resource} populated with instance metadata. Returns a promise - * containing an empty {@link Resource} if the connection or parsing of the - * identity document fails. + * {@link Resource} populated with instance metadata. * * @param config (unused) The resource detection config */ From 7d0b63890938a12275d4032248b440eab818227c Mon Sep 17 00:00:00 2001 From: legendecas Date: Fri, 6 Aug 2021 16:39:49 +0800 Subject: [PATCH 8/9] Update detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Gerhard Stöbich --- .../src/detectors/AlibabaCloudEcsDetector.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts index 657e78bdd6..a8ab0f03f7 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -116,7 +116,7 @@ class AlibabaCloudEcsDetector implements Detector { ) { res.destroy(); return reject( - new Error('Failed to load page, status code: ' + statusCode) + new Error(`Failed to load page, status code: ${statusCode}`) ); } From 0a8166154f518a9ef97a9a9395cd527f5365f428 Mon Sep 17 00:00:00 2001 From: legendecas Date: Mon, 9 Aug 2021 11:12:24 +0800 Subject: [PATCH 9/9] fixup! --- .github/component_owners.yml | 2 ++ .../package.json | 2 +- .../src/detectors/AlibabaCloudEcsDetector.ts | 8 ++++---- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/component_owners.yml b/.github/component_owners.yml index b3c07b946c..e128aea10f 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -13,3 +13,5 @@ components: detectors/node/opentelemetry-resource-detector-aws: - NathanielRN - willarmiros + detectors/node/opentelemetry-resource-detector-alibaba-cloud: + - legendecas diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json index 2f2cfd879b..9ad7eec194 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/resource-detector-alibaba-cloud", "version": "0.24.0", - "description": "OpenTelemetry SDK resource detector for Alibaba Cloud", + "description": "OpenTelemetry resource detector for Alibaba Cloud", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts index a8ab0f03f7..9dba799287 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts +++ b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts @@ -41,7 +41,7 @@ class AlibabaCloudEcsDetector implements Detector { '/latest/dynamic/instance-identity/document'; readonly ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH = '/latest/meta-data/hostname'; - readonly MILLISECOND_TIME_OUT = 1000; + readonly MILLISECONDS_TIME_OUT = 1000; /** * Attempts to connect and obtain an AlibabaCloud instance Identity document. @@ -85,7 +85,7 @@ class AlibabaCloudEcsDetector implements Detector { host: this.ALIBABA_CLOUD_IDMS_ENDPOINT, path: this.ALIBABA_CLOUD_INSTANCE_IDENTITY_DOCUMENT_PATH, method: 'GET', - timeout: this.MILLISECOND_TIME_OUT, + timeout: this.MILLISECONDS_TIME_OUT, }; const identity = await this._fetchString(options); return JSON.parse(identity); @@ -96,7 +96,7 @@ class AlibabaCloudEcsDetector implements Detector { host: this.ALIBABA_CLOUD_IDMS_ENDPOINT, path: this.ALIBABA_CLOUD_INSTANCE_HOST_DOCUMENT_PATH, method: 'GET', - timeout: this.MILLISECOND_TIME_OUT, + timeout: this.MILLISECONDS_TIME_OUT, }; return await this._fetchString(options); } @@ -105,7 +105,7 @@ class AlibabaCloudEcsDetector implements Detector { return new Promise((resolve, reject) => { const timeoutId = setTimeout(() => { req.destroy(new Error('ECS metadata api request timed out.')); - }, 1000); + }, this.MILLISECONDS_TIME_OUT); const req = http.request(options, res => { clearTimeout(timeoutId);