Skip to content

docs: Update logs and traces docs #4009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mildaniel merged 2 commits into from
Jun 28, 2022
Merged

docs: Update logs and traces docs #4009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2a010f
Update logs and traces docs
mildaniel Jun 28, 2022
7c39c7d
Fix typos
mildaniel Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions samcli/commands/logs/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@
$ sam logs -n HelloWorldFunction --stack-name mystack --tail \n
\b
Use the --filter option to quickly find logs that match terms, phrases or values in your log events.
$ sam logs -n HelloWorldFunction --stack-name mystack --filter "error" \n
$ sam logs -n HelloWorldFunction --stack-name mystack --filter 'error' \n
\b
Fetch logs for all supported resources in your application, and additionally from the specified log groups.
$ sam logs --cw-log-group /aws/lambda/myfunction-123 --cw-log-group /aws/lambda/myfunction-456
\b
You can now fetch logs from supported resources, by only providing --stack-name parameter
$ sam logs --stack-name mystack \n
Expand All @@ -52,9 +55,9 @@
"--name",
"-n",
multiple=True,
help="Name(s) of your AWS Lambda function. If this function is a part of a CloudFormation stack, "
"this can be the LogicalID of function resource in the CloudFormation/SAM template. "
"[Beta Feature] Multiple names can be provided by repeating the parameter again. "
help="The name of the resource for which to fetch logs. If this resource is a part of an AWS CloudFormation stack, "
"this can be the LogicalID of the resource in the CloudFormation/SAM template. "
"Multiple names can be provided by repeating the parameter again. "
"If resource is in a nested stack, name can be prepended by nested stack name to pull logs "
"from that resource (NestedStackLogicalId/ResourceLogicalId). "
"If it is not provided and no --cw-log-group have been given, it will scan "
Expand Down
6 changes: 6 additions & 0 deletions samcli/commands/traces/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@

HELP_TEXT = """
Use this command to fetch AWS X-Ray traces generated by your stack.\n
\b
Run the following command to fetch X-Ray traces by ID.
$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2
\b
Run the following command to tail X-Ray traces as they become available.
$ sam traces --tail
"""


Expand Down