diff --git a/.github/component_owners.yml b/.github/component_owners.yml index 83724acf27..0b2aa8fdc3 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -23,6 +23,8 @@ components: - legendecas packages/opentelemetry-id-generator-aws-xray: - carolabadeer + packages/opentelemetry-sampler-aws-xray: + - carolabadeer packages/opentelemetry-propagation-utils: - dyladan - pichlermarc diff --git a/packages/opentelemetry-sampler-aws-xray/.eslintignore b/packages/opentelemetry-sampler-aws-xray/.eslintignore new file mode 100644 index 0000000000..c795b054e5 --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/.eslintignore @@ -0,0 +1 @@ +build \ No newline at end of file diff --git a/packages/opentelemetry-sampler-aws-xray/.eslintrc.js b/packages/opentelemetry-sampler-aws-xray/.eslintrc.js new file mode 100644 index 0000000000..e198dc0f4d --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/.eslintrc.js @@ -0,0 +1,8 @@ +module.exports = { + "env": { + "mocha": true, + "commonjs": true, + "node": true + }, + ...require('../../eslint.config.js') +} diff --git a/packages/opentelemetry-sampler-aws-xray/LICENSE b/packages/opentelemetry-sampler-aws-xray/LICENSE new file mode 100644 index 0000000000..e50e8c80f9 --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/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 [2022] 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-sampler-aws-xray/README.md b/packages/opentelemetry-sampler-aws-xray/README.md new file mode 100644 index 0000000000..5454b1e970 --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/README.md @@ -0,0 +1,63 @@ +# AWS X-Ray Remote Sampler + +> This component is still in development and has not been released as an npm package. + +component owner: @carolabadeer + +This module provides the remote/centralized sampler for AWS X-Ray. + +## Usage + +```js + +const { AWSXRayRemoteSampler } = require('@opentelemetry/sampler-aws-xray'); +const opentelemetry = require("@opentelemetry/sdk-node"); +const { Resource } = require("@opentelemetry/resources"); +const { BatchSpanProcessor} = require('@opentelemetry/sdk-trace-base'); +const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-grpc'); +const { AWSXRayPropagator } = require("@opentelemetry/propagator-aws-xray"); +const { AWSXRayIdGenerator } = require("@opentelemetry/id-generator-aws-xray"); + + +// Initialize resource, trace exporter, span processor, and ID generator +const _resource = Resource.default().merge(new Resource({ + [SemanticResourceAttributes.SERVICE_NAME]: "remote-sampler-app", + })); +const _traceExporter = new OTLPTraceExporter(); +const _spanProcessor = new BatchSpanProcessor(_traceExporter); +const _tracerConfig = { + // add x-ray remote sampler + sampler: new AWSXRayRemoteSampler(), + idGenerator: new AWSXRayIdGenerator(), +} + +const sdk = new opentelemetry.NodeSDK({ + textMapPropagator: new AWSXRayPropagator(), + instrumentations: [ + new HttpInstrumentation(), + new AwsInstrumentation({ + suppressInternalInstrumentation: true + }), + ], + resource: _resource, + spanProcessor: _spanProcessor, + traceExporter: _traceExporter, + }); + + sdk.configureTracerProvider(_tracerConfig, _spanProcessor); + +``` + +For more details on setting up the global tracer provider to send traces to AWS X-Ray, refer to [this documentation](https://aws-otel.github.io/docs/getting-started/js-sdk/trace-manual-instr#setting-up-the-global-tracer). + +Please note that AWS Lambda does not support X-Ray remote sampling. + +## Useful links + +- [More information on OpenTelemetry](https://opentelemetry.io/) +- [More about OpenTelemetry JavaScript](https://github.com/open-telemetry/opentelemetry-js) +- [More in-depth documentation on setting up OpenTelemetry to send traces to AWS X-Ray](https://aws-otel.github.io/docs/getting-started/javascript-sdk) + +## License + +Apache 2.0 - See [LICENSE](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE) for more information. diff --git a/packages/opentelemetry-sampler-aws-xray/package.json b/packages/opentelemetry-sampler-aws-xray/package.json new file mode 100644 index 0000000000..f28f1e3332 --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/package.json @@ -0,0 +1,73 @@ +{ + "name": "@opentelemetry/sampler-aws-xray", + "version": "0.34.0", + "private": true, + "description": "OpenTelemetry remote sampler for AWS X-Ray", + "keywords": [ + "aws", + "sampler", + "nodejs", + "opentelemetry", + "AWS", + "X-Ray" + ], + "license": "Apache-2.0", + "author": "OpenTelemetry Authors", + "bugs": { + "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues" + }, + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "compile": "tsc -p .", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/sampler-aws-xray --include-dependencies", + "prewatch": "npm run precompile", + "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json", + "prepare": "npm run compile", + "tdd": "npm run test -- --watch-extensions ts --watch", + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "version:update": "node ../../scripts/version-update.js", + "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.3.0" + }, + "dependencies": { + "@opentelemetry/core": "^1.8.0", + "@opentelemetry/sdk-trace-base": "^1.8.0", + "@opentelemetry/semantic-conventions": "^1.0.0", + "axios": "^1.3.5" + }, + "devDependencies": { + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/contrib-test-utils": "^0.33.1", + "@types/mocha": "8.2.3", + "@types/node": "18.11.7", + "@types/sinon": "10.0.6", + "eslint": "8.7.0", + "expect": "29.2.0", + "mocha": "7.2.0", + "nock": "13.2.1", + "sinon": "15.0.1", + "ts-mocha": "10.0.0", + "nyc": "15.1.0", + "typescript": "4.4.4", + "gts": "3.1.0", + "@typescript-eslint/eslint-plugin": "5.8.1", + "@typescript-eslint/parser": "5.8.1" + }, + "engines": { + "node": ">=14" + } +} diff --git a/packages/opentelemetry-sampler-aws-xray/src/index.ts b/packages/opentelemetry-sampler-aws-xray/src/index.ts new file mode 100644 index 0000000000..eb37ee9739 --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/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 './remote-sampler'; +export { AWSXRaySamplerConfig } from './types'; diff --git a/packages/opentelemetry-sampler-aws-xray/src/remote-sampler.ts b/packages/opentelemetry-sampler-aws-xray/src/remote-sampler.ts new file mode 100644 index 0000000000..efa169c52a --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/src/remote-sampler.ts @@ -0,0 +1,114 @@ +/* + * 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 { + Sampler, + SamplingDecision, + SamplingResult, +} from '@opentelemetry/sdk-trace-base'; +import { diag, DiagLogger } from '@opentelemetry/api'; +import { + SamplingRule, + AWSXRaySamplerConfig, + SamplingRuleRecord, +} from './types'; +import axios from 'axios'; + +// 5 minute interval on sampling rules fetch (default polling interval) +const DEFAULT_INTERVAL_MS = 5 * 60 * 1000; +// Default endpoint for awsproxy : https://aws-otel.github.io/docs/getting-started/remote-sampling#enable-awsproxy-extension +const DEFAULT_AWS_PROXY_ENDPOINT = 'http://localhost:2000'; +const SAMPLING_RULES_PATH = '/GetSamplingRules'; + +// IN PROGRESS - SKELETON CLASS +export class AWSXRayRemoteSampler implements Sampler { + private _pollingInterval: number; + private _awsProxyEndpoint: string; + private _samplerDiag: DiagLogger; + + constructor(samplerConfig: AWSXRaySamplerConfig) { + this._pollingInterval = + samplerConfig.pollingIntervalMs ?? DEFAULT_INTERVAL_MS; + this._awsProxyEndpoint = samplerConfig.endpoint + ? samplerConfig.endpoint + : DEFAULT_AWS_PROXY_ENDPOINT; + + if (this._pollingInterval <= 0) { + throw new TypeError('pollingInterval must be a positive integer'); + } + + this._samplerDiag = diag.createComponentLogger({ + namespace: '@opentelemetry/sampler-aws-xray', + }); + + // execute first get Sampling rules update using polling interval + this.startRulePoller(); + } + + shouldSample(): SamplingResult { + // Implementation to be added + return { decision: SamplingDecision.NOT_RECORD }; + } + + toString(): string { + return `AWSXRayRemoteSampler{endpoint=${this._awsProxyEndpoint}, pollingInterval=${this._pollingInterval}}`; + } + + private getAndUpdateSamplingRules = async (): Promise => { + let samplingRules: SamplingRule[] = []; // reset rules array + + const requestConfig = { + headers: { + 'Content-Type': 'application/json', + }, + }; + + try { + const samplingRulesEndpoint = + this._awsProxyEndpoint + SAMPLING_RULES_PATH; + const response = await axios.post( + samplingRulesEndpoint, + {}, + requestConfig + ); + const responseJson = response.data; + + samplingRules = + responseJson?.SamplingRuleRecords.map( + (record: SamplingRuleRecord) => record.SamplingRule + ).filter(Boolean) ?? []; + + // TODO: pass samplingRules to rule cache, temporarily logging the samplingRules array + this._samplerDiag.debug('sampling rules: ', samplingRules); + } catch (error) { + // Log error + this._samplerDiag.warn('Error fetching sampling rules: ', error); + } + }; + + // fetch sampling rules every polling interval + private startRulePoller(): void { + // execute first update + // this.getAndUpdateSamplingRules() never rejects. Using void operator to suppress @typescript-eslint/no-floating-promises. + void this.getAndUpdateSamplingRules(); + // Update sampling rules every 5 minutes (or user-defined polling interval) + const rulePoller = setInterval( + () => this.getAndUpdateSamplingRules(), + this._pollingInterval + ); + rulePoller.unref(); + } +} diff --git a/packages/opentelemetry-sampler-aws-xray/src/types.ts b/packages/opentelemetry-sampler-aws-xray/src/types.ts new file mode 100644 index 0000000000..de595ad77b --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/src/types.ts @@ -0,0 +1,90 @@ +/* + * 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. + */ + +// X-Ray Sampling rule reference: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html +export interface SamplingRule { + // a unique name for the rule + RuleName: string; + + // (integer between 1 and 9999) - the priority of the sampling rule. Services evaluate rules in ascending order of + // priority, and make a sampling decision with the first rule that matches. + Priority: number; + + // A fixed number of matching requests to instrument per second, before applying the fixed rate. + ReservoirSize: number; + + // The percentage of matching requests to instrument, after the reservoir is exhausted. + FixedRate: number; + + // The name of the instrumented service, as it appears in the X-Ray service map. + ServiceName: string; + + // The service type, as it appears in the X-Ray service map. + ServiceType: string; + + // The hostname from the HTTP host header. + Host: string; + + // The method of the HTTP request. + HTTPMethod: string; + + // the URL path of the request + URLPath: string; + + // The ARN of the AWS resource running the service. + ResourceARN: string; + + // (Optional) segment attributes that are known when the sampling decision is made. + Attributes?: { [key: string]: string }; + Version: number; +} + +export interface SamplingRuleRecord { + CreatedAt: number; + ModifiedAt: number; + SamplingRule?: SamplingRule; +} + +export interface GetSamplingRulesResponse { + NextToken?: string; + SamplingRuleRecords?: SamplingRuleRecord[]; +} + +// samplingStatisticsDocument is used to store current state of sampling data. +export interface SamplingStatisticsDocument { + // A unique identifier for the service in hexadecimal. + ClientID: string; + // The name of the sampling rule. + RuleName: string; + // The number of requests that matched the rule. + RequestCount: number; + // The number of requests borrowed. + BorrowCount: number; + // The number of requests sampled using the rule. + SampledCount: number; + // The current time. + Timestamp: number; +} + +export interface AWSXRaySamplerConfig { + // endpoint of awsproxy - for more information see https://aws-otel.github.io/docs/getting-started/remote-sampling + // defaults to localhost:2000 if not specified + endpoint?: string; + + // interval of polling sampling rules (in ms) + // defaults to 5 minutes if not specified + pollingIntervalMs?: number; +} diff --git a/packages/opentelemetry-sampler-aws-xray/test/remote-sampler.test.ts b/packages/opentelemetry-sampler-aws-xray/test/remote-sampler.test.ts new file mode 100644 index 0000000000..b7d31c7fd4 --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/test/remote-sampler.test.ts @@ -0,0 +1,173 @@ +/* + * 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 sinon from 'sinon'; +import axios from 'axios'; +import * as nock from 'nock'; +import * as assert from 'assert'; + +import { AWSXRayRemoteSampler } from '../src'; + +describe('GetSamplingRules', () => { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const getSamplingRulesResponseStub: any = { + NextToken: null, + SamplingRuleRecords: [ + { + CreatedAt: 1.67799933e9, + ModifiedAt: 1.67799933e9, + SamplingRule: { + Attributes: { + foo: 'bar', + doo: 'baz', + }, + FixedRate: 0.05, + HTTPMethod: '*', + Host: '*', + Priority: 1000, + ReservoirSize: 10, + ResourceARN: '*', + RuleARN: 'arn:aws:xray:us-west-2:123456789000:sampling-rule/Rule1', + RuleName: 'Rule1', + ServiceName: '*', + ServiceType: 'AWS::Foo::Bar', + URLPath: '*', + Version: 1, + }, + }, + { + CreatedAt: 0.0, + ModifiedAt: 1.611564245e9, + SamplingRule: { + Attributes: {}, + FixedRate: 0.05, + HTTPMethod: '*', + Host: '*', + Priority: 10000, + ReservoirSize: 1, + ResourceARN: '*', + RuleARN: 'arn:aws:xray:us-west-2:123456789000:sampling-rule/Default', + RuleName: 'Default', + ServiceName: '*', + ServiceType: '*', + URLPath: '*', + Version: 1, + }, + }, + { + CreatedAt: 1.676038494e9, + ModifiedAt: 1.676038494e9, + SamplingRule: { + Attributes: {}, + FixedRate: 0.2, + HTTPMethod: 'GET', + Host: '*', + Priority: 1, + ReservoirSize: 10, + ResourceARN: '*', + RuleARN: 'arn:aws:xray:us-west-2:123456789000:sampling-rule/Rule2', + RuleName: 'Rule2', + ServiceName: 'FooBar', + ServiceType: '*', + URLPath: '/foo/bar', + Version: 1, + }, + }, + ], + }; + + let clock: sinon.SinonFakeTimers; + let sampler: AWSXRayRemoteSampler; + let axiosPostSpy: sinon.SinonSpy; + + const defaultEndpoint = 'http://localhost:1234'; + const pollingInterval = 60 * 1000; + const config = { + endpoint: defaultEndpoint, + pollingIntervalMs: pollingInterval, + }; + + before(() => { + nock('http://localhost:2000') + .persist() + .post('/GetSamplingRules') + .reply(200, getSamplingRulesResponseStub); + }); + + beforeEach(() => { + clock = sinon.useFakeTimers(); + axiosPostSpy = sinon.spy(axios, 'post'); + sampler = new AWSXRayRemoteSampler(config); + }); + + afterEach(() => { + clock.restore(); + axiosPostSpy.restore(); + }); + + it('should throw TypeError when an invalid polling interval is passed in', async () => { + const configWithZeroPollingInterval = { + pollingIntervalMs: 0, + }; + const configWithNegativeInterval = { + pollingIntervalMs: -5, + }; + + assert.throws( + () => new AWSXRayRemoteSampler(configWithZeroPollingInterval), + TypeError + ); + assert.throws( + () => new AWSXRayRemoteSampler(configWithNegativeInterval), + TypeError + ); + }); + + it('should make a POST request to the /GetSamplingRules endpoint upon initialization', async () => { + sinon.assert.calledOnce(axiosPostSpy); + }); + + it('should make a POST request to the /GetSamplingRules endpoint', async () => { + clock.tick(pollingInterval); + sinon.assert.calledTwice(axiosPostSpy); + }); + + it('should make 3 POST requests to the /GetSamplingRules endpoint after 3 intervals have passed', async () => { + clock.tick(pollingInterval); + clock.tick(pollingInterval); + + sinon.assert.calledThrice(axiosPostSpy); + }); + + it('should initialize endpoint and polling interval from config correctly', async () => { + assert.strictEqual( + sampler.toString(), + `AWSXRayRemoteSampler{endpoint=${defaultEndpoint}, pollingInterval=${pollingInterval}}` + ); + }); + + it('should fall back to default polling interval and endpoint if not specified in config', async () => { + const sampler = new AWSXRayRemoteSampler({}); + + // default polling interval (5 minutes) = 5 * 60 * 1000 + assert.strictEqual( + sampler.toString(), + `AWSXRayRemoteSampler{endpoint=http://localhost:2000, pollingInterval=${ + 5 * 60 * 1000 + }}` + ); + }); +}); diff --git a/packages/opentelemetry-sampler-aws-xray/tsconfig.esm.json b/packages/opentelemetry-sampler-aws-xray/tsconfig.esm.json new file mode 100644 index 0000000000..a94adff6aa --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/tsconfig.esm.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.base.esm.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build/esm", + "tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ] +} diff --git a/packages/opentelemetry-sampler-aws-xray/tsconfig.json b/packages/opentelemetry-sampler-aws-xray/tsconfig.json new file mode 100644 index 0000000000..4078877ce6 --- /dev/null +++ b/packages/opentelemetry-sampler-aws-xray/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +}