aws-cloudformation / aws-cloudformation/cloudformation-cli

Docs about Cloudwatch log group in "Monitoring Runtime Logging" incorrect.

Open
#658 1 comment 2 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Python
Stars
336
Forks
172
Avg merge
3d 5m
Merged PRs (30d)
3

Description

In `resource-type-develop.md`, the section [Monitoring Runtime Logging for Resource Types](https://github.com/aws-cloudformation/cloudformation-cli/blob/master/doc_source/resource-type-develop.md#monitoring-runtime-logging-for-resource-types) contains incorrect information:

1. The group is not created by Cloudformation during `cfn submit`
1. The naming scheme for the log group is incorrect

I think the corrected text would state that (a) the group is created by the Cloudformation runtime when the resource is first run, and (b) the naming scheme is `my-resource-type-logs`, where `my-resource-type` is the three-part resource type name.

Also, it could be noted that each plugin has varying requirements for logging to be emitted. For example, the Go plugin requires a build argument to enable it (see https://github.com/aws-cloudformation/cloudformation-cli-go-plugin/issues/187).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.