Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(resource-detector-aws): allow synchronous lambda detection #1274

Closed
wants to merge 1 commit into from
Closed

feat(resource-detector-aws): allow synchronous lambda detection #1274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsLambdaDetector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ import {
Detector,
Resource,
ResourceDetectionConfig,
} from '@opentelemetry/resources';
} from "@opentelemetry/resources";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems you should tell your editor to leave ' untouched :o)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to me it should be set at the repo level :D. But fair, will do

import {
CloudProviderValues,
CloudPlatformValues,
SemanticResourceAttributes,
} from '@opentelemetry/semantic-conventions';
} from "@opentelemetry/semantic-conventions";

/**
* The AwsLambdaDetector can be used to detect if a process is running in AWS Lambda
* and return a {@link Resource} populated with data about the environment.
* Returns an empty Resource if detection fails.
*/
export class AwsLambdaDetector implements Detector {
async detect(_config?: ResourceDetectionConfig): Promise<Resource> {
detectSync(_config?: ResourceDetectionConfig): Resource {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we add this option for sync detection, we should probably also document it in the README so users are aware of it and how to leverage it.

const functionName = process.env.AWS_LAMBDA_FUNCTION_NAME;
if (!functionName) {
return Resource.empty();
Expand Down Expand Up @@ -61,6 +61,10 @@ export class AwsLambdaDetector implements Detector {

return new Resource(attributes);
}

async detect(_config?: ResourceDetectionConfig): Promise<Resource> {
return this.detectSync(_config);
}
}

export const awsLambdaDetector = new AwsLambdaDetector();
50 changes: 33 additions & 17 deletions detectors/node/opentelemetry-resource-detector-aws/test/detectors/AwsLambdaDetector.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
* limitations under the License.
*/

import * as assert from 'assert';
import * as assert from "assert";
import {
assertCloudResource,
assertEmptyResource,
} from '@opentelemetry/contrib-test-utils';
} from "@opentelemetry/contrib-test-utils";

import { awsLambdaDetector } from '../../src';
import { awsLambdaDetector } from "../../src";

describe('awsLambdaDetector', () => {
describe("awsLambdaDetector", () => {
let oldEnv: NodeJS.ProcessEnv;

beforeEach(() => {
Expand All @@ -33,28 +33,44 @@ describe('awsLambdaDetector', () => {
process.env = oldEnv;
});

describe('on lambda', () => {
it('fills resource', async () => {
process.env.AWS_LAMBDA_FUNCTION_NAME = 'name';
process.env.AWS_LAMBDA_FUNCTION_VERSION = 'v1';
process.env.AWS_REGION = 'us-east-1';
describe("on lambda", () => {
it("fills resource", async () => {
process.env.AWS_LAMBDA_FUNCTION_NAME = "name";
process.env.AWS_LAMBDA_FUNCTION_VERSION = "v1";
process.env.AWS_REGION = "us-east-1";

const resource = await awsLambdaDetector.detect();

assertCloudResource(resource, {
provider: 'aws',
region: 'us-east-1',
provider: "aws",
region: "us-east-1",
});

assert.strictEqual(resource.attributes['faas.name'], 'name');
assert.strictEqual(resource.attributes['faas.version'], 'v1');
assert.strictEqual(resource.attributes["faas.name"], "name");
assert.strictEqual(resource.attributes["faas.version"], "v1");
});

it("also works synchronously", async () => {
process.env.AWS_LAMBDA_FUNCTION_NAME = "name";
process.env.AWS_LAMBDA_FUNCTION_VERSION = "v1";
process.env.AWS_REGION = "us-east-1";

const resource = awsLambdaDetector.detectSync();

assertCloudResource(resource, {
provider: "aws",
region: "us-east-1",
});

assert.strictEqual(resource.attributes["faas.name"], "name");
assert.strictEqual(resource.attributes["faas.version"], "v1");
});
});

describe('not on lambda', () => {
it('returns empty resource', async () => {
process.env.AWS_LAMBDA_FUNCTION_VERSION = 'v1';
process.env.AWS_REGION = 'us-east-1';
describe("not on lambda", () => {
it("returns empty resource", async () => {
process.env.AWS_LAMBDA_FUNCTION_VERSION = "v1";
process.env.AWS_REGION = "us-east-1";

const resource = await awsLambdaDetector.detect();

Expand Down