在 AWS SDK for Ruby 中设置 SDK Metrics。 - 适用于 Ruby 的 AWS 开发工具包
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

在 AWS SDK for Ruby 中设置 SDK Metrics。

以下步骤演示如何为AWS SDK for Ruby设置SDK Metrics。这些步骤适用于为正在使用AWS SDK for Ruby的客户端应用程序运行 Amazon Linux 的 Amazon EC2 实例。如果在配置AWS SDK for Ruby时启用,SDK Metrics也可用于您的生产环境。

要使用SDK Metrics,请运行最新版本的 CloudWatch 代理。

有关用于 SDK Metrics 的 IAM 权限的详细信息,请参阅授权开发工具包指标以收集和发送适用于 Ruby 的 AWS 开发工具包中的指标

要使用 AWS SDK for Ruby 设置 SDK Metrics,请执行以下操作:

  1. 使用AWS SDK for Ruby客户端创建应用程序以使用 AWS 服务。

  2. 在 Amazon EC2 实例上或您的本地环境中托管您的项目。

  3. 安装并使用最新版本的AWS SDK for Ruby。

  4. 在 Amazon EC2 实例上或您的本地环境中安装和配置 CloudWatch 代理。

  5. 授权 SDK Metrics 收集和发送指标。

  6. 为适用于 Ruby 的 AWS 开发工具包启用开发工具包指标

有关更多信息,请参阅:

为 AWS SDK for Ruby 启用 SDK Metrics

默认情况下,SDK Metrics 处于关闭状态,并且端口设置为 31000。下面是默认参数。

//default values [ 'enabled' => false, 'port' => 31000, ]

启用 SDK Metrics 与配置凭证以使用 AWS 服务无关。

您可以通过设置环境变量或使用 AWS 共享配置文件来启用 SDK Metrics。

选项 1:设置环境变量

开发工具包首先会检查 AWS_PROFILE 下的环境变量中指定的配置文件,以确定是否已启用SDK Metrics。

要打开SDK Metrics,请将以下内容添加到环境变量中。

export AWS_CSM_ENABLED=true

有其他配置设置可用。有关详细信息,请参阅 update_cw_agent。有关使用共享文件的更多信息,请参阅 configuration-sdk 中的环境变量信息。

注意

启用SDK Metrics不会将您的凭证配置为使用 AWS 服务。要执行该操作,请指定 -credentials。

选项 2:AWS 共享配置文件

如果在环境变量中未找到任何 SDK Metrics 配置,则 AWS SDK for Ruby 会查看您的自定义 AWS 配置文件字段。然后,它会检查 aws_csm 配置文件。要启用 SDK Metrics,请将 csm_enabled 添加到共享配置文件 ~/.aws/config

[default] csm_enabled = true [profile aws_csm] csm_enabled = true

有其他配置设置可用。有关详细信息,请参阅 update_cw_agent。有关使用共享文件的更多信息,请参阅 configuration-sdk 中的环境变量信息。

注意

启用SDK Metrics不会将您的凭证配置为使用 AWS 服务。要执行该操作,请指定 -credentials。

更新 CloudWatch 代理

要更改端口 ID,请设置值,然后重新启动当前处于活动状态的所有 AWS 作业。

选项 1:设置环境变量

大多数 AWS 服务都使用默认端口。但是,如果您希望 SDK Metrics 监控的服务使用唯一端口,请将 AWS_CSM_PORT=[PORT-NUMBER] 添加到主机的环境变量,其中 PORT-NUMBER 为端口号。

export AWS_CSM_ENABLED=true export AWS_CSM_PORT=1234

选项 2:AWS 共享配置文件

大多数服务都使用默认端口。但是,如果您的服务需要唯一的端口 ID,请将 AWS_CSM_PORT=[PORT-NUMBER](其中 PORT-NUMBER 为端口号)添加到 ~/.aws/config

[default] csm_enabled = false csm_port = 1234 [profile aws_csm] csm_enabled = false csm_port = 1234

重新启动 SDK Metrics

要重新启动作业,请运行以下命令。

amazon-cloudwatch-agent-ctl -a stop; amazon-cloudwatch-agent-ctl -a start;

禁用 SDK Metrics

要关闭 SDK Metrics,请在环境变量或 AWS 共享配置文件 csm_enabled~/.aws/config 中将 设置为 false。然后重新启动您的 CloudWatch 代理,以使更改生效。

csm_enabled 设置为 false

选项 1:环境变量

export AWS_CSM_ENABLED=false

选项 2:AWS 共享配置文件

注意

环境变量会覆盖 AWS 共享配置文件。如果已在环境变量中启用 SDK Metrics,则 SDK Metrics 保持启用状态。

[default] csm_enabled = false [profile aws_csm] csm_enabled = false

停止 SDK Metrics,然后重新启动 CloudWatch 代理

要禁用SDK Metrics,请使用以下命令。

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a stop && echo "Done"

如果您正在使用其他 CloudWatch 功能,请使用以下命令重新启动 CloudWatch。

amazon-cloudwatch-agent-ctl -a start;