设置应用程序日志记录 - Amazon Kinesis Data Analytics
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

设置应用程序日志记录

通过为适用于 Java 的 Amazon Kinesis Data Analytics 应用程序添加 Amazon CloudWatch 日志记录选项,您可以监控应用程序事件或配置问题。

本主题介绍了如何配置应用程序,以将应用程序事件写入到 CloudWatch Logs 流中。CloudWatch 日志记录选项是一个应用程序设置和权限集合,应用程序使用这些设置和权限配置它将应用程序事件写入到 CloudWatch Logs 的方式。您可以使用 AWS 管理控制台 或 AWS Command Line Interface (AWS CLI) 添加和配置 CloudWatch 日志记录选项。

请注意有关在应用程序中添加 CloudWatch 日志记录选项的以下内容:

  • 在使用控制台添加 CloudWatch 日志记录选项时,Kinesis Data Analytics 将为您创建 CloudWatch 日志组和日志流,并添加应用程序写入到日志流所需的权限。

  • 在使用 API 添加 CloudWatch 日志记录选项时,您还必须创建应用程序的日志组和日志流,并添加应用程序写入到日志流所需的权限。

使用控制台设置 CloudWatch 日志记录

在控制台中为应用程序启用 CloudWatch 日志记录时,将为您创建一个 CloudWatch 日志组和日志流。此外,还会使用写入到流的权限更新应用程序的权限策略。

以下屏幕截图显示了 Configure application (配置应用程序) 页面中的 CloudWatch logging (CloudWatch 日志记录) 设置。

 


                控制台屏幕截图,显示创建应用程序页面上的设置。

Kinesis Data Analytics 创建一个使用以下约定命名的日志组,其中 ApplicationName 是应用程序的名称。

/aws/kinesis-analytics/ApplicationName

Kinesis Data Analytics 使用以下名称在新日志组中创建一个日志流。

kinesis-analytics-log-stream

您可以使用 Configure application (配置应用程序) 页面的 Monitoring log level (监控日志级别) 部分设置应用程序监控指标级别和监控日志级别。有关应用程序日志级别的信息,请参阅应用程序监控级别

使用 CLI 设置 CloudWatch 日志记录

要使用 AWS CLI 添加 CloudWatch 日志记录选项,请执行以下操作:

  • 创建一个 CloudWatch 日志组和日志流。

  • 使用 CreateApplication 操作在创建应用程序时添加日志记录选项,或使用 AddApplicationCloudWatchLoggingOption 操作在现有应用程序中添加日志记录选项。

  • 在应用程序的策略中添加权限以写入到日志。

创建 CloudWatch 日志组和日志流

您可以使用 CloudWatch Logs 控制台或 API 创建 CloudWatch 日志组和流。有关创建 CloudWatch 日志组和日志流的信息,请参阅使用日志组和日志流

使用应用程序 CloudWatch 日志记录选项

可以使用以下 API 操作将 CloudWatch 日志选项添加到新的或现有的应用程序中,或者更改现有应用程序的日志选项。有关如何将 JSON 文件用于 API 操作输入的信息,请参阅 Kinesis Data Analytics API 示例代码

在创建应用程序时添加 CloudWatch 日志选项

以下示例说明了在创建应用程序时如何使用 CreateApplication 操作添加 CloudWatch 日志选项。在该示例中,将 Amazon Resource Name (ARN) of the CloudWatch Log stream to add to the new application 替换为您自己的信息。有关该操作的更多信息,请参阅 CreateApplication

{ "ApplicationName": "test", "ApplicationDescription": "test-application-description", "RuntimeEnvironment": "FLINK-1_8", "ServiceExecutionRole": "arn:aws:iam::123456789123:role/myrole", "ApplicationConfiguration": { "ApplicationCodeConfiguration": { "CodeContent": { "S3ContentLocation":{ "BucketARN": "arn:aws:s3:::mybucket", "FileKey": "myflink.jar" } }, "CodeContentType": "ZIPFILE" } }, "CloudWatchLoggingOptions": [{ "LogStreamARN": "<Amazon Resource Name (ARN) of the CloudWatch log stream to add to the new application>" }] }

向现有应用程序添加 CloudWatch 日志选项

以下示例说明了如何使用 AddApplicationCloudWatchLoggingOption 操作在现有应用程序中添加 CloudWatch 日志选项。在该示例中,将每个用户输入占位符替换为您自己的信息。有关该操作的更多信息,请参阅 AddApplicationCloudWatchLoggingOption

{ "ApplicationName": "<Name of the application to add the log option to>", "CloudWatchLoggingOption": { "LogStreamARN": "<ARN of the log stream to add to the application>" }, "CurrentApplicationVersionId": <Version of the application to add the log to> }

更新现有 CloudWatch 日志选项

以下示例说明了如何使用 UpdateApplication 操作修改现有的 CloudWatch 日志选项。在该示例中,将每个用户输入占位符替换为您自己的信息。有关该操作的更多信息,请参阅 UpdateApplication

{ "ApplicationName": "<Name of the application to update the log option for>", "CloudWatchLoggingOptionUpdates": [ { "CloudWatchLoggingOptionId": "<ID of the logging option to modify>", "LogStreamARNUpdate": "<ARN of the new log stream to use>" } ], "CurrentApplicationVersionId": <ID of the application version to modify> }

从应用程序中删除 CloudWatch 日志选项

以下示例说明了如何使用 DeleteApplicationCloudWatchLoggingOption 操作删除现有的 CloudWatch 日志选项。在该示例中,将每个用户输入占位符替换为您自己的信息。有关该操作的更多信息,请参阅 DeleteApplicationCloudWatchLoggingOption

{ "ApplicationName": "<Name of application to delete log option from>", "CloudWatchLoggingOptionId": "<ID of the application log option to delete>", "CurrentApplicationVersionId": <Version of the application to delete the log option from> }

设置应用程序日志记录级别

要设置应用程序日志记录级别,请使用 CreateApplication 操作的 MonitoringConfiguration 参数或 UpdateApplication 操作的 MonitoringConfigurationUpdate 参数。

有关应用程序日志级别的信息,请参阅应用程序监控级别

在创建应用程序时设置应用程序日志记录级别

CreateApplication 操作的以下示例请求将应用程序日志级别设置为 INFO

{ "ApplicationName": "MyApplication", "ApplicationDescription": "My Application Description", "ApplicationConfiguration": { "ApplicationCodeConfiguration":{ "CodeContent":{ "S3ContentLocation":{ "BucketARN":"arn:aws:s3:::mybucket", "FileKey":"myflink.jar", "ObjectVersion":"AbCdEfGhIjKlMnOpQrStUvWxYz12345" } }, "CodeContentType":"ZIPFILE" }, "FlinkApplicationConfiguration": "MonitoringConfiguration": { "ConfigurationType": "CUSTOM", "LogLevel": "INFO" } }, "RuntimeEnvironment": "FLINK-1_8", "ServiceExecutionRole": "arn:aws:iam::123456789123:role/myrole" }
更新应用程序日志记录级别

UpdateApplication 操作的以下示例请求将应用程序日志级别设置为 INFO

{ "ApplicationConfigurationUpdate": { "FlinkApplicationConfigurationUpdate": { "MonitoringConfigurationUpdate": { "ConfigurationTypeUpdate": "CUSTOM", "LogLevelUpdate": "INFO" } } } }

添加权限以写入到 CloudWatch 日志流

Kinesis Data Analytics 需要具有相应的权限以将配置错误写入到 CloudWatch 中。您可以将这些权限添加到 Kinesis Data Analytics 担任的 AWS Identity and Access Management (IAM) 角色中。

有关将 IAM 角色用于 Kinesis Data Analytics 的更多信息,请参阅Amazon Kinesis Data Analytics for Java Applications 中的 Identity and Access Management

信任策略

要为 Kinesis Data Analytics 授予担任 IAM 角色的权限,您可以将以下信任策略附加到服务执行角色。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "kinesisanalytics.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }

权限策略

要为应用程序授予权限以将日志事件从 CloudWatch 写入到 Kinesis Data Analytics 资源,您可以使用以下 IAM 权限策略。为日志组和流提供正确的 Amazon 资源名称 (ARN)。

{ "Version": "2012-10-17", "Statement": [ { "Sid": "Stmt0123456789000", "Effect": "Allow", "Action": [ "logs:PutLogEvents", "logs:DescribeLogGroups", "logs:DescribeLogStreams" ], "Resource": [ "arn:aws:logs:us-east-1:123456789012:log-group:my-log-group:log-stream:my-log-stream*", "arn:aws:logs:us-east-1:123456789012:log-group:my-log-group:*", "arn:aws:logs:us-east-1:123456789012:log-group:*", ] } ] }

应用程序监控级别

您可以使用应用程序的监控指标级别监控日志级别,以控制生成应用程序日志消息的过程。

应用程序的监控指标级别控制日志消息的粒度。监控指标级别定义如下:

应用程序的监控日志级别控制应用程序日志的详细程度。监控日志级别定义如下:

  • 错误:应用程序的潜在灾难性事件。

  • 警告:应用程序的可能有害情况。

  • 信息:应用程序的信息性和暂时性故障事件。我们建议您使用该日志记录级别。

  • 调试:对调试应用程序非常有用的精细信息性事件。注意:仅将该级别用于临时调试目的。

日志记录最佳实践

我们建议您的应用程序使用信息日志记录级别。我们建议您使用该级别,以确保您看到 Apache Flink 错误,这些错误是在信息级别而不是错误级别记录的。

我们建议您仅在调查应用程序问题时临时使用调试级别。在解决问题后,请切换回信息级别。使用调试日志记录级别将严重影响应用程序的性能。

过多的日志记录也可能会严重影响应用程序性能。例如,我们建议您不要为每个处理的记录写入一个日志条目。过多的日志记录可能会导致严重的数据处理瓶颈,并且可能会导致从源中读取数据时出现反向压力。

日志记录故障排除

如果没有将应用程序日志写入到日志流,请验证以下内容:

  • 验证应用程序的 IAM 角色和策略是否正确。应用程序的策略需要具有以下权限以访问日志流:

    • logs:PutLogEvents

    • logs:DescribeLogGroups

    • logs:DescribeLogStreams

    有关更多信息,请参阅 添加权限以写入到 CloudWatch 日志流

  • 验证应用程序是否正在运行。要检查应用程序的状态,请在控制台中查看应用程序的页面,或者使用 DescribeApplicationListApplications 操作。

  • 监控 CloudWatch 指标(例如 downtime)以诊断其他应用程序问题。有关读取 CloudWatch 指标的信息,请参阅指标与维度

下一步

在应用程序中启用 CloudWatch 日志记录后,您可以使用 CloudWatch Logs Insights 分析应用程序日志。有关更多信息,请参阅使用 CloudWatch Logs Insights 分析日志