Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Instrumentation documentation #1772

Merged
merged 14 commits into from
Sep 28, 2022
Merged

Add Instrumentation documentation #1772

merged 14 commits into from
Sep 28, 2022

Conversation

hlbarber
Copy link
Contributor

@hlbarber hlbarber commented Sep 27, 2022

Motivation and Context

Instrumentation is vital for system diagnostics. Some machinery to pursue this goal has already been added as part of #1591. Documentation is required to make it available to our customers.

Description

Rendered

  • Add documentation covering instrumentation approaches for Smithy Rust.
  • Tweak the logging in the Pokemon service to better exemplify instrumentation.
    • Remove TraceLayer which violates sensitivity contract.
    • Switch to Pretty logs to better showcase the outputs.
  • Update Logging in the Presence of Sensitive Data checklist.
  • Rename logging module to instrumentation to improve coherence across struct names and documentation.

@hlbarber hlbarber requested review from a team as code owners September 27, 2022 09:29
@hlbarber hlbarber added documentation Improvements or additions to documentation server Rust server SDK needs-sdk-review needs-server-review labels Sep 27, 2022
@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@smithy-lang smithy-lang deleted a comment from github-actions bot Sep 27, 2022
@82marbag 82marbag self-assigned this Sep 27, 2022
@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

A new doc preview is ready to view.

@hlbarber hlbarber merged commit dcfb855 into main Sep 28, 2022
@hlbarber hlbarber deleted the harryb/logging-docs branch September 28, 2022 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation server Rust server SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants