Skip to content

Commit 9c06ad9

Browse files
author
Chazal
committed
chore(metrics): fix doc comments
1 parent d73ddb5 commit 9c06ad9

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

docs/core/metrics.md

+23-22
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Setting | Description | Environment variable | Constructor parameter
5555

5656
[//]:# (START EDITING FROM HERE DOWN)
5757

58+
=== "index.ts"
5859

59-
60-
```typescript hl_lines="4 6"
61-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
60+
```typescript hl_lines="5 7"
61+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
6262

6363

6464
// Sets metric namespace and service via env var
@@ -76,8 +76,8 @@ You can create metrics using `addMetric`, and you can create dimensions for all
7676
=== "Metrics"
7777

7878
```typescript hl_lines="8"
79-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
80-
import { Context } from 'aws-lambda'; // npm install @types/aws-lambda
79+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
80+
import { Context } from 'aws-lambda';
8181

8282

8383
const metrics = new Metrics({namespace:"ServerlessAirline", service:"orders"});
@@ -89,8 +89,8 @@ You can create metrics using `addMetric`, and you can create dimensions for all
8989
=== "Metrics with custom dimensions"
9090

9191
```typescript hl_lines="8-9"
92-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
93-
import { Context } from 'aws-lambda'; // npm install @types/aws-lambda
92+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
93+
import { Context } from 'aws-lambda';
9494

9595

9696
const metrics = new Metrics({namespace:"ServerlessAirline", service:"orders"});
@@ -119,8 +119,8 @@ If you'd like to remove them at some point, you can use `clearDefaultDimensions`
119119
=== "setDefaultDimensions method"
120120

121121
```typescript hl_lines="5"
122-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
123-
import { Context } from 'aws-lambda'; // npm install @types/aws-lambda
122+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
123+
import { Context } from 'aws-lambda';
124124

125125
const metrics = new Metrics({namespace:"ServerlessAirline", service:"orders"});
126126
metrics.setDefaultDimensions({ 'environment': 'prod', 'anotherDimension': 'whatever' });
@@ -133,8 +133,8 @@ If you'd like to remove them at some point, you can use `clearDefaultDimensions`
133133
=== "with logMetrics decorator"
134134

135135
```typescript hl_lines="6 11"
136-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
137-
import { Context, Callback } from 'aws-lambda'; // npm install @types/aws-lambda
136+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
137+
import { Context, Callback } from 'aws-lambda';
138138

139139

140140
const metrics = new Metrics({namespace:"ServerlessAirline", service:"orders"});
@@ -158,21 +158,22 @@ As you finish adding all your metrics, you need to serialize and flush them to s
158158
You can do that automatically with the `logMetrics` decorator.
159159

160160
!!! warning
161-
decorators can only be attached to a class declaration, method, accessor, property, or parameter. Therefore, if you are more into functional programming check the next section instead. See the [official doc](https://www.typescriptlang.org/docs/handbook/decorators.html) for more details.
161+
Decorators can only be attached to a class declaration, method, accessor, property, or parameter. Therefore, if you are more into functional programming check the next section instead. See the [official doc](https://www.typescriptlang.org/docs/handbook/decorators.html) for more details.
162162

163163
This decorator also **validates**, **serializes**, and **flushes** all your metrics. During metrics validation, if no metrics are provided then a warning will be logged, but no exception will be raised.
164164

165165
```typescript hl_lines="8"
166-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
167-
import { Context, Callback } from 'aws-lambda'; // npm install @types/aws-lambda
166+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
167+
import { Context, Callback } from 'aws-lambda';
168168

169169
const metrics = new Metrics({namespace:"ExampleApplication", service:"ExampleService"});
170170

171171
export class MyFunction {
172172

173-
@metrics.logMetrics()
174-
public handler<TEvent, TResult>(_event: TEvent, _context: Context, _callback: Callback<TResult>): void | Promise<TResult> {
175-
metrics.addMetric('BookingConfirmation', MetricUnits.Count, 1);
173+
@metrics.logMetrics()
174+
public handler<TEvent, TResult>(_event: TEvent, _context: Context, _callback: Callback<TResult>): void | Promise<TResult> {
175+
metrics.addMetric('BookingConfirmation', MetricUnits.Count, 1);
176+
}
176177
}
177178
```
178179

@@ -218,8 +219,8 @@ If you prefer not to use `logMetrics` decorator because you might want to encaps
218219
!!! warning
219220
Metrics, dimensions and namespace validation still applies.
220221

221-
```typescript hl_lines="9"
222-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
222+
```typescript hl_lines="8"
223+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
223224

224225
const metrics = new Metrics();
225226

@@ -236,7 +237,7 @@ const lambdaHandler: Handler = async () => {
236237
If you want to ensure that at least one metric is emitted, you can pass `raiseOnEmptyMetrics` to the **logMetrics** decorator:
237238

238239
```typescript hl_lines="7"
239-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
240+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
240241

241242
const metrics = new Metrics();
242243

@@ -254,7 +255,7 @@ class Lambda implements LambdaInterface {
254255
You can optionally capture cold start metrics with `logMetrics` decorator via `captureColdStartMetric` param.
255256

256257
```typescript hl_lines="7"
257-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
258+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
258259

259260
const metrics = new Metrics();
260261

@@ -284,7 +285,7 @@ You can add high-cardinality data as part of your Metrics log with `addMetadata`
284285
**This will not be available during metrics visualization** - Use **dimensions** for this purpose
285286
286287
```typescript hl_lines="9"
287-
import {Metrics, MetricUnits} from '@aws-lambda-powertools/metrics';
288+
import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
288289

289290
const metrics = new Metrics();
290291

0 commit comments

Comments
 (0)