Skip to content

Documentation: examples/outputs need updating #1049

Closed
@dreamorosi

Description

@dreamorosi

Description of the improvement

Summary of the proposal
With the newer features being released some of the CloudWatch excerpts for Logger in the docs have fallen out of sync either in terms of content/keys or lines highlighted.

How, where did you look for information
Logger documentation.

Missing or unclear documentation

Some of the examples in the Logger docs are out of sync with the library.

Improvement
Appending persistent additional log keys and values
example logs: add "aws_account_id" to highlighted text as this is also set in persistentLogAttributes
Appending additional data to a single log item
example log 2: update message
example log 3 highlight "extra" property instead of "xray_trace_id"
Logging errors
set log message as value passed to logger.error() and set error object message to Error message

Related existing documentation

See point above.

Related issues, RFCs

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    completedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationloggerThis item relates to the Logger Utility

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions