Skip to content

Commit 48d5480

Browse files
authored
add callout and update casing (#8262)
1 parent e112349 commit 48d5480

File tree

1 file changed

+10
-4
lines changed
  • src/pages/[platform]/build-a-backend/functions/streaming-logs

1 file changed

+10
-4
lines changed

src/pages/[platform]/build-a-backend/functions/streaming-logs/index.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export function getStaticProps(context) {
3030
};
3131
}
3232

33-
Amplify enables you to stream logs from your Function directly to your terminal while running [`ampx sandbox`](/[platform]/reference/cli-commands/#npx-ampx-sandbox). To get started, specify the `--stream-function-logs` option when starting sandbox:
33+
Amplify enables you to stream logs from your AWS Lambda functions directly to your terminal while running [`ampx sandbox`](/[platform]/reference/cli-commands/#npx-ampx-sandbox). To get started, specify the `--stream-function-logs` option when starting sandbox:
3434

3535
```bash title="Terminal" showLineNumbers={false}
3636
npx ampx sandbox --stream-function-logs
@@ -42,11 +42,17 @@ npx ampx sandbox --stream-function-logs
4242

4343
</Callout>
4444

45-
Streaming Function logs directly to your terminal enable faster debug iterations, and greater insight into your Functions' executions.
45+
Streaming function logs directly to your terminal enable faster debug iterations, and greater insight into your functions' executions.
4646

4747
## Filtering
4848

49-
By default, Amplify will stream all of your Functions' logs. If you wish to only stream a subset of Functions you can specify a filter by Function name or a regular expression for Function names. For example, if you have a collection of [Auth triggers](/[platform]/build-a-backend/auth/customize-auth-lifecycle/triggers/) where the Function names include "auth"
49+
By default, Amplify will stream all of your functions' logs. If you wish to only stream a subset of functions you can specify a filter by function name or a regular expression for function names. For example, if you have a collection of [Auth triggers](/[platform]/build-a-backend/auth/customize-auth-lifecycle/triggers/) where the function names include "auth".
50+
51+
<Callout info>
52+
53+
When working with more than 5 functions, we recommend using the `--logs-filter` flag to filter the log output to specific functions.
54+
55+
</Callout>
5056

5157
```bash title="Terminal" showLineNumbers={false}
5258
npx ampx sandbox --stream-function-logs --logs-filter auth
@@ -89,7 +95,7 @@ By default, Amplify will print logs to the terminal where sandbox is running, ho
8995
npx ampx sandbox --stream-function-logs --logs-out-file sandbox.log
9096
```
9197

92-
This can be combined with `--logs-filter` to create a log file of just your Auth-related Functions, for example:
98+
This can be combined with `--logs-filter` to create a log file of just your Auth-related functions, for example:
9399

94100
```bash title="Terminal" showLineNumbers={false}
95101
npx ampx sandbox --stream-function-logs --logs-filter auth --logs-out-file sandbox-auth.log

0 commit comments

Comments
 (0)