@aws-blocks/bb-metrics 0.1.0

package/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

package/README.md

@@ -0,0 +1,186 @@
+# Metrics
+
+Custom application metrics backed by Amazon CloudWatch (via Embedded Metric Format).
+
+**When to use:** You need to track numeric measurements over time — request counts, error rates, latency, queue depths, business KPIs. Good for dashboards, alarms, and operational visibility.
+
+**When NOT to use:** If you need structured log output, use `Logging`. If you need distributed request tracing, use `Tracing`. If you need to store time-series data for querying, use `Database` or `DistributedTable`.
+
+## API
+
+```typescript
+const metrics = new Metrics(scope, id, options?)
+```
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `emit(name, value, options?)` | `void` | Record a single metric data point via EMF. |
+| `emitBatch(metrics)` | `void` | Record multiple metric data points in one EMF document (max 100). |
+| `flush()` | `void` | No-op (EMF writes are immediate). Provided for interface compatibility. |
+| `child(dimensions)` | `MetricsEmitter` | Create a child emitter with inherited namespace and merged dimensions. |
+| `Metrics.fromExisting(namespace)` | `ExternalMetricsRef` | Wrap a pre-existing CloudWatch namespace. |
+
+### Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `namespace` | `string` | CloudWatch namespace. Defaults to `scope.fullId`. |
+| `defaultDimensions` | `Record<string, string>` | Dimensions applied to every emit. Per-emit dimensions merge on top (per-emit wins on conflict). |
+| `metrics` | `ExternalMetricsRef` | Wrap an existing CloudWatch namespace instead of creating one. When set, `namespace` is ignored. |
+| `logger` | `ChildLogger` | Optional logger for internal operations. When omitted, a default Logger at error level is created. |
+
+### EmitOptions
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `unit` | `MetricUnit` | Unit of the metric value. Defaults to `'None'`. |
+| `dimensions` | `Record<string, string>` | Dimensions for this data point (max 30 total including defaults). |
+| `timestamp` | `Date` | Timestamp for the data point. Defaults to now. |
+| `resolution` | `MetricResolution` | `'standard'` (60s, default) or `'high'` (1s, higher cost). |
+
+### MetricUnit
+
+```typescript
+type MetricUnit =
+  | 'Count' | 'Seconds' | 'Milliseconds' | 'Microseconds'
+  | 'Bytes' | 'Kilobytes' | 'Megabytes' | 'Gigabytes'
+  | 'Percent' | 'Bits/Second' | 'None';
+```
+
+### Error Handling
+
+```typescript
+import { isBlocksError } from '@aws-blocks/core';
+import { MetricsErrors } from '@aws-blocks/bb-metrics';
+
+try {
+  metrics.emit('', 1);
+} catch (e: unknown) {
+  if (isBlocksError(e, MetricsErrors.InvalidMetricName)) {
+    // metric name is empty or exceeds 1024 characters
+  }
+}
+```
+
+| Error | Condition |
+|-------|-----------|
+| `MetricsErrors.InvalidMetricName` | Metric name is empty or exceeds 1024 characters. |
+| `MetricsErrors.InvalidDimensions` | Dimensions exceed 30 entries, or contain empty keys/values, or key/value exceeds 1024 chars. |
+| `MetricsErrors.BatchTooLarge` | Batch contains more than 100 metrics. |
+| `MetricsErrors.InvalidNamespace` | Namespace is empty, too long, contains invalid characters, or uses reserved `AWS/` prefix. |
+
+## Examples
+
+### Basic Usage
+
+```typescript
+import { Scope, ApiNamespace } from '@aws-blocks/blocks';
+import { Metrics } from '@aws-blocks/bb-metrics';
+
+const scope = new Scope('my-app');
+const metrics = new Metrics(scope, 'appMetrics', {
+  namespace: 'MyApp/Orders',
+  defaultDimensions: { service: 'orders' },
+});
+
+export const api = new ApiNamespace(scope, 'api', (context) => ({
+  async handleRequest() {
+    metrics.emit('RequestCount', 1, { unit: 'Count' });
+    metrics.emit('Latency', 42, { unit: 'Milliseconds' });
+    return { ok: true };
+  },
+}));
+```
+
+### Emit with Dimensions
+
+```typescript
+metrics.emit('RequestCount', 1, {
+  unit: 'Count',
+  dimensions: { endpoint: '/api/users', method: 'GET' },
+});
+```
+
+### Batch Emit
+
+```typescript
+metrics.emitBatch([
+  { name: 'RequestCount', value: 1, unit: 'Count' },
+  { name: 'Latency', value: 42, unit: 'Milliseconds' },
+  { name: 'ErrorCount', value: 0, unit: 'Count' },
+]);
+```
+
+### Child Emitters (Scoped Dimensions)
+
+```typescript
+const requestMetrics = metrics.child({ endpoint: '/api/users', method: 'GET' });
+requestMetrics.emit('RequestCount', 1);
+requestMetrics.emit('Latency', 35, { unit: 'Milliseconds' });
+```
+
+Children inherit the parent's namespace and default dimensions, merging their own on top. Children can be nested arbitrarily.
+
+### Wrapping an Existing Namespace
+
+```typescript
+const legacy = new Metrics(scope, 'legacy', {
+  metrics: Metrics.fromExisting('MyOrg/SharedMetrics'),
+});
+legacy.emit('MigrationCount', 1);
+```
+
+### High-Resolution Metrics
+
+```typescript
+metrics.emit('CPUSpike', 95.2, {
+  unit: 'Percent',
+  resolution: 'high', // 1-second aggregation
+});
+```
+
+## CDK Configuration
+
+The CDK construct creates no AWS resources. It only resolves and exposes the `namespace` and `defaultDimensions` as readonly properties for CDK-time consumers.
+
+EMF uses CloudWatch Logs (which Lambda already has permissions for), so no environment variable or `cloudwatch:PutMetricData` IAM grant is needed. CloudWatch namespaces are created implicitly on first metric data point arrival.
+
+## Synchronous API Rationale
+
+All metric methods return `void`, not `Promise<void>`. This is intentional:
+
+- **EMF writes to stdout** — `process.stdout.write()` is a synchronous, non-blocking call on Linux. The kernel buffers the write and Lambda's logging agent captures it asynchronously.
+- **No network I/O** — Unlike `PutMetricData` (which makes an HTTP call to CloudWatch), EMF piggybacks on CloudWatch Logs, which Lambda already streams. There is nothing to `await`.
+- **Zero overhead** — Returning a Promise would add microtask scheduling overhead for zero benefit. Metrics should be as cheap as a `console.log`.
+- **Fire-and-forget semantics** — Metrics are observability data, not business-critical writes. If a metric fails to emit (e.g., stdout is closed), it should not crash the request.
+
+This design means you can emit metrics anywhere — in hot loops, synchronous callbacks, or error handlers — without worrying about async context or unhandled promise rejections.
+
+## Best Practices
+
+- Keep dimension cardinality low (avoid user IDs or request IDs as dimensions)
+- Use consistent metric names across your application
+- Use `defaultDimensions` for shared context (service name, environment)
+- Prefer `emitBatch` when recording multiple metrics in a single request
+- Use units to enable automatic conversions in CloudWatch dashboards
+- Use `child()` to avoid repeating dimensions across related metrics
+
+## Scaling & Cost (AWS)
+
+- **Ingestion:** CloudWatch accepts unlimited metrics via EMF — no API call limits
+- **Standard resolution (60s):** Retained for 15 days at full resolution, then aggregated
+- **High resolution (1s):** Retained for 3 hours at full resolution, then aggregated
+- **Cost:** Scales with unique metric name + dimension combinations (~$0.30/metric/month)
+- **Latency:** EMF adds zero latency to the request (stdout write is non-blocking)
+
+## Local Development
+
+Metrics are written as EMF JSON to stdout — the same format as AWS. In local dev, you can see metric emissions in the terminal output. No disk persistence — metrics are ephemeral locally (unlike KVStore or DistributedTable which persist to `.bb-data/`).
+
+Delete nothing to reset — there's no local state to clear.
+
+
+
+## See Also
+
+- [DESIGN.md](./DESIGN.md) — Infrastructure details, EMF format, and design decisions

package/dist/errors.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Typed error constants for Metrics. Use with `isBlocksError()` in catch blocks.
+ *
+ * @example
+ * ```typescript
+ * import { isBlocksError } from '@aws-blocks/core';
+ * import { MetricsErrors } from '@aws-blocks/bb-metrics';
+ *
+ * try {
+ *   metrics.emit('', 1);
+ * } catch (e) {
+ *   if (isBlocksError(e, MetricsErrors.InvalidMetricName)) {
+ *     // handle invalid metric name
+ *   }
+ * }
+ * ```
+ */
+export declare const MetricsErrors: {
+    /** Metric name is empty or exceeds 1024 characters. */
+    readonly InvalidMetricName: "InvalidMetricNameException";
+    /** Dimensions exceed 30 entries, or contain empty keys/values, or key/value exceeds 1024 chars. */
+    readonly InvalidDimensions: "InvalidDimensionsException";
+    /** Batch contains more than 100 metrics. */
+    readonly BatchTooLarge: "BatchTooLargeException";
+    /** Namespace is empty, too long, contains invalid characters, or uses reserved AWS/ prefix. */
+    readonly InvalidNamespace: "InvalidNamespaceException";
+};
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;IACzB,uDAAuD;;IAEvD,mGAAmG;;IAEnG,4CAA4C;;IAE5C,+FAA+F;;CAEtF,CAAC"}

package/dist/errors.js

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Typed error constants for Metrics. Use with `isBlocksError()` in catch blocks.
+ *
+ * @example
+ * ```typescript
+ * import { isBlocksError } from '@aws-blocks/core';
+ * import { MetricsErrors } from '@aws-blocks/bb-metrics';
+ *
+ * try {
+ *   metrics.emit('', 1);
+ * } catch (e) {
+ *   if (isBlocksError(e, MetricsErrors.InvalidMetricName)) {
+ *     // handle invalid metric name
+ *   }
+ * }
+ * ```
+ */
+export const MetricsErrors = {
+    /** Metric name is empty or exceeds 1024 characters. */
+    InvalidMetricName: 'InvalidMetricNameException',
+    /** Dimensions exceed 30 entries, or contain empty keys/values, or key/value exceeds 1024 chars. */
+    InvalidDimensions: 'InvalidDimensionsException',
+    /** Batch contains more than 100 metrics. */
+    BatchTooLarge: 'BatchTooLargeException',
+    /** Namespace is empty, too long, contains invalid characters, or uses reserved AWS/ prefix. */
+    InvalidNamespace: 'InvalidNamespaceException',
+};

package/dist/index.aws.d.ts

@@ -0,0 +1,134 @@
+import { Scope } from '@aws-blocks/core';
+import type { ScopeParent } from '@aws-blocks/core';
+import type { MetricsOptions, EmitOptions, MetricDatum, ExternalMetricsRef, MetricsEmitter } from './types.js';
+import type { ChildLogger } from '@aws-blocks/bb-logger';
+export { MetricsErrors } from './errors.js';
+export type { MetricsOptions, EmitOptions, MetricDatum, MetricUnit, MetricResolution, ExternalMetricsRef, MetricsEmitter, } from './types.js';
+/**
+ * Custom application metrics backed by Amazon CloudWatch (via EMF).
+ *
+ * Metrics emitted from this Building Block appear in CloudWatch under the
+ * configured namespace. Use for dashboards, alarms, and operational visibility.
+ *
+ * Uses CloudWatch Embedded Metric Format (EMF) — writes metric data as
+ * structured JSON to stdout. Lambda captures these and CloudWatch extracts
+ * metrics automatically.
+ *
+ * **When to use:** You need to track numeric measurements over time — request
+ * counts, error rates, latency, queue depths, business KPIs.
+ *
+ * **When NOT to use:** If you need structured log output only, use `Logging`.
+ * If you need distributed request tracing, use `Tracing`. If you need to store
+ * time-series data for querying, use `Database` or `DistributedTable`.
+ *
+ * **Best practices:**
+ * - Keep dimension cardinality low (avoid user IDs or request IDs as dimensions)
+ * - Use consistent metric names across your application
+ * - Use `defaultDimensions` for shared context (service name, environment)
+ * - Prefer `emitBatch` when recording multiple metrics in a single request
+ * - Use units to enable automatic conversions in CloudWatch dashboards
+ *
+ * **Scaling:** CloudWatch accepts unlimited metrics via EMF. Standard resolution
+ * metrics (60s) are retained for 15 days; high-resolution (1s) for 3 hours,
+ * then aggregated. Costs scale with unique metric name + dimension combinations.
+ *
+ * **Local development:** Metrics are written as EMF JSON to stdout (same as AWS).
+ * No disk persistence — metrics are ephemeral in local dev.
+ *
+ * **⚠️ Synchronous:** All metric methods are synchronous (void, not Promise).
+ * EMF writes to stdout which Lambda captures asynchronously. Returning a Promise
+ * would add overhead for zero benefit.
+ *
+ * @example
+ * ```typescript
+ * import { Metrics } from '@aws-blocks/bb-metrics';
+ *
+ * const metrics = new Metrics(scope, 'appMetrics', {
+ *   namespace: 'MyApp/Orders',
+ *   defaultDimensions: { service: 'orders' },
+ * });
+ *
+ * metrics.emit('RequestCount', 1, { unit: 'Count' });
+ * metrics.emit('Latency', 42, { unit: 'Milliseconds' });
+ * ```
+ */
+export declare class Metrics extends Scope implements MetricsEmitter {
+    /** The resolved CloudWatch namespace for metrics emitted by this instance. */
+    readonly namespace: string;
+    /** Dimensions applied to every metric emitted by this instance. */
+    readonly defaultDimensions: Readonly<Record<string, string>>;
+    /** @internal Logger for internal operations. Defaults to error-level when not provided. */
+    protected log: ChildLogger;
+    constructor(scope: ScopeParent, id: string, options?: MetricsOptions);
+    /**
+     * Record a single metric data point via EMF.
+     *
+     * @param name - Metric name (e.g., 'RequestCount', 'Latency'). Non-empty, max 1024 chars.
+     * @param value - Numeric value to record.
+     * @param options - Unit, dimensions, timestamp, and resolution.
+     * @throws {MetricsErrors.InvalidMetricName} If the metric name is empty or exceeds 1024 characters.
+     * @throws {MetricsErrors.InvalidDimensions} If dimensions exceed 30 entries or contain empty keys/values.
+     *
+     * @example
+     * ```typescript
+     * metrics.emit('RequestCount', 1);
+     * metrics.emit('Latency', 42, { unit: 'Milliseconds' });
+     * metrics.emit('ErrorRate', 0.05, {
+     *   unit: 'Percent',
+     *   dimensions: { endpoint: '/api/orders' },
+     * });
+     * ```
+     */
+    emit(name: string, value: number, options?: EmitOptions): void;
+    /**
+     * Record multiple metric data points in a single EMF document.
+     * Metrics with the same dimension set are grouped into one EMF entry.
+     *
+     * @param metrics - Array of metric data points (max 100 per call).
+     * @throws {MetricsErrors.InvalidMetricName} If any metric name is invalid.
+     * @throws {MetricsErrors.InvalidDimensions} If any metric's dimensions are invalid.
+     * @throws {MetricsErrors.BatchTooLarge} If the batch exceeds 100 metrics.
+     *
+     * @example
+     * ```typescript
+     * metrics.emitBatch([
+     *   { name: 'RequestCount', value: 1, unit: 'Count' },
+     *   { name: 'Latency', value: 42, unit: 'Milliseconds' },
+     *   { name: 'ErrorCount', value: 0, unit: 'Count' },
+     * ]);
+     * ```
+     */
+    emitBatch(metrics: MetricDatum[]): void;
+    /**
+     * No-op. EMF writes are synchronous stdout writes — no buffering to flush.
+     */
+    flush(): void;
+    /**
+     * Create a child Metrics emitter with inherited namespace and dimensions.
+     * The child merges the provided dimensions on top of the parent's defaults.
+     *
+     * @param dimensions - Additional dimensions for the child instance.
+     * @returns A MetricsEmitter with merged dimensions.
+     *
+     * @example
+     * ```typescript
+     * const requestMetrics = metrics.child({ endpoint: '/api/users', method: 'GET' });
+     * requestMetrics.emit('RequestCount', 1);
+     * ```
+     */
+    child(dimensions: Record<string, string>): MetricsEmitter;
+    /**
+     * Reference an existing CloudWatch namespace not managed by this Building Block.
+     *
+     * @param namespace - The CloudWatch namespace string.
+     *
+     * @example
+     * ```typescript
+     * const metrics = new Metrics(scope, 'legacy', {
+     *   metrics: Metrics.fromExisting('MyOrg/SharedMetrics'),
+     * });
+     * ```
+     */
+    static fromExisting(namespace: string): ExternalMetricsRef;
+}
+//# sourceMappingURL=index.aws.d.ts.map

package/dist/index.aws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.aws.d.ts","sourceRoot":"","sources":["../src/index.aws.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EACX,cAAc,EACd,WAAW,EACX,WAAW,EAGX,kBAAkB,EAClB,cAAc,EACd,MAAM,YAAY,CAAC;AAUpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,YAAY,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,GACd,MAAM,YAAY,CAAC;AAIpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,OAAQ,SAAQ,KAAM,YAAW,cAAc;IAC3D,8EAA8E;IAC9E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7D,2FAA2F;IAC3F,SAAS,CAAC,GAAG,EAAE,WAAW,CAAC;gBAEf,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAUpE;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IAe9D;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAqBvC;;OAEG;IACH,KAAK,IAAI,IAAI;IAEb;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,cAAc;IAOzD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB;CAG1D"}