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

feat: Add Observability Runtime Interfaces #674

Merged
merged 9 commits into from
Mar 22, 2024

Conversation

syall
Copy link
Contributor

@syall syall commented Feb 29, 2024

Issue #

awslabs/aws-sdk-swift#696

Description of changes

Standardizes the Observability client runtime configuration and interfaces:

  • Context
  • Logging
  • Metrics
  • Tracing

Also, adds the default implementation of TelemetryProvider.

This PR is only additive besides the moved Logging source files.

Testing

$ swift --version
swift-driver version: 1.87.3 Apple Swift version 5.9.2 (swiftlang-5.9.2.2.56 clang-1500.1.0.2.5)
Target: arm64-apple-macosx14.0

$ swift build && swiftlint --fix && swiftlint
# Succeeds!

Scope

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@syall syall force-pushed the feat/sra-tracing branch 4 times, most recently from b471f15 to 15a9a77 Compare March 4, 2024 22:29
@syall syall force-pushed the feat/sra-tracing branch 2 times, most recently from da3bb45 to ce022cb Compare March 14, 2024 23:03
@syall syall changed the title feat: SRA Observability feat(observability): SRA Telemetry Runtime Interfaces Mar 14, 2024
@syall syall changed the title feat(observability): SRA Telemetry Runtime Interfaces feat(observability): Telemetry Runtime Interfaces Mar 14, 2024
@syall syall changed the title feat(observability): Telemetry Runtime Interfaces feat: Add Observability Runtime Interfaces Mar 14, 2024
@syall syall marked this pull request as ready for review March 14, 2024 23:09
Copy link
Contributor

@sichanyoo sichanyoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additions look great, but given that these protocols are going to be semi-permanent & end-users are expected to implement them for customizations, I think the public protocols and methods in them need documentation comments. E.g.,

/// Brief overview on method usage.
///
/// - Parameter: input : Comment
/// - Returns: ReturnABC : Comment
func fillerFunc(input: ParamABC) -> ReturnABC

@syall syall force-pushed the feat/sra-tracing branch 5 times, most recently from f2ac676 to 57ba71c Compare March 18, 2024 21:38
Copy link
Contributor

@sichanyoo sichanyoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly questions and some small suggestions.

Copy link
Contributor

@jbelkins jbelkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only a few superficial changes to make. I will put these in & merge.

@jbelkins jbelkins self-requested a review March 22, 2024 17:31
Copy link
Contributor

@jbelkins jbelkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I entered some cleanup changes myself. This change is now good to merge, per conversation with @syall.

@jbelkins jbelkins merged commit 13a8821 into smithy-lang:main Mar 22, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants