Skip to content

Commit 43c7945

Browse files
flochazflochaz
authored
fix(metrics): use same naming for serviceName (#401)
1 parent 6b39f06 commit 43c7945

File tree

10 files changed

+169
-191
lines changed

10 files changed

+169
-191
lines changed

Diff for: ‎packages/logger/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
"url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues"
6464
},
6565
"dependencies": {
66-
"@aws-lambda-powertools/commons": "^0.2.0-dev.1",
66+
"@aws-lambda-powertools/commons": "^0.2.0-beta.18",
6767
"@middy/core": "^2.5.3",
6868
"@types/aws-lambda": "^8.10.72",
6969
"lodash": "^4.17.21",

Diff for: ‎packages/metrics/package-lock.json

+146-168
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎packages/metrics/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"@typescript-eslint/parser": "^5.4.0",
5959
"aws-cdk": "^1.137.0",
6060
"aws-sdk": "^2.1048.0",
61-
"esbuild": "^0.14.10",
61+
"esbuild": "0.14.5",
6262
"eslint": "^8.3.0",
6363
"eslint-import-resolver-node": "^0.3.6",
6464
"eslint-import-resolver-typescript": "^2.5.0",
@@ -80,7 +80,7 @@
8080
"url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues"
8181
},
8282
"dependencies": {
83-
"@aws-lambda-powertools/commons": "^0.2.0-dev.1",
83+
"@aws-lambda-powertools/commons": "^0.2.0-beta.18",
8484
"@types/aws-lambda": "^8.10.72"
8585
}
8686
}

Diff for: ‎packages/metrics/src/Metrics.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ const DEFAULT_NAMESPACE = 'default_namespace';
4343
* import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
4444
* import { Callback, Context } from 'aws-lambda';
4545
*
46-
* const metrics = new Metrics({namespace:"MyService", service:"withDecorator"});
46+
* const metrics = new Metrics({namespace:"MyService", serviceName:"withDecorator"});
4747
*
4848
* export class MyFunctionWithDecorator {
4949
*
@@ -70,7 +70,7 @@ const DEFAULT_NAMESPACE = 'default_namespace';
7070
* ```typescript
7171
* import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
7272
*
73-
* const metrics = new Metrics({namespace: "MyService", service: "MyFunction"});
73+
* const metrics = new Metrics({namespace: "MyService", serviceName: "MyFunction"});
7474
*
7575
* export const handler = async (_event: any, _context: any) => {
7676
* metrics.captureColdStart();
@@ -164,7 +164,7 @@ class Metrics implements MetricsInterface {
164164
* import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
165165
* import { Context } from 'aws-lambda';
166166
*
167-
* const metrics = new Metrics({namespace:"serverlessAirline", service:"orders"});
167+
* const metrics = new Metrics({namespace:"serverlessAirline", serviceName:"orders"});
168168
*
169169
* export const handler = async (event: any, context: Context) => {
170170
* metrics.captureColdStartMetric();
@@ -210,7 +210,7 @@ class Metrics implements MetricsInterface {
210210
* import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
211211
* import { Callback, Context } from 'aws-lambda';
212212
*
213-
* const metrics = new Metrics({namespace:"CDKExample", service:"withDecorator"});
213+
* const metrics = new Metrics({namespace:"CDKExample", serviceName:"withDecorator"});
214214
*
215215
* export class MyFunctionWithDecorator {
216216
*
@@ -267,7 +267,7 @@ class Metrics implements MetricsInterface {
267267
* ```typescript
268268
* import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
269269
*
270-
* const metrics = new Metrics({namespace: "CDKExample", service: "MyFunction"}); // Sets metric namespace, and service as a metric dimension
270+
* const metrics = new Metrics({namespace: "CDKExample", serviceName: "MyFunction"}); // Sets metric namespace, and service as a metric dimension
271271
*
272272
* export const handler = async (_event: any, _context: any) => {
273273
* metrics.addMetric('test-metric', MetricUnits.Count, 10);
@@ -290,7 +290,7 @@ class Metrics implements MetricsInterface {
290290
* import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
291291
* import { Context } from 'aws-lambda';
292292
*
293-
* const metrics = new Metrics({namespace:"serverlessAirline", service:"orders"});
293+
* const metrics = new Metrics({namespace:"serverlessAirline", serviceName:"orders"});
294294
*
295295
* export const handler = async (event: any, context: Context) => {
296296
* metrics.raiseOnEmptyMetrics();
@@ -380,7 +380,7 @@ class Metrics implements MetricsInterface {
380380
public singleMetric(): Metrics {
381381
return new Metrics({
382382
namespace: this.namespace,
383-
service: this.dimensions.service,
383+
serviceName: this.dimensions.service,
384384
defaultDimensions: this.defaultDimensions,
385385
singleMetric: true,
386386
});
@@ -427,12 +427,12 @@ class Metrics implements MetricsInterface {
427427
}
428428

429429
private setOptions(options: MetricsOptions): Metrics {
430-
const { customConfigService, namespace, service, singleMetric, defaultDimensions } = options;
430+
const { customConfigService, namespace, serviceName, singleMetric, defaultDimensions } = options;
431431

432432
this.setEnvVarsService();
433433
this.setCustomConfigService(customConfigService);
434434
this.setNamespace(namespace);
435-
this.setService(service);
435+
this.setService(serviceName);
436436
this.setDefaultDimensions(defaultDimensions);
437437
this.isSingleMetric = singleMetric || false;
438438

Diff for: ‎packages/metrics/src/types/Metrics.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type Dimensions = { [key: string]: string };
88
type MetricsOptions = {
99
customConfigService?: ConfigServiceInterface
1010
namespace?: string
11-
service?: string
11+
serviceName?: string
1212
singleMetric?: boolean
1313
defaultDimensions?: Dimensions
1414
};

Diff for: ‎packages/metrics/tests/e2e/standardFunctions.test.MyFunction.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const singleMetricName = process.env.EXPECTED_SINGLE_METRIC_NAME ?? 'MySingleMet
1313
const singleMetricUnit = (process.env.EXPECTED_SINGLE_METRIC_UNIT as MetricUnits) ?? MetricUnits.Percent;
1414
const singleMetricValue = process.env.EXPECTED_SINGLE_METRIC_VALUE ?? '2';
1515

16-
const metrics = new Metrics({ namespace: namespace, service: serviceName });
16+
const metrics = new Metrics({ namespace: namespace, serviceName: serviceName });
1717

1818
export const handler = async (_event: unknown, _context: Context): Promise<void> => {
1919
metrics.captureColdStartMetric();
@@ -33,5 +33,4 @@ export const handler = async (_event: unknown, _context: Context): Promise<void>
3333
metricWithItsOwnDimensions.addMetric(singleMetricName, singleMetricUnit, parseInt(singleMetricValue));
3434

3535
metrics.publishStoredMetrics();
36-
metrics.raiseOnEmptyMetrics();
3736
};

Diff for: ‎packages/metrics/tests/e2e/standardFunctions.test.ts

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
import { randomUUID } from 'crypto';
1111
import * as lambda from '@aws-cdk/aws-lambda-nodejs';
12+
import { Tracing } from '@aws-cdk/aws-lambda';
1213
import { App, Stack } from '@aws-cdk/core';
1314
import { Tracing } from '@aws-cdk/aws-lambda';
1415
import { SdkProvider } from 'aws-cdk/lib/api/aws-auth';

Diff for: ‎packages/metrics/tests/unit/Metrics.test.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ describe('Class: Metrics', () => {
4848
test('should log service dimension correctly when passed', () => {
4949
const serviceName = 'testing_name';
5050

51-
const metrics = new Metrics({ namespace: 'test', service: serviceName });
51+
const metrics = new Metrics({ namespace: 'test', serviceName: serviceName });
5252
metrics.addMetric('test_name', MetricUnits.Seconds, 14);
5353
const loggedData = metrics.serializeMetrics();
5454

@@ -286,7 +286,7 @@ describe('Class: Metrics', () => {
286286

287287
test('Cold should have service and function name if present', async () => {
288288
const serviceName = 'test-service';
289-
const metrics = new Metrics({ namespace: 'test', service: serviceName });
289+
const metrics = new Metrics({ namespace: 'test', serviceName: serviceName });
290290

291291
class LambdaFunction implements LambdaInterface {
292292
@metrics.logMetrics({ captureColdStartMetric: true })
@@ -316,7 +316,7 @@ describe('Class: Metrics', () => {
316316

317317
test('Cold should still log, without a function name', async () => {
318318
const serviceName = 'test-service';
319-
const metrics = new Metrics({ namespace: 'test', service: serviceName });
319+
const metrics = new Metrics({ namespace: 'test', serviceName: serviceName });
320320
const newDummyContext = JSON.parse(JSON.stringify(dummyContext));
321321
delete newDummyContext.functionName;
322322
class LambdaFunction implements LambdaInterface {

Diff for: ‎packages/metrics/tests/unit/middleware/middy.test.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ describe('Middy middleware', () => {
4545

4646
test('when a metrics instance receive multiple metrics with the same name, it prints multiple values in an array format', async () => {
4747
// Prepare
48-
const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
48+
const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
4949

5050
const lambdaHandler = (): void => {
5151
metrics.addMetric('successfulBooking', MetricUnits.Count, 2);
@@ -80,7 +80,7 @@ describe('Middy middleware', () => {
8080
test('when a metrics instance is passed WITH custom options, it prints the metrics in the stdout', async () => {
8181

8282
// Prepare
83-
const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
83+
const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
8484

8585
const lambdaHandler = (): void => {
8686
metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
@@ -135,7 +135,7 @@ describe('Middy middleware', () => {
135135
test('when a metrics instance is passed WITHOUT custom options, it prints the metrics in the stdout', async () => {
136136

137137
// Prepare
138-
const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
138+
const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
139139

140140
const lambdaHandler = (): void => {
141141
metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
@@ -167,7 +167,7 @@ describe('Middy middleware', () => {
167167
test('when an array of Metrics instances is passed, it prints the metrics in the stdout', async () => {
168168

169169
// Prepare
170-
const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
170+
const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
171171

172172
const lambdaHandler = (): void => {
173173
metrics.addMetric('successfulBooking', MetricUnits.Count, 1);

Diff for: ‎packages/tracing/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues"
5959
},
6060
"dependencies": {
61-
"@aws-lambda-powertools/commons": "^0.2.0-dev.1",
61+
"@aws-lambda-powertools/commons": "^0.2.0-beta.18",
6262
"@middy/core": "^2.5.3",
6363
"aws-xray-sdk-core": "^3.3.3"
6464
}

0 commit comments

Comments
 (0)