文档 AWS SDK 示例 GitHub 存储库中还有更多 S AWS DK 示例
本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
应用信号示例,使用 AWS CLI
以下代码示例向您展示了如何使用 with Application Signals 来执行操作和实现常见场景。 AWS Command Line Interface
操作是大型程序的代码摘录,必须在上下文中运行。您可以通过操作了解如何调用单个服务函数,还可以通过函数相关场景的上下文查看操作。
每个示例都包含一个指向完整源代码的链接,您可以从中找到有关如何在上下文中设置和运行代码的说明。
主题
操作
以下代码示例演示了如何使用 batch-get-service-level-objective-budget-report
。
- AWS CLI
-
检索一个或多个服务水平目标 (SLO) 预算报告。
以下
batch-get-service-level-objective-budget-report
示例检索一个或多个服务水平目标 (SLO) 预算报告。aws application-signals batch-get-service-level-objective-budget-report \ --timestamp
1735059869
\ --slo-ids"arn:aws:application-signals:us-east-1:123456789101:slo/SLOName1"
"arn:aws:application-signals:us-east-1:123456789101:slo/SLOName2"
输出:
{ "Timestamp": "2024-12-24T22:34:29+05:30", "Reports": [{ "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName1", "Name": "Your SLO Name", "EvaluationType": "PeriodBased", "BudgetStatus": "OK", "Attainment": 100.0, "TotalBudgetSeconds": 6048, "BudgetSecondsRemaining": 6048, "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-0e098765432522" }] }, "Period": 60, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 99.0, "WarningThreshold": 50.0 } }, { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName2", "Name": "test", "EvaluationType": "PeriodBased", "BudgetStatus": "BREACHED", "Attainment": 97.39583275, "TotalBudgetSeconds": 86, "BudgetSecondsRemaining": -2154, "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "cwMetric", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-0e12345678922" }] }, "Period": 300, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 5.0, "ComparisonOperator": "GreaterThan" }, "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 1 } }, "AttainmentGoal": 99.9, "WarningThreshold": 30.0 } } ], "Errors": [] }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考BatchGetServiceLevelObjectiveBudgetReport
中的。
-
以下代码示例演示了如何使用 create-service-level-objective
。
- AWS CLI
-
创建服务级别目标 (SLO)
以下
create-service-level-objective
示例创建了一个服务级别目标 (SLO),它可以帮助您确保关键业务运营满足客户期望。aws application-signals create-service-level-objective \ --name
"SLOName"
\ --description"Description of your SLO"
\ --sli-configfile://sli-config.json
sli-config.json
的内容:{ "SliMetricConfig": { "MetricDataQueries": [ { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0e5a1234561522" } ] }, "Period": 60, "Stat": "Average" }, "ReturnData": true } ] }, "MetricThreshold": 200, "ComparisonOperator": "LessThanOrEqualTo" }
输出:
{ "Slo": { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "Name": "SLOName", "Description": "Description of your SLO", "CreatedTime": "2024-12-27T08:16:09.032000+05:30", "LastUpdatedTime": "2024-12-27T08:16:09.032000+05:30", "Sli": { "SliMetric": { "MetricDataQueries": [ { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0e59876543234522" } ] }, "Period": 60, "Stat": "Average" }, "ReturnData": true } ] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "EvaluationType": "PeriodBased", "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 99.0, "WarningThreshold": 50.0 } } }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考CreateServiceLevelObjective
中的。
-
以下代码示例演示了如何使用 delete-service-level-objective
。
- AWS CLI
-
删除指定的服务级别目标。
以下
delete-service-level-objective
示例删除了指定的服务级别目标。aws application-signals delete-service-level-objective \ --id
"arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
此命令不生成任何输出。
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考DeleteServiceLevelObjective
中的。
-
以下代码示例演示了如何使用 get-service-level-objective
。
- AWS CLI
-
返回有关在账户中创建的 SLO 的信息
以下
get-service-level-objective
示例返回有关在账户中创建的一个 SLO 的信息。aws application-signals get-service-level-objective \ --id
"arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
输出:
{ "Slo": { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "Name": "SLOName", "Description": "Description of your SLO", "CreatedTime": "2024-12-24T22:19:18.624000+05:30", "LastUpdatedTime": "2024-12-24T22:19:55.280000+05:30", "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-0e0987654321522" }] }, "Period": 60, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "EvaluationType": "PeriodBased", "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 99.0, "WarningThreshold": 50.0 } } }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考GetServiceLevelObjective
中的。
-
以下代码示例演示了如何使用 get-service
。
- AWS CLI
-
返回有关应用程序信号发现的服务的信息
以下
get-service
示例返回有关应用程序信号发现的服务的信息。aws application-signals get-service \ --start-time
1732704000
\ --end-time1732714500
\ --key-attributesEnvironment=lambda:default,Name=hello-world-python,Type=Service
输出:
{ "Service": { "KeyAttributes": { "Environment": "lambda:default", "Name": "hello-world-python", "Type": "Service" }, "AttributeMaps": [{ "Lambda.Function.Name": "hello-world-python", "PlatformType": "AWS::Lambda" }], "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Error" }], "LogGroupReferences": [{ "Identifier": "/aws/lambda/hello-world-python", "ResourceType": "AWS::Logs::LogGroup", "Type": "AWS::Resource" }] }, "StartTime": "2024-11-27T10:00:00+00:00", "EndTime": "2024-11-27T14:00:01+00:00", "LogGroupReferences": [{ "Identifier": "/aws/lambda/hello-world-python", "ResourceType": "AWS::Logs::LogGroup", "Type": "AWS::Resource" }] }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考GetService
中的。
-
以下代码示例演示了如何使用 list-service-dependencies
。
- AWS CLI
-
返回您指定的服务的服务依赖关系列表
以下
list-service-dependencies
示例返回您指定的服务的服务依赖关系列表。aws application-signals list-service-dependencies \ --start-time
1732021200
\ --end-time1732107600
\ --key-attributesEnvironment=api-gateway:prod,
Name=PetAdoptionStatusUpdater,Type=Service
输出:
{ "ServiceDependencies": [{ "OperationName": "PUT /prod", "DependencyKeyAttributes": { "Environment": "lambda:default", "Name": "Services-name", "Type": "Service" }, "DependencyOperationName": "Invoke", "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "api-gateway:prod" }, { "Name": "Operation", "Value": "PUT /prod" }, { "Name": "RemoteEnvironment", "Value": "lambda:default" }, { "Name": "RemoteOperation", "Value": "Invoke" }, { "Name": "RemoteService", "Value": "Services-name" }, { "Name": "Service", "Value": "PetAdoptionStatusUpdater" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "api-gateway:prod" }, { "Name": "Operation", "Value": "PUT /prod" }, { "Name": "RemoteEnvironment", "Value": "lambda:default" }, { "Name": "RemoteOperation", "Value": "Invoke" }, { "Name": "RemoteService", "Value": "Services-name" }, { "Name": "Service", "Value": "PetAdoptionStatusUpdater" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "api-gateway:prod" }, { "Name": "Operation", "Value": "PUT /prod" }, { "Name": "RemoteEnvironment", "Value": "lambda:default" }, { "Name": "RemoteOperation", "Value": "Invoke" }, { "Name": "RemoteService", "Value": "Services-name" }, { "Name": "Service", "Value": "PetAdoptionStatusUpdater" }], "MetricName": "Error" }] }], "StartTime": "2024-11-19T13:00:00+00:00", "EndTime": "2024-11-20T13:00:01+00:00" }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考ListServiceDependencies
中的。
-
以下代码示例演示了如何使用 list-service-dependents
。
- AWS CLI
-
返回在提供的时间范围内调用指定服务的依赖者列表
以下
list-service-dependents
示例返回在提供的时间范围内调用指定服务的依赖者列表。aws application-signals list-service-dependents \ --start-time
1732021200
\ --end-time1732107600
\ --key-attributesEnvironment=generic:default,Name=PetSite,Type=Service
输出:
{ "ServiceDependents": [{ "OperationName": "", "DependentKeyAttributes": { "Identifier": "pet-api-canary-hao", "ResourceType": "AWS::Synthetics::Canary", "Type": "AWS::Resource" }, "DependentOperationName": "", "MetricReferences": [] }, { "OperationName": "", "DependentKeyAttributes": { "Identifier": "PetSite", "ResourceType": "AWS::Synthetics::Canary", "Type": "AWS::Resource" }, "DependentOperationName": "", "MetricReferences": [] }], "StartTime": "2024-12-24T05:00:00+00:00", "EndTime": "2024-12-25T06:00:01+00:00" }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考ListServiceDependents
中的。
-
以下代码示例演示了如何使用 list-service-level-objectives
。
- AWS CLI
-
返回在此账户中 SLOs 创建的列表。
以下
list-service-level-objectives
示例返回在此账户中 SLOs 创建的列表。aws application-signals list-service-level-objectives
输出:
{ "SloSummaries": [{ "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/test", "Name": "test", "CreatedTime": "2024-12-24T22:01:21.116000+05:30" }] }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考ListServiceLevelObjectives
中的。
-
以下代码示例演示了如何使用 list-service-operations
。
- AWS CLI
-
返回应用程序信号已发现的此服务操作的列表
以下
list-service-operations
示例返回 Application Signals 发现的此服务操作的列表。aws application-signals list-service-operations \ --start-time
1735017423
\ --end-time1735103823
\ --key-attributesEnvironment=generic:default,Name=payforadoption,Type=Service
输出:
{ "ServiceOperations": [{ "Name": "POST /api", "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "generic:default" }, { "Name": "Operation", "Value": "POST /api" }, { "Name": "Service", "Value": "payforadoption" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "generic:default" }, { "Name": "Operation", "Value": "POST /api" }, { "Name": "Service", "Value": "payforadoption" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "generic:default" }, { "Name": "Operation", "Value": "POST /api" }, { "Name": "Service", "Value": "payforadoption" }], "MetricName": "Error" }] }], "StartTime": "2024-12-24T05:00:00+00:00", "EndTime": "2024-12-25T06:00:01+00:00" }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考ListServiceOperations
中的。
-
以下代码示例演示了如何使用 list-services
。
- AWS CLI
-
返回应用程序信号发现的服务列表
以下
list-services
示例返回应用程序信号发现的服务列表。aws application-signals list-services \ --start-time
1734918791
\ --end-time1734965591
输出:
{ "ServiceSummaries": [{ "KeyAttributes": { "Environment": "lambda:default", "Name": "hello-world-python", "Type": "Service" }, "AttributeMaps": [{ "Lambda.Function.Name": "hello-world-python", "PlatformType": "AWS::Lambda" }], "MetricReferences": [{ "Namespace": "ApplicationSignals", "MetricType": "LATENCY", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Latency" }, { "Namespace": "ApplicationSignals", "MetricType": "FAULT", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Fault" }, { "Namespace": "ApplicationSignals", "MetricType": "ERROR", "Dimensions": [{ "Name": "Environment", "Value": "lambda:default" }, { "Name": "Service", "Value": "hello-world-python" }], "MetricName": "Error" }] }], "StartTime": "2024-11-27T10:00:00+00:00", "EndTime": "2024-11-27T14:00:01+00:00" }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考ListServices
中的。
-
以下代码示例演示了如何使用 list-tags-for-resource
。
- AWS CLI
-
显示与 CloudWatch 资源关联的标签
以下
list-tags-for-resource
示例显示了与 CloudWatch 资源关联的标签。aws application-signals list-tags-for-resource \ --resource-arn
"arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
输出:
{ "Tags": [{ "Key": "test", "Value": "value" }] }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考ListTagsForResource
中的。
-
以下代码示例演示了如何使用 start-discovery
。
- AWS CLI
-
为了使此 Amazon Web Services 账户能够使用 CloudWatch 应用程序信号
以下
start-discovery
示例通过创建AWS ServiceRoleForCloudWatchApplicationSignals服务相关角色使此 Amazon Web Services 账户能够使用 CloudWatch 应用程序信号。aws application-signals start-discovery
此命令不生成任何输出。
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考StartDiscovery
中的。
-
以下代码示例演示了如何使用 tag-resource
。
- AWS CLI
-
为指定 CloudWatch 资源(例如服务级别目标)分配一个或多个标签(键值对)
以下
tag-resource
示例为指定 CloudWatch 资源(例如服务级别目标)分配一个或多个标签(键值对)。aws application-signals tag-resource \ --resource-arn
"arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
\ --tags '{"Key":"test","Value":"value"}
'此命令不生成任何输出。
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考TagResource
中的。
-
以下代码示例演示了如何使用 untag-resource
。
- AWS CLI
-
从指定资源中移除一个或多个标签
以下
untag-resource
示例从指定资源中移除一个或多个标签。aws application-signals untag-resource \ --resource-arn
"arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
\ --tag-keys"test"
此命令不生成任何输出。
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考UntagResource
中的。
-
以下代码示例演示了如何使用 update-service-level-objective
。
- AWS CLI
-
更新现有服务级别目标 (SLO)
以下
update-service-level-objective
示例更新了现有的服务级别目标 (SLO)。aws application-signals update-service-level-objective \ --cli-input-json
file://update-slo.json
update-slo.json
的内容:{ "id": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 90.0, "WarningThreshold": 50.0 } }
输出:
{ "Slo": { "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName", "Name": "SLOName", "Description": "Description of your SLO", "CreatedTime": "2024-12-24T22:19:18.624000+05:30", "LastUpdatedTime": "2024-12-27T08:51:38.278000+05:30", "Sli": { "SliMetric": { "MetricDataQueries": [{ "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "CPUUtilization", "Dimensions": [{ "Name": "InstanceId", "Value": "i-00987654345222" }] }, "Period": 60, "Stat": "Average" }, "ReturnData": true }] }, "MetricThreshold": 200.0, "ComparisonOperator": "LessThanOrEqualTo" }, "EvaluationType": "PeriodBased", "Goal": { "Interval": { "RollingInterval": { "DurationUnit": "DAY", "Duration": 7 } }, "AttainmentGoal": 90.0, "WarningThreshold": 50.0 } } }
有关更多信息,请参阅 Amazon CloudWatch 用户指南中的应用程序信号。
-
有关 API 的详细信息,请参阅AWS CLI 命令参考UpdateServiceLevelObjective
中的。
-