diff --git a/packages/opentelemetry-resource-detector-aliyun/.eslintignore b/packages/opentelemetry-resource-detector-aliyun/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/.eslintignore @@ -0,0 +1 @@ +build diff --git a/packages/opentelemetry-resource-detector-aliyun/.eslintrc.js b/packages/opentelemetry-resource-detector-aliyun/.eslintrc.js new file mode 100644 index 0000000000..9dfe62f9b8 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/.eslintrc.js @@ -0,0 +1,9 @@ +module.exports = { + "env": { + "mocha": true, + "commonjs": true, + "node": true, + "browser": true + }, + ...require('../../eslint.config.js') +} diff --git a/packages/opentelemetry-resource-detector-aliyun/.npmignore b/packages/opentelemetry-resource-detector-aliyun/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/packages/opentelemetry-resource-detector-aliyun/LICENSE b/packages/opentelemetry-resource-detector-aliyun/LICENSE new file mode 100644 index 0000000000..6b91a297c8 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/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/packages/opentelemetry-resource-detector-aliyun/README.md b/packages/opentelemetry-resource-detector-aliyun/README.md new file mode 100644 index 0000000000..6c728e7a79 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/README.md @@ -0,0 +1,54 @@ +# OpenTelemetry Resource Detector for Alibaba Cloud (Aliyun) + +[![NPM Published Version][npm-img]][npm-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +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-aliyun +``` + +## Usage + +```typescript +import { detectResources } from '@opentelemetry/resources'; +import { aliyunEcsDetector } from '@opentelemetry/resource-detector-aliyun' +const resource = await detectResources({ + detectors: [aliyunEcsDetector], +}) + +const tracerProvider = new NodeTracerProvider({ resource }); +``` + +## Available detectors + +- `aliyunEcsDetector`: Populates `cloud` and `host` for processes running on [Aliyun ECS](https://www.alibabacloud.com/product/ecs). + +## 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. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-resources +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-resources +[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-resources&type=dev +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-resources&type=dev +[npm-url]: https://www.npmjs.com/package/@opentelemetry/resources +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresources.svg + +[resource-semantic_conventions]: https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions diff --git a/packages/opentelemetry-resource-detector-aliyun/package.json b/packages/opentelemetry-resource-detector-aliyun/package.json new file mode 100644 index 0000000000..526dce9739 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/package.json @@ -0,0 +1,63 @@ +{ + "name": "@opentelemetry/resource-detector-aliyun", + "version": "0.23.0", + "description": "OpenTelemetry SDK resource detector for Aliyun", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js", + "scripts": { + "compile": "tsc --build", + "clean": "tsc --build --clean", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "tdd": "npm run test -- --watch-extensions ts --watch", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "version": "node ../../scripts/version-update.js" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "resources", + "stats", + "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/packages/opentelemetry-resource-detector-aliyun/src/detectors/AliyunEcsDetector.ts b/packages/opentelemetry-resource-detector-aliyun/src/detectors/AliyunEcsDetector.ts new file mode 100644 index 0000000000..98297e7ffe --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/src/detectors/AliyunEcsDetector.ts @@ -0,0 +1,140 @@ +/* + * 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 { + CloudProviderValues, + CloudPlatformValues, + SemanticResourceAttributes, +} from '@opentelemetry/semantic-conventions'; +import * as http from 'http'; + +/** + * The AliyunEcsDetector can be used to detect if a process is running in Aliyun ECS + * and return a {@link Resource} populated with metadata about the ECS + * instance. Returns an empty Resource if detection fails. + */ +class AliyunEcsDetector implements Detector { + /** + * See https://help.aliyun.com/document_detail/67254.html, also + * https://www.alibabacloud.com/help/doc-detail/67254.htm for documentation + * about the Aliyun instance identity document. + */ + readonly ALIYUN_IDMS_ENDPOINT = '100.100.100.200'; + readonly ALIYUN_INSTANCE_IDENTITY_DOCUMENT_PATH = + '/latest/dynamic/instance-identity/document'; + readonly ALIYUN_INSTANCE_HOST_DOCUMENT_PATH = '/latest/meta-data/hostname'; + readonly MILLISECOND_TIME_OUT = 1000; + + /** + * Attempts to connect and obtain an Aliyun 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({ + [SemanticResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.ALIYUN, + [SemanticResourceAttributes.CLOUD_PLATFORM]: CloudPlatformValues.ALIYUN_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, + }); + } + + /** + * Fetch Aliyun 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.ALIYUN_IDMS_ENDPOINT, + path: this.ALIYUN_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.ALIYUN_IDMS_ENDPOINT, + path: this.ALIYUN_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 aliyunEcsDetector = new AliyunEcsDetector(); diff --git a/packages/opentelemetry-resource-detector-aliyun/src/detectors/index.ts b/packages/opentelemetry-resource-detector-aliyun/src/detectors/index.ts new file mode 100644 index 0000000000..f6b7bad164 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/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 './AliyunEcsDetector'; diff --git a/packages/opentelemetry-resource-detector-aliyun/src/index.ts b/packages/opentelemetry-resource-detector-aliyun/src/index.ts new file mode 100644 index 0000000000..0acba8788c --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/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/packages/opentelemetry-resource-detector-aliyun/src/version.ts b/packages/opentelemetry-resource-detector-aliyun/src/version.ts new file mode 100644 index 0000000000..113a67d8b1 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/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/packages/opentelemetry-resource-detector-aliyun/test/detectors/AliyunEcsDetector.test.ts b/packages/opentelemetry-resource-detector-aliyun/test/detectors/AliyunEcsDetector.test.ts new file mode 100644 index 0000000000..74483f6635 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/test/detectors/AliyunEcsDetector.test.ts @@ -0,0 +1,138 @@ +/* + * 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 { aliyunEcsDetector } from '../../src'; +import { + assertCloudResource, + assertHostResource, +} from '@opentelemetry/resources/test/util/resource-assertions'; + +const ALIYUN_HOST = 'http://' + aliyunEcsDetector.ALIYUN_IDMS_ENDPOINT; +const ALIYUN_IDENTITY_PATH = aliyunEcsDetector.ALIYUN_INSTANCE_IDENTITY_DOCUMENT_PATH; +const ALIYUN_HOST_PATH = aliyunEcsDetector.ALIYUN_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('aliyunEcsDetector', () => { + beforeEach(() => { + nock.disableNetConnect(); + nock.cleanAll(); + }); + + afterEach(() => { + nock.enableNetConnect(); + }); + + describe('with successful request', () => { + it('should return aliyun 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 aliyunEcsDetector.detect(); + + scope.done(); + + assert.ok(resource); + + assertCloudResource(resource, { + provider: 'aliyun', + 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', + hostName: '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 aliyunEcsDetector.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 aliyunEcsDetector.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 aliyunEcsDetector.detect(); + assert.ok(false, 'Expected to throw'); + } catch (err) { + assert.deepStrictEqual(err, expectedError); + } + + scope.done(); + }); + }); +}); diff --git a/packages/opentelemetry-resource-detector-aliyun/tsconfig.json b/packages/opentelemetry-resource-detector-aliyun/tsconfig.json new file mode 100644 index 0000000000..b16c7037b4 --- /dev/null +++ b/packages/opentelemetry-resource-detector-aliyun/tsconfig.json @@ -0,0 +1,22 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ], + "references": [ + { + "path": "../opentelemetry-core" + }, + { + "path": "../opentelemetry-resources" + }, + { + "path": "../opentelemetry-semantic-conventions" + } + ] +} diff --git a/packages/opentelemetry-semantic-conventions/src/resource/SemanticResourceAttributes.ts b/packages/opentelemetry-semantic-conventions/src/resource/SemanticResourceAttributes.ts index 67f0235179..4adccebe24 100644 --- a/packages/opentelemetry-semantic-conventions/src/resource/SemanticResourceAttributes.ts +++ b/packages/opentelemetry-semantic-conventions/src/resource/SemanticResourceAttributes.ts @@ -480,6 +480,8 @@ As an alternative, consider setting `faas.id` as a span attribute instead. export enum CloudProviderValues { + /** Alibaba Cloud. */ + ALIYUN = 'aliyun', /** Amazon Web Services. */ AWS = 'aws', /** Microsoft Azure. */ @@ -492,6 +494,8 @@ export enum CloudProviderValues { export enum CloudPlatformValues { + /** Alibaba Cloud Elastic Compute Service. */ + ALIYUN_ECS = 'aliyun_ecs', /** AWS Elastic Compute Cloud. */ AWS_EC2 = 'aws_ec2', /** AWS Elastic Container Service. */