Skip to content

Commit c19b47c

Browse files
author
Michael Brewer
authored
fix(examples): fix errors in logger and metrics examples (#509)
* fix(examples): fix errors in logger and metrics examples Changes: - Use shortened imports where possible - Use 'serviceName' instead of 'service' - Correct some of the relative path imports to work again - Correct spacing around '}' - Typo in 'metrics/examples/hello-world.ts' * fix(docs): correct link to Tracer examples
1 parent 1107f96 commit c19b47c

29 files changed

+51
-53
lines changed

Diff for: ‎README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
55
| AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only. <br/>This version is not stable, and significant breaking changes might incur as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2). |_
66

7-
87
A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Python](https://github.com/awslabs/aws-lambda-powertools-python) and [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available).
98

109
**[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)**
@@ -35,7 +34,7 @@ Each TypeScript utility is installed as standalone NPM package.
3534
### Examples
3635

3736
* [CDK](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)
38-
* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/lib)
37+
* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/src)
3938
* [Logger](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/logger/examples)
4039
* [Metrics](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/metrics/examples)
4140

Diff for: ‎examples/cdk/src/example-function.Tracer.PatchAWSSDKv2.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const tracer = new Tracer({ serviceName: 'tracerPatchAWSSDKv2Fn' });
1010
// To patch a specific AWS SDK v2 Client, we pass it to the Tracer that will return an instrumented version of it
1111
const sts = tracer.captureAWSClient(new STS());
1212

13-
// Here we are showing an example with manual instrumentation but you can do the same also with the captureLambdaHandler Middy Middleware and Class decorator
13+
// Here we are showing an example with manual instrumentation, but you can do the same also with the captureLambdaHandler Middy Middleware and Class decorator
1414
// See: https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/#lambda-handler
1515
export const handler = async (_event: typeof Events.Custom.CustomEvent, _context: Context): Promise<unknown> => {
1616
const segment = tracer.getSegment(); // This is the facade segment (the one that is created by AWS Lambda)

Diff for: ‎examples/cdk/src/example-function.Tracer.PatchAWSSDKv3.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const tracer = new Tracer({ serviceName: 'tracerManualFn' });
1010
// To patch a specific AWS SDK v3 Client, we need to pass it to the Tracer that will return an instrumented version of it
1111
const sts = tracer.captureAWSv3Client(new STSClient({}));
1212

13-
// Here we are showing an example with manual instrumentation but you can do the same also with the captureLambdaHandler Middy Middleware and Class decorator
13+
// Here we are showing an example with manual instrumentation, but you can do the same also with the captureLambdaHandler Middy Middleware and Class decorator
1414
// See: https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/#lambda-handler
1515
export const handler = async (_event: typeof Events.Custom.CustomEvent, _context: Context): Promise<unknown> => {
1616
const segment = tracer.getSegment(); // This is the facade segment (the one that is created by AWS Lambda)

Diff for: ‎examples/cdk/src/example-function.Tracer.PatchAllAWSSDK.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const AWS = tracer.captureAWS(require('aws-sdk'));
1212
// Then we can use the AWS SDK as usual
1313
const sts = new AWS.STS();
1414

15-
// Here we are showing an example with manual instrumentation but you can do the same also with the captureLambdaHandler Middy Middleware and Class decorator
15+
// Here we are showing an example with manual instrumentation, but you can do the same also with the captureLambdaHandler Middy Middleware and Class decorator
1616
// See: https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/#lambda-handler
1717
export const handler = async (_event: typeof Events.Custom.CustomEvent, _context: Context): Promise<unknown> => {
1818
const segment = tracer.getSegment(); // This is the facade segment (the one that is created by AWS Lambda)

Diff for: ‎packages/logger/examples/ephemeral-attributes.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const lambdaHandler: Handler = async () => {
2626
// You can also pass multiple parameters
2727
logger.info('This is a log with 2 extra variables',
2828
{ data: myImportantVariable },
29-
{ correlationIds: { myCustomCorrelationId: 'foo-bar-baz' }}
29+
{ correlationIds: { myCustomCorrelationId: 'foo-bar-baz' } }
3030
);
3131

3232
return {

Diff for: ‎packages/logger/examples/inject-context-decorator.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ process.env.POWERTOOLS_SERVICE_NAME = 'hello-world';
77

88
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
99
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
10-
import { LambdaInterface } from '../types/LambdaInterface';
10+
import { LambdaInterface } from './utils/lambda';
1111
import { Logger } from '../src';
1212
import { Callback, Context } from 'aws-lambda/handler';
1313

Diff for: ‎packages/logger/examples/inject-context-middleware.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ require('./../tests/helpers/populateEnvironmentVariables');
55
process.env.LOG_LEVEL = 'INFO';
66
process.env.POWERTOOLS_SERVICE_NAME = 'hello-world';
77

8-
// @ts-ignore
98
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
109
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
1110
import { Handler } from 'aws-lambda';
1211
import { Logger } from '../src';
1312

14-
import { injectLambdaContext } from '../src/middleware/middy';
13+
import { injectLambdaContext } from '../src';
1514
import middy from '@middy/core';
1615

1716
const logger = new Logger();

Diff for: ‎packages/logger/examples/utils/formatters/CustomLogFormatter.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { LogFormatter } from '../../../src/formatter';
1+
import { LogFormatter } from '../../../src';
22
import { LogAttributes, UnformattedAttributes } from '../../../src/types';
33

44
type MyCompanyLog = LogAttributes;

Diff for: ‎packages/logger/examples/utils/formatters/MyCompanyLogFormatter.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { LogFormatter } from '../../../src/formatter';
1+
import { LogFormatter } from '../../../src';
22
import { LogAttributes, UnformattedAttributes } from '../../../src/types';
33

44
type MyCompanyLog = LogAttributes;

Diff for: ‎packages/metrics/examples/cold-start.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

Diff for: ‎packages/metrics/examples/constructor-options.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();
@@ -12,7 +12,7 @@ process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world';
1212

1313
const metrics = new Metrics({
1414
namespace: 'hello-world-constructor',
15-
service: 'hello-world-service-constructor'
15+
serviceName: 'hello-world-service-constructor'
1616
});
1717

1818
const lambdaHandler = async (): Promise<void> => {

Diff for: ‎packages/metrics/examples/decorator/cold-start.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
22
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
3-
import { LambdaInterface } from './../utils/lambda/LambdaInterface';
3+
import { LambdaInterface } from '../utils/lambda';
44
import { populateEnvironmentVariables } from '../../tests/helpers';
55
import { Callback, Context } from 'aws-lambda/handler';
66
import { Metrics, MetricUnits } from '../../src';

Diff for: ‎packages/metrics/examples/decorator/constructor-options.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
22
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
33
import { Metrics, MetricUnits } from '../../src';
4-
import { LambdaInterface } from './../utils/lambda';
4+
import { LambdaInterface } from '../utils/lambda';
55
import { Callback, Context } from 'aws-lambda/handler';
66

77
const metrics = new Metrics({
88
namespace: 'hello-world-constructor',
9-
service: 'hello-world-service-constructor'
9+
serviceName: 'hello-world-service-constructor'
1010
});
1111

1212
class Lambda implements LambdaInterface {

Diff for: ‎packages/metrics/examples/decorator/default-dimensions-constructor.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ populateEnvironmentVariables();
66
process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world-constructor';
77
process.env.POWERTOOLS_SERVICE_NAME = 'hello-world-service-constructor';
88

9-
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
10-
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
11-
import { LambdaInterface } from './utils/lambda/LambdaInterface';
9+
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
10+
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
11+
import { LambdaInterface } from '../utils/lambda';
1212
import { Callback, Context } from 'aws-lambda/handler';
13-
import { Metrics, MetricUnits } from '../src';
13+
import { Metrics, MetricUnits } from '../../src';
1414

1515
const metrics = new Metrics({ defaultDimensions:{ 'application': 'hello-world' } });
1616

Diff for: ‎packages/metrics/examples/decorator/default-dimensions.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ populateEnvironmentVariables();
55
// Additional runtime variables
66
process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world';
77

8-
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
9-
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
10-
import { LambdaInterface } from './utils/lambda/LambdaInterface';
8+
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
9+
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
10+
import { LambdaInterface } from '../utils/lambda';
1111
import { Callback, Context } from 'aws-lambda/handler';
12-
import { Metrics, MetricUnits } from '../src';
12+
import { Metrics, MetricUnits } from '../../src';
1313

1414
const metrics = new Metrics();
1515

Diff for: ‎packages/metrics/examples/decorator/dimensions.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ populateEnvironmentVariables();
55
// Additional runtime variables
66
process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world';
77

8-
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
9-
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
10-
import { LambdaInterface } from './utils/lambda/LambdaInterface';
8+
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
9+
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
10+
import { LambdaInterface } from '../utils/lambda';
1111
import { Callback, Context } from 'aws-lambda/handler';
12-
import { Metrics, MetricUnits } from '../src';
12+
import { Metrics, MetricUnits } from '../../src';
1313

1414
const metrics = new Metrics();
1515

Diff for: ‎packages/metrics/examples/decorator/empty-metrics.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ populateEnvironmentVariables();
55
// Additional runtime variables
66
process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world';
77

8-
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
9-
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
10-
import { LambdaInterface } from './utils/lambda/LambdaInterface';
8+
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
9+
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
10+
import { LambdaInterface } from '../utils/lambda';
1111
import { Callback, Context } from 'aws-lambda/handler';
12-
import { Metrics } from '../src';
12+
import { Metrics } from '../../src';
1313

1414
const metrics = new Metrics();
1515

Diff for: ‎packages/metrics/examples/decorator/hello-world.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ populateEnvironmentVariables();
66
process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world';
77
process.env.POWERTOOLS_SERVICE_NAME = 'hello-world-service';
88

9-
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
10-
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
11-
import { LambdaInterface } from './utils/lambda/LambdaInterface';
9+
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
10+
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
11+
import { LambdaInterface } from '../utils/lambda';
1212
import { Callback, Context } from 'aws-lambda/handler';
13-
import { Metrics, MetricUnits } from '../src';
13+
import { Metrics, MetricUnits } from '../../src';
1414

1515
const metrics = new Metrics();
1616

Diff for: ‎packages/metrics/examples/decorator/manual-flushing.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ populateEnvironmentVariables();
55
// Additional runtime variables
66
process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world';
77

8-
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
9-
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
8+
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
9+
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
1010
import { Handler } from 'aws-lambda';
11-
import { Metrics, MetricUnits } from '../src';
11+
import { Metrics, MetricUnits } from '../../src';
1212

1313
const metrics = new Metrics();
1414

Diff for: ‎packages/metrics/examples/decorator/manual-metrics-print.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ populateEnvironmentVariables();
55
// Additional runtime variables
66
process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world';
77

8-
import * as dummyEvent from '../../../tests/resources/events/custom/hello-world.json';
9-
import { context as dummyContext } from '../../../tests/resources/contexts/hello-world';
8+
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
9+
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
1010
import { Handler } from 'aws-lambda';
11-
import { Metrics, MetricUnits } from '../src';
11+
import { Metrics, MetricUnits } from '../../src';
1212

1313
const metrics = new Metrics();
1414

Diff for: ‎packages/metrics/examples/decorator/single-metric.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { populateEnvironmentVariables } from '../../tests/helpers';
22
import * as dummyEvent from '../../../../tests/resources/events/custom/hello-world.json';
33
import { context as dummyContext } from '../../../../tests/resources/contexts/hello-world';
4-
import { LambdaInterface } from './../utils/lambda/LambdaInterface';
4+
import { LambdaInterface } from '../utils/lambda';
55
import { Callback, Context } from 'aws-lambda/handler';
66
import { Metrics, MetricUnits } from '../../src';
77

Diff for: ‎packages/metrics/examples/default-dimensions-constructor.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

Diff for: ‎packages/metrics/examples/default-dimensions.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

Diff for: ‎packages/metrics/examples/dimensions.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

Diff for: ‎packages/metrics/examples/empty-metrics.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

Diff for: ‎packages/metrics/examples/hello-world.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();
@@ -17,6 +17,6 @@ const lambdaHandler = async (): Promise<void> => {
1717
};
1818

1919
const handlerWithMiddleware = middy(lambdaHandler)
20-
.use(logMetrics(metrics}));
20+
.use(logMetrics(metrics));
2121

2222
handlerWithMiddleware(dummyEvent, dummyContext, () => console.log('Lambda invoked!'));

Diff for: ‎packages/metrics/examples/manual-flushing.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

Diff for: ‎packages/metrics/examples/manual-metrics-print.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

Diff for: ‎packages/metrics/examples/single-metric.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { context as dummyContext } from '../../../tests/resources/contexts/hello
33
import { populateEnvironmentVariables } from '../tests/helpers';
44
import { Metrics, MetricUnits } from '../src';
55
import middy from '@middy/core';
6-
import { logMetrics } from '../src/middleware/middy';
6+
import { logMetrics } from '../src';
77

88
// Populate runtime
99
populateEnvironmentVariables();

0 commit comments

Comments
 (0)