fix(metrics) use same naming for serviceName

Author: flochaz

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

@@ -42,7 +42,7 @@ const DEFAULT_NAMESPACE = 'default_namespace';
  * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
  * import { Callback, Context } from 'aws-lambda';
  *
- * const metrics = new Metrics({namespace:"MyService", service:"withDecorator"});
+ * const metrics = new Metrics({namespace:"MyService", serviceName:"withDecorator"});
  *
  * export class MyFunctionWithDecorator {
  *
@@ -69,7 +69,7 @@ const DEFAULT_NAMESPACE = 'default_namespace';
  * ```typescript
  * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
  *
- * const metrics = new Metrics({namespace: "MyService", service: "MyFunction"});
+ * const metrics = new Metrics({namespace: "MyService", serviceName: "MyFunction"});
  *
  * export const handler = async (_event: any, _context: any) => {
  *   metrics.captureColdStart();
@@ -163,7 +163,7 @@ class Metrics implements MetricsInterface {
    * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
    * import { Context } from 'aws-lambda';
    *
-   * const metrics = new Metrics({namespace:"serverlessAirline", service:"orders"});
+   * const metrics = new Metrics({namespace:"serverlessAirline", serviceName:"orders"});
    *
    * export const handler = async (event: any, context: Context) => {
    *     metrics.captureColdStartMetric();
@@ -209,7 +209,7 @@ class Metrics implements MetricsInterface {
    * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
    * import { Callback, Context } from 'aws-lambda';
    *
-   * const metrics = new Metrics({namespace:"CDKExample", service:"withDecorator"});
+   * const metrics = new Metrics({namespace:"CDKExample", serviceName:"withDecorator"});
    *
    * export class MyFunctionWithDecorator {
    *
@@ -260,7 +260,7 @@ class Metrics implements MetricsInterface {
    * ```typescript
    * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
    *
-   * const metrics = new Metrics({namespace: "CDKExample", service: "MyFunction"}); // Sets metric namespace, and service as a metric dimension
+   * const metrics = new Metrics({namespace: "CDKExample", serviceName: "MyFunction"}); // Sets metric namespace, and service as a metric dimension
    *
    * export const handler = async (_event: any, _context: any) => {
    *   metrics.addMetric('test-metric', MetricUnits.Count, 10);
@@ -283,7 +283,7 @@ class Metrics implements MetricsInterface {
    * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
    * import { Context } from 'aws-lambda';
    *
-   * const metrics = new Metrics({namespace:"serverlessAirline", service:"orders"});
+   * const metrics = new Metrics({namespace:"serverlessAirline", serviceName:"orders"});
    *
    * export const handler = async (event: any, context: Context) => {
    *     metrics.raiseOnEmptyMetrics();
@@ -373,7 +373,7 @@ class Metrics implements MetricsInterface {
   public singleMetric(): Metrics {
     return new Metrics({
       namespace: this.namespace,
-      service: this.dimensions.service,
+      serviceName: this.dimensions.service,
       defaultDimensions: this.defaultDimensions,
       singleMetric: true,
     });
@@ -420,12 +420,12 @@ class Metrics implements MetricsInterface {
   }
 
   private setOptions(options: MetricsOptions): Metrics {
-    const { customConfigService, namespace, service, singleMetric, defaultDimensions } = options;
+    const { customConfigService, namespace, serviceName, singleMetric, defaultDimensions } = options;
 
     this.setEnvVarsService();
     this.setCustomConfigService(customConfigService);
     this.setNamespace(namespace);
-    this.setService(service);
+    this.setService(serviceName);
     this.setDefaultDimensions(defaultDimensions);
     this.isSingleMetric = singleMetric || false;
 

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

@@ -8,7 +8,7 @@ type Dimensions = { [key: string]: string };
 type MetricsOptions = {
   customConfigService?: ConfigServiceInterface
   namespace?: string
-  service?: string
+  serviceName?: string
   singleMetric?: boolean
   defaultDimensions?: Dimensions
 };

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

@@ -13,7 +13,7 @@ const singleMetricName = process.env.EXPECTED_SINGLE_METRIC_NAME ?? 'MySingleMet
 const singleMetricUnit = (process.env.EXPECTED_SINGLE_METRIC_UNIT as MetricUnits) ?? MetricUnits.Percent;
 const singleMetricValue = process.env.EXPECTED_SINGLE_METRIC_VALUE ?? '2';
 
-const metrics = new Metrics({ namespace: namespace, service: serviceName });
+const metrics = new Metrics({ namespace: namespace, serviceName: serviceName });
 
 export const handler = async (_event: unknown, _context: Context): Promise<void> => {
   metrics.captureColdStartMetric();

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

@@ -48,7 +48,7 @@ describe('Class: Metrics', () => {
     test('should log service dimension correctly when passed', () => {
       const serviceName = 'testing_name';
 
-      const metrics = new Metrics({ namespace: 'test', service: serviceName });
+      const metrics = new Metrics({ namespace: 'test', serviceName: serviceName });
       metrics.addMetric('test_name', MetricUnits.Seconds, 14);
       const loggedData = metrics.serializeMetrics();
 
@@ -286,7 +286,7 @@ describe('Class: Metrics', () => {
 
     test('Cold should have service and function name if present', async () => {
       const serviceName = 'test-service';
-      const metrics = new Metrics({ namespace: 'test', service: serviceName });
+      const metrics = new Metrics({ namespace: 'test', serviceName: serviceName });
 
       class LambdaFunction implements LambdaInterface {
         @metrics.logMetrics({ captureColdStartMetric: true })
@@ -316,7 +316,7 @@ describe('Class: Metrics', () => {
 
     test('Cold should still log, without a function name', async () => {
       const serviceName = 'test-service';
-      const metrics = new Metrics({ namespace: 'test', service: serviceName });
+      const metrics = new Metrics({ namespace: 'test', serviceName: serviceName });
       const newDummyContext = JSON.parse(JSON.stringify(dummyContext));
       delete newDummyContext.functionName;
       class LambdaFunction implements LambdaInterface {

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

@@ -45,7 +45,7 @@ describe('Middy middleware', () => {
 
     test('when a metrics instance receive multiple metrics with the same name, it prints multiple values in an array format', async () => {
       // Prepare
-      const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
+      const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
 
       const lambdaHandler = (): void => {
         metrics.addMetric('successfulBooking', MetricUnits.Count, 2);
@@ -80,7 +80,7 @@ describe('Middy middleware', () => {
     test('when a metrics instance is passed WITH custom options, it prints the metrics in the stdout', async () => {
 
       // Prepare
-      const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
+      const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
 
       const lambdaHandler = (): void => {
         metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
@@ -135,7 +135,7 @@ describe('Middy middleware', () => {
     test('when a metrics instance is passed WITHOUT custom options, it prints the metrics in the stdout', async () => {
 
       // Prepare
-      const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
+      const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
 
       const lambdaHandler = (): void => {
         metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
@@ -167,7 +167,7 @@ describe('Middy middleware', () => {
     test('when an array of Metrics instances is passed, it prints the metrics in the stdout', async () => {
 
       // Prepare
-      const metrics = new Metrics({ namespace:'serverlessAirline', service:'orders' });
+      const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
 
       const lambdaHandler = (): void => {
         metrics.addMetric('successfulBooking', MetricUnits.Count, 1);