Skip to content

feat: Generate sam logs schema #5638

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
lucashuy merged 2 commits into from
Jul 28, 2023
Merged

feat: Generate sam logs schema #5638

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a46af7d
Generate sam logs schema
Jul 27, 2023
14bf626
Merge branch 'feat/json-schema' into logs-schema
Leo10Gama Jul 28, 2023
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
75 changes: 73 additions & 2 deletions schema/samcli.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1217,9 +1217,80 @@
"properties": {
"parameters": {
"title": "Parameters for the logs command",
"description": "Available parameters for the logs command:\n",
"description": "Available parameters for the logs command:\n* name:\nThe 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 given stack and find all supported resources, and start pulling log information from them.\n* stack_name:\nName of the AWS CloudFormation stack that the function is a part of.\n* filter:\nYou can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. \"error\") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\n* tail:\nTail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources\n* include_traces:\nInclude the XRay traces in the log output.\n* cw_log_group:\nAdditional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well\n* output:\nThe formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting\n* end_time:\nFetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'\n* start_time:\nFetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.\n* beta_features:\nEnable/Disable beta features.\n* debug:\nTurn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.\n* profile:\nSelect a specific profile from your credential file to get AWS credentials.\n* region:\nSet the AWS Region of the service. (e.g. us-east-1)",
"type": "object",
"properties": {}
"properties": {
"name": {
"title": "name",
"type": "string",
"description": "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 given stack and find all supported resources, and start pulling log information from them."
},
"stack_name": {
"title": "stack_name",
"type": "string",
"description": "Name of the AWS CloudFormation stack that the function is a part of."
},
"filter": {
"title": "filter",
"type": "string",
"description": "You can specify an expression to quickly find logs that match terms, phrases or values in your log events. This could be a simple keyword (e.g. \"error\") or a pattern supported by AWS CloudWatch Logs. See the AWS CloudWatch Logs documentation for the syntax https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html"
},
"tail": {
"title": "tail",
"type": "boolean",
"description": "Tail events. This will ignore the end time argument and continue to fetch events as they become available. If option --tail is provided without a --name, one will be pulled from all possible resources"
},
"include_traces": {
"title": "include_traces",
"type": "boolean",
"description": "Include the XRay traces in the log output."
},
"cw_log_group": {
"title": "cw_log_group",
"type": "string",
"description": "Additional CloudWatch Log group names that are not auto-discovered based upon --name parameter. When provided, it will only tail the given CloudWatch Log groups. If you want to tail log groups related to resources, please also provide their names as well"
},
"output": {
"title": "output",
"type": "string",
"description": "The formatting style of the command output. Following options are available:\n\nTEXT: Prints information as regular text with some formatting (default option)\n\nJSON: Prints each line as JSON without formatting",
"enum": [
"json",
"text"
]
},
"end_time": {
"title": "end_time",
"type": "string",
"description": "Fetch events up to this time. Time can be relative values like '5mins ago', 'tomorrow' or formatted timestamp like '2018-01-01 10:10:10'"
},
"start_time": {
"title": "start_time",
"type": "string",
"description": "Fetch events starting at this time. Time can be relative values like '5mins ago', 'yesterday' or formatted timestamp like '2018-01-01 10:10:10'. Defaults to '10mins ago'.",
"default": "10m ago"
},
"beta_features": {
"title": "beta_features",
"type": "boolean",
"description": "Enable/Disable beta features."
},
"debug": {
"title": "debug",
"type": "boolean",
"description": "Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps."
},
"profile": {
"title": "profile",
"type": "string",
"description": "Select a specific profile from your credential file to get AWS credentials."
},
"region": {
"title": "region",
"type": "string",
"description": "Set the AWS Region of the service. (e.g. us-east-1)"
}
}
}
},
"required": [
Expand Down