Skip to content

misc: credentials business metrics #1164

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.

Sign up for GitHub

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

Merged
merged 18 commits into from
Nov 4, 2024
Merged

misc: credentials business metrics #1164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
f32de91
misc: reset attributes between provider chain attempts
0marperez Oct 14, 2024
980abe6
misc: add function to emit business metrics with attributes as receiver
0marperez Oct 14, 2024
169c96a
Bug fixes & refactoring of new business metrics utils
0marperez Oct 15, 2024
eb4999d
Remove simpleName runtime type
0marperez Oct 17, 2024
287e050
Downstream attributes utils
0marperez Oct 17, 2024
cb76cd5
Got rid of unnecessary code in identity provider chain for credential…
0marperez Oct 24, 2024
69a9e1b
Fix type bug throwing unnecessary exception
0marperez Oct 24, 2024
eb32e8f
Remove * import
0marperez Oct 28, 2024
6c022f0
Move credentials business metrics to credentials attributes
0marperez Oct 31, 2024
2c09d37
Remove TODO
0marperez Oct 31, 2024
69466cf
Undo commit from main
0marperez Oct 31, 2024
598b715
Clean and API dump
0marperez Oct 31, 2024
a7e2c7e
Remove breaking changes
0marperez Oct 31, 2024
b5a4a38
One liner for emitIdentityBusinessMetrics
0marperez Oct 31, 2024
1cc05b1
Ktlint
0marperez Nov 1, 2024
d92f45b
Set<String> -> Set<BusinessMetric> business metrics
0marperez Nov 1, 2024
266cf9f
Self review
0marperez Nov 1, 2024
b7e1165
Fix attribute key
0marperez Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .../http-client/common/src/aws/smithy/kotlin/runtime/http/operation/SdkOperationExecution.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package aws.smithy.kotlin.runtime.http.operation

import aws.smithy.kotlin.runtime.InternalApi
import aws.smithy.kotlin.runtime.businessmetrics.BusinessMetrics
import aws.smithy.kotlin.runtime.businessmetrics.SmithyBusinessMetric
import aws.smithy.kotlin.runtime.businessmetrics.emitBusinessMetric
import aws.smithy.kotlin.runtime.client.LogMode
Expand All @@ -23,9 +24,11 @@ import aws.smithy.kotlin.runtime.http.request.dumpRequest
import aws.smithy.kotlin.runtime.http.request.immutableView
import aws.smithy.kotlin.runtime.http.request.toBuilder
import aws.smithy.kotlin.runtime.http.response.dumpResponse
import aws.smithy.kotlin.runtime.identity.Identity
import aws.smithy.kotlin.runtime.io.Handler
import aws.smithy.kotlin.runtime.io.middleware.Middleware
import aws.smithy.kotlin.runtime.io.middleware.Phase
import aws.smithy.kotlin.runtime.operation.ExecutionContext
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.StandardRetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
Expand Down Expand Up @@ -285,6 +288,9 @@ internal class AuthHandler<Input, Output>(
identityProvider.resolve(request.context)
}

// emit identity business metrics
emitIdentityBusinessMetrics(identity, request.context)

val resolveEndpointReq = ResolveEndpointRequest(request.context, request.subject.immutableView(), identity)

if (endpointResolver != null) {
Expand Down Expand Up @@ -408,3 +414,9 @@ private class InterceptorTransmitMiddleware<I, O>(
return call
}
}

/**
* Emits an [Identity]'s attributes' [BusinessMetrics] into the [ExecutionContext]
*/
private fun emitIdentityBusinessMetrics(identity: Identity, context: ExecutionContext) =
identity.attributes.getOrNull(BusinessMetrics)?.toList()?.reversed()?.forEach(context::emitBusinessMetric)
Copy link
Contributor

@lauzadis lauzadis Nov 4, 2024

Choose a reason for hiding this comment

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

Why .reversed(), does order matter?

Copy link
Contributor Author

@0marperez 0marperez Nov 4, 2024

Choose a reason for hiding this comment

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

Yes, according to the design doc.

The feature IDs MUST be included in the business metrics in the same order they are used.

1 change: 1 addition & 0 deletions runtime/runtime-core/api/runtime-core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ public abstract interface class aws/smithy/kotlin/runtime/businessmetrics/Busine

public final class aws/smithy/kotlin/runtime/businessmetrics/BusinessMetricsUtilsKt {
public static final fun containsBusinessMetric (Laws/smithy/kotlin/runtime/operation/ExecutionContext;Laws/smithy/kotlin/runtime/businessmetrics/BusinessMetric;)Z
public static final fun emitBusinessMetric (Laws/smithy/kotlin/runtime/collections/MutableAttributes;Laws/smithy/kotlin/runtime/businessmetrics/BusinessMetric;)V
public static final fun emitBusinessMetric (Laws/smithy/kotlin/runtime/operation/ExecutionContext;Laws/smithy/kotlin/runtime/businessmetrics/BusinessMetric;)V
public static final fun getAccountIdBasedEndpointAccountId ()Laws/smithy/kotlin/runtime/collections/AttributeKey;
public static final fun getBusinessMetrics ()Laws/smithy/kotlin/runtime/collections/AttributeKey;
Expand Down
23 changes: 18 additions & 5 deletions ...runtime-core/common/src/aws/smithy/kotlin/runtime/businessmetrics/BusinessMetricsUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ package aws.smithy.kotlin.runtime.businessmetrics

import aws.smithy.kotlin.runtime.InternalApi
import aws.smithy.kotlin.runtime.collections.AttributeKey
import aws.smithy.kotlin.runtime.collections.MutableAttributes
import aws.smithy.kotlin.runtime.collections.get
import aws.smithy.kotlin.runtime.operation.ExecutionContext

/**
* Keeps track of all business metrics along an operations execution
*/
@InternalApi
public val BusinessMetrics: AttributeKey<MutableSet<String>> = AttributeKey("aws.sdk.kotlin#BusinessMetrics")
public val BusinessMetrics: AttributeKey<MutableSet<BusinessMetric>> = AttributeKey("aws.smithy.kotlin#BusinessMetrics")

/**
* The account ID in an account ID based endpoint
Expand All @@ -33,9 +34,21 @@ public val ServiceEndpointOverride: AttributeKey<Boolean> = AttributeKey("aws.sm
@InternalApi
public fun ExecutionContext.emitBusinessMetric(metric: BusinessMetric) {
if (this.attributes.contains(BusinessMetrics)) {
this.attributes[BusinessMetrics].add(metric.identifier)
this.attributes[BusinessMetrics].add(metric)
} else {
this.attributes[BusinessMetrics] = mutableSetOf(metric.identifier)
this.attributes[BusinessMetrics] = mutableSetOf(metric)
}
}

/**
* Emit a business metric to the mutable attributes
*/
@InternalApi
public fun MutableAttributes.emitBusinessMetric(metric: BusinessMetric) {
if (this.contains(BusinessMetrics)) {
this[BusinessMetrics].add(metric)
} else {
this[BusinessMetrics] = mutableSetOf(metric)
}
}

Expand All @@ -45,7 +58,7 @@ public fun ExecutionContext.emitBusinessMetric(metric: BusinessMetric) {
@InternalApi
public fun ExecutionContext.removeBusinessMetric(metric: BusinessMetric) {
if (this.attributes.contains(BusinessMetrics)) {
this.attributes[BusinessMetrics].remove(metric.identifier)
this.attributes[BusinessMetrics].remove(metric)
}
}

Expand All @@ -54,7 +67,7 @@ public fun ExecutionContext.removeBusinessMetric(metric: BusinessMetric) {
*/
@InternalApi
public fun ExecutionContext.containsBusinessMetric(metric: BusinessMetric): Boolean =
(this.attributes.contains(BusinessMetrics)) && this.attributes[BusinessMetrics].contains(metric.identifier)
(this.attributes.contains(BusinessMetrics)) && this.attributes[BusinessMetrics].contains(metric)

/**
* Valid business metrics
Expand Down
10 changes: 5 additions & 5 deletions ...me-core/common/test/aws/smithy/kotlin/runtime/businessmetrics/BusinessMetricsUtilsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class BusinessMetricsUtilsTest {
executionContext.emitBusinessMetric(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION)

assertTrue(executionContext.attributes.contains(BusinessMetrics))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION.identifier))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION))
}

@Test
Expand All @@ -27,8 +27,8 @@ class BusinessMetricsUtilsTest {
executionContext.emitBusinessMetric(SmithyBusinessMetric.SIGV4A_SIGNING)

assertTrue(executionContext.attributes.contains(BusinessMetrics))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION.identifier))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.SIGV4A_SIGNING.identifier))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.SIGV4A_SIGNING))
}

@Test
Expand All @@ -37,12 +37,12 @@ class BusinessMetricsUtilsTest {
executionContext.emitBusinessMetric(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION)

assertTrue(executionContext.attributes.contains(BusinessMetrics))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION.identifier))
assertTrue(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION))

executionContext.removeBusinessMetric(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION)

assertTrue(executionContext.attributes.contains(BusinessMetrics))
assertFalse(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION.identifier))
assertFalse(executionContext.attributes[BusinessMetrics].contains(SmithyBusinessMetric.GZIP_REQUEST_COMPRESSION))
}

@Test
Expand Down
Loading