Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 11 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion packages/metrics/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@
"url": "https://github.com/aws-powertools/powertools-lambda-typescript/issues"
},
"dependencies": {
"@aws-lambda-powertools/commons": "2.27.0"
"@aws-lambda-powertools/commons": "2.27.0",
"@aws/lambda-invoke-store": "0.1.0"
},
"keywords": [
"aws",
Expand Down
104 changes: 104 additions & 0 deletions packages/metrics/src/DimensionsStore.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
import { InvokeStore } from '@aws/lambda-invoke-store';
import type { Dimensions } from './types/Metrics.js';

/**
* Manages storage of metrics dimensions with automatic context detection.
*
* This class abstracts the storage mechanism for metrics, automatically
* choosing between AsyncLocalStorage (when in async context) and a fallback
* object (when outside async context). The decision is made at runtime on
* every method call to support Lambda's transition to async contexts.
*/
class DimensionsStore {
readonly #dimensionsKey = Symbol('powertools.metrics.dimensions');
readonly #dimensionSetsKey = Symbol('powertools.metrics.dimensionSets');

#fallbackDimensions: Dimensions = {};
#fallbackDimensionSets: Dimensions[] = [];
#defaultDimensions: Dimensions = {};

#getDimensions(): Dimensions {
if (InvokeStore.getContext() === undefined) {
return this.#fallbackDimensions;
}

let stored = InvokeStore.get(this.#dimensionsKey) as Dimensions | undefined;
if (stored == null) {
stored = {};
InvokeStore.set(this.#dimensionsKey, stored);
}
return stored;
}

#getDimensionSets(): Dimensions[] {
if (InvokeStore.getContext() === undefined) {
return this.#fallbackDimensionSets;
}

let stored = InvokeStore.get(this.#dimensionSetsKey) as
| Dimensions[]
| undefined;
if (stored == null) {
stored = [];
InvokeStore.set(this.#dimensionSetsKey, stored);
}
return stored;
}

public addDimension(name: string, value: string): string {
this.#getDimensions()[name] = value;
return value;
}

public addDimensionSet(dimensionSet: Dimensions): Dimensions {
this.#getDimensionSets().push({ ...dimensionSet });
return dimensionSet;
}

public getDimensions(): Dimensions {
return { ...this.#getDimensions() };
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we spreading and creating a new object here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because I don't want it to be possible to get a reference to the underlying object and be able to mutate it without going through the store interface.

}

public getDimensionSets(): Dimensions[] {
return this.#getDimensionSets().map((set) => ({ ...set }));
}

public clearRequestDimensions(): void {
if (InvokeStore.getContext() === undefined) {
this.#fallbackDimensions = {};
this.#fallbackDimensionSets = [];
return;
}

InvokeStore.set(this.#dimensionsKey, {});
InvokeStore.set(this.#dimensionSetsKey, []);
}

public clearDefaultDimensions(): void {
this.#defaultDimensions = {};
}

public getDimensionCount(): number {
const dimensions = this.#getDimensions();
const dimensionSets = this.#getDimensionSets();
const dimensionSetsCount = dimensionSets.reduce(
(total, dimensionSet) => total + Object.keys(dimensionSet).length,
0
);
return (
Object.keys(dimensions).length +
Object.keys(this.#defaultDimensions).length +
dimensionSetsCount
);
}

public setDefaultDimensions(dimensions: Dimensions): void {
this.#defaultDimensions = { ...dimensions };
}

public getDefaultDimensions(): Dimensions {
return { ...this.#defaultDimensions };
}
}

export { DimensionsStore };
50 changes: 50 additions & 0 deletions packages/metrics/src/MetadataStore.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import { InvokeStore } from '@aws/lambda-invoke-store';

/**
* Manages storage of metrics #metadata with automatic context detection.
*
* This class abstracts the storage mechanism for metrics, automatically
* choosing between AsyncLocalStorage (when in async context) and a fallback
* object (when outside async context). The decision is made at runtime on
* every method call to support Lambda's transition to async contexts.
*/
class MetadataStore {
readonly #metadataKey = Symbol('powertools.metrics.metadata');

#fallbackStorage: Record<string, string> = {};

#getStorage(): Record<string, string> {
if (InvokeStore.getContext() === undefined) {
return this.#fallbackStorage;
}

let stored = InvokeStore.get(this.#metadataKey) as
| Record<string, string>
| undefined;
if (stored == null) {
stored = {};
InvokeStore.set(this.#metadataKey, stored);
}
return stored;
}

public set(key: string, value: string): string {
this.#getStorage()[key] = value;
return value;
}

public getAll(): Record<string, string> {
return { ...this.#getStorage() };
}

public clear(): void {
if (InvokeStore.getContext() === undefined) {
this.#fallbackStorage = {};
return;
}

InvokeStore.set(this.#metadataKey, {});
}
}

export { MetadataStore };
Loading