aws-durable-execution-sdk-python-telemetry-exporter 0.0.1__py3-none-any.whl

aws_durable_execution_sdk_python_telemetry_exporter/types.py

@@ -0,0 +1,127 @@
+# SPDX-FileCopyrightText: 2026-present Amazon.com, Inc. or its affiliates.
+#
+# SPDX-License-Identifier: Apache-2.0
+"""Configuration types for the Durable Execution Telemetry plugin.
+
+Mirrors the JS ``DurableExecutionTelemetryConfig`` / ``ContentConfig`` /
+``OperationOverride``
+(``aws-durable-execution-sdk-js-telemetry-exporter/src/types.ts``). Python uses
+snake_case config field names; the *emitted wire record* keeps the JS camelCase
+field names (see ``plugin.py``) so records read identically across SDKs.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from enum import StrEnum
+from typing import Any, Callable, Literal, Protocol
+
+
+class EmitMode(StrEnum):
+    """When the plugin emits a record. The values match the JS plugin's modes."""
+
+    # emit once at terminal SUCCEEDED/FAILED (default)
+    ON_COMPLETE = "on-complete"
+    # emit once only at terminal FAILED
+    ON_FAILURE = "on-failure"
+    # emit on every operation change and at end (nondeterministic count)
+    ON_CHANGE = "on-change"
+
+
+class OperationDetail(StrEnum):
+    """How much of the operation tree a record carries. Values match the JS plugin."""
+
+    # drop any operation with a parentId (default)
+    TOP_LEVEL = "top-level"
+    # include children of contexts too
+    FULL_TREE = "full-tree"
+
+
+# Accepted string inputs, kept in lockstep with the enum values above. Config
+# fields are typed as these ``Literal`` unions (never bare ``str``) so a typoed
+# mode fails a static type check, while
+# ``DurableExecutionTelemetryConfig.__post_init__`` normalizes any accepted value to the matching enum member and raises
+# ``ValueError`` for an invalid dynamic string.
+EmitModeInput = Literal["on-complete", "on-failure", "on-change"]
+OperationDetailInput = Literal["top-level", "full-tree"]
+
+
+class TelemetryExporter(Protocol):
+    """A destination that receives one curated Durable Execution Telemetry record.
+
+    ``max_record_size_bytes`` bounds the serialized record body (the plugin's
+    size limiter measures ``render(record)``). First-party exporters default it
+    to their destination's practical limit; an exporter whose value is ``None``
+    is never truncated.
+    ``render`` maps the canonical record dict to the exact shape the exporter
+    serializes (identity for array exporters, the ``operationsByName`` expansion
+    for point-access exporters).
+    """
+
+    max_record_size_bytes: int | None
+
+    def render(self, record: dict[str, Any]) -> Any: ...  # pragma: no cover
+
+    def export(self, record: dict[str, Any]) -> None: ...  # pragma: no cover
+
+    def flush(self) -> None: ...  # pragma: no cover
+
+
+@dataclass(frozen=True)
+class OperationOverride:
+    """Per-operation override matched by ``operation_name``.
+
+    ``result`` opts the operation's result into the record via a transform that
+    receives the checkpointed, JSON-parsed result (the SDK's own serialized form
+    — the plugin never runs custom Serdes). Mirrors JS ``OperationOverride``.
+    """
+
+    operation_name: str
+    exclude: bool = False
+    result: Callable[[Any], Any] | None = None
+
+
+@dataclass(frozen=True)
+class ContentOperations:
+    overrides: list[OperationOverride] = field(default_factory=list)
+    include_errors: bool | None = None
+
+
+@dataclass(frozen=True)
+class ContentConfig:
+    """Controls what data is included in emitted records.
+
+    ``input`` / ``output``: ``False`` omits the field, a callable transforms it,
+    ``True``/``None`` includes it as-is. Mirrors JS ``ContentConfig``.
+    """
+
+    input: bool | Callable[[Any], Any] | None = None
+    output: bool | Callable[[Any], Any] | None = None
+    operations: ContentOperations | None = None
+
+
+@dataclass(frozen=True)
+class DurableExecutionTelemetryConfig:
+    """Configuration for the Durable Execution Telemetry plugin.
+
+    Mirrors JS ``DurableExecutionTelemetryConfig``.
+    """
+
+    exporters: list[TelemetryExporter] = field(default_factory=list)
+    sampling_rate: float | None = None
+    emit_mode: EmitMode | EmitModeInput | None = None
+    operation_detail: OperationDetail | OperationDetailInput | None = None
+    content: ContentConfig | None = None
+
+    def __post_init__(self) -> None:
+        # Normalize accepted string inputs to enum members so the plugin always
+        # compares against ``EmitMode`` / ``OperationDetail`` members. ``EmitMode(x)``
+        # is idempotent for members, accepts the exact JS-style strings, and raises
+        # ``ValueError`` for an unrecognized dynamic string. Frozen dataclass, so use
+        # ``object.__setattr__`` to rebind the normalized value.
+        if self.emit_mode is not None:
+            object.__setattr__(self, "emit_mode", EmitMode(self.emit_mode))
+        if self.operation_detail is not None:
+            object.__setattr__(
+                self, "operation_detail", OperationDetail(self.operation_detail)
+            )

aws_durable_execution_sdk_python_telemetry_exporter-0.0.1.dist-info/METADATA

@@ -0,0 +1,256 @@
+Metadata-Version: 2.5
+Name: aws-durable-execution-sdk-python-telemetry-exporter
+Version: 0.0.1
+Summary: Durable Execution Telemetry instrumentation plugin for the AWS Durable Execution SDK for Python
+Project-URL: Documentation, https://github.com/aws/aws-durable-execution-sdk-python#readme
+Project-URL: Issues, https://github.com/aws/aws-durable-execution-sdk-python/issues
+Project-URL: Source, https://github.com/aws/aws-durable-execution-sdk-python
+Author-email: AWS durable-execution-dev <durable-execution-dev@amazon.com>
+License-Expression: Apache-2.0
+Keywords: durable-execution,durable-execution-telemetry,observability
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.11
+Requires-Dist: aws-durable-execution-sdk-python>=2.0.0
+Provides-Extra: s3
+Requires-Dist: boto3>=1.26.0; extra == 's3'
+Description-Content-Type: text/markdown
+
+# AWS Durable Execution SDK for Python — Durable Execution Telemetry Exporter
+
+Durable Execution Telemetry instrumentation plugin for the AWS Durable
+Execution SDK for Python. A port of the JavaScript SDK's
+`durableExecutionTelemetry()` plugin: it listens to the SDK's instrumentation
+hooks and emits one curated `DurableExecutionTelemetry` record per execution
+to the configured exporters. The wire record keeps the JS camelCase field
+names so records read identically across SDKs.
+
+> **Experimental.** Like its JS counterpart, this plugin is experimental and may
+> change or be removed in future releases.
+
+## Install
+
+```bash
+pip install aws-durable-execution-sdk-python-telemetry-exporter
+# with the S3 exporter's local-dev dependency:
+pip install "aws-durable-execution-sdk-python-telemetry-exporter[s3]"
+```
+
+## Usage
+
+```python
+from aws_durable_execution_sdk_python import durable_execution
+from aws_durable_execution_sdk_python_telemetry_exporter import (
+    DurableExecutionTelemetryConfig,
+    durable_execution_telemetry,
+)
+from aws_durable_execution_sdk_python_telemetry_exporter.exporters import S3Exporter
+
+@durable_execution(
+    plugins=[
+        durable_execution_telemetry(
+            DurableExecutionTelemetryConfig(
+                exporters=[
+                    S3Exporter(bucket="my-bucket", prefix="durable-execution-telemetry/")
+                ],
+            )
+        )
+    ]
+)
+def handler(event, context):
+    ...
+```
+
+With no exporter configured, records are written to the function's own
+CloudWatch log group as single JSON lines (the `LambdaLogExporter` default),
+carrying the name-keyed `operationsByName` summary. The `S3Exporter` writes the
+lossless per-occurrence `operations` array, one object per execution
+(upsert-by-execution-name, so re-emission overwrites rather than appends).
+
+## Exporters
+
+All exporters live in `aws_durable_execution_sdk_python_telemetry_exporter.exporters` and
+are re-exported from the package root. Each serializes the record as compact
+JSON. Exporters that call AWS accept an injected `client=` for tests and use
+the Lambda runtime's boto3 otherwise; none adds a required dependency.
+
+| Exporter | Destination | Upsert | Operations shape | Default size limit |
+| --- | --- | --- | --- | --- |
+| `LambdaLogExporter` | Function's own log group | No | `operationsByName` | 256 KB |
+| `CloudWatchLogsExporter` | Any log group, one stream per day | No | `operationsByName` | 256 KB |
+| `S3Exporter` | S3 object per execution | Yes (key) | `operations` | 5 MB |
+| `DynamoDBExporter` | DynamoDB item | Configurable | `operationsByName` | 400 KB |
+| `AuroraExporter` | Aurora MySQL/PostgreSQL row (Data API) | Yes (upsert) | full record as JSON column | 1 MB |
+| `RedshiftExporter` | Redshift row (Data API) | Yes (MERGE) | full record as SUPER column | 1 MB |
+| `OpenSearchExporter` | OpenSearch document | Yes (`_id`) | `operations` | 10 MB |
+| `FirehoseExporter` | Firehose delivery stream | N/A | `operations_format` | 1 MB |
+| `EventBridgeExporter` | EventBridge event | N/A | `operations_format` | 256 KB |
+| `SQSExporter` | SQS message | N/A | `operations_format` | 256 KB |
+| `OTelExporter` | OTLP/HTTP logs endpoint | N/A | `operations_format` | 1 MB |
+| `HttpExporter` | Any HTTP endpoint | N/A | `operations_format` | none |
+| `FileExporter` | Directory (EFS, mount, `/tmp`) | Configurable | `operations_format` | none |
+
+`operations_format` is `"array"` (default), `"by-name"`, or `"both"`
+(`OperationsFormat`). `max_record_size_bytes` raises or lowers an exporter's
+size limit; omitting it keeps the default. `HttpExporter` and `FileExporter`
+have no default and do not truncate unless a limit is set.
+
+### CloudWatchLogsExporter
+
+Writes one `PutLogEvents` event per record to `log_group_name`, in a stream
+named `{log_stream_prefix}{YYYY}/{MM}/{DD}` (default prefix `durable-execution-telemetry/`).
+IAM: `logs:CreateLogStream`, `logs:PutLogEvents` on the log group.
+
+```python
+CloudWatchLogsExporter(log_group_name="/custom/durable-execution-telemetry")
+```
+
+### DynamoDBExporter
+
+`PutItem` keyed by `partition_key` (default `pk`) = `executionArn`. With the
+default `sort_key="sk"` (= `emittedAt`) every export adds an item; pass
+`sort_key=None` for a key-only table that upserts. IAM: `dynamodb:PutItem`.
+
+```python
+DynamoDBExporter(table_name="durable-execution-telemetry")
+```
+
+### AuroraExporter
+
+Upserts a row by `execution_arn` through the RDS Data API; `engine` is
+`"postgresql"` or `"mysql"` and selects the dialect. Columns: `execution_arn,
+execution_name, function_name, status, start_time, end_time, duration_ms,
+record_json, emitted_at`. IAM: `rds-data:ExecuteStatement`,
+`secretsmanager:GetSecretValue`.
+
+```python
+AuroraExporter(
+    resource_arn="arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
+    secret_arn="arn:aws:secretsmanager:us-east-1:123456789012:secret:my-db-creds",
+    database="telemetry",
+    engine="postgresql",
+)
+```
+
+### RedshiftExporter
+
+`MERGE` by `execution_arn` through the Redshift Data API into
+`{schema}.{table}` (default `public.durable_execution_telemetry`, same columns as Aurora,
+`record_json` as `SUPER`). Provide `workgroup_name` (Serverless) or
+`cluster_identifier` (provisioned, with `db_user` or `secret_arn`). IAM:
+`redshift-data:ExecuteStatement` plus `redshift-serverless:GetCredentials` or
+`secretsmanager:GetSecretValue`. The statement is submitted and not awaited, so
+statement failures are not reported and `on-change` records may land out of
+order; prefer the default `on-complete` emit mode with this exporter.
+
+```python
+RedshiftExporter(database="telemetry", workgroup_name="telemetry-wg")
+```
+
+### OpenSearchExporter
+
+`PUT {endpoint}/{index_name}/_doc/{executionArn}` (default index
+`durable-execution-telemetry`). `auth="sigv4"` (default) signs with the runtime's
+credentials via botocore; `auth="basic"` uses `username`/`password`. IAM:
+`es:ESHttpPut` on the domain.
+
+```python
+OpenSearchExporter(endpoint="https://my-domain.us-east-1.es.amazonaws.com", region="us-east-1")
+```
+
+### FirehoseExporter
+
+`PutRecord` of one JSON line (trailing newline) per record. IAM:
+`firehose:PutRecord`.
+
+```python
+FirehoseExporter(delivery_stream_name="durable-execution-telemetry-stream")
+```
+
+### EventBridgeExporter
+
+`PutEvents` with `Source` (default `software.amazon.lambda.durable.telemetry`),
+`DetailType` = record status, `Detail` = record. All arguments optional. IAM:
+`events:PutEvents`.
+
+```python
+EventBridgeExporter(event_bus_name="default")
+```
+
+### SQSExporter
+
+`SendMessage` with the record as body and `status`/`functionName` message
+attributes. A `.fifo` queue URL enables `MessageGroupId` (default
+`executionArn`, or `message_group_id`) and a deduplication id of
+`executionArn:emittedAt`. IAM: `sqs:SendMessage`.
+
+```python
+SQSExporter(queue_url="https://sqs.us-east-1.amazonaws.com/123456789012/telemetry")
+```
+
+### OTelExporter
+
+POSTs one OTLP `ExportLogsServiceRequest` (`http/json` only) per record to
+`endpoint`; identity fields become attributes and the record is the log body.
+Pass vendor auth in `headers`. No IAM.
+
+```python
+OTelExporter(endpoint="https://otlp.vendor.com/v1/logs", headers={"x-api-key": "..."})
+```
+
+### HttpExporter
+
+`POST` (or `method="PUT"`) the record as JSON to `url` with
+`Content-Type: application/json` plus `headers`; a non-2xx status raises.
+`timeout_ms` defaults to 10000 and currently applies to each socket operation
+(the connect, each write of the request, and each read of the status line,
+headers, and a non-2xx error body; a 2xx body is never read) rather than to the
+whole request, so an endpoint that consumes or responds slowly can hold the
+export open longer than `timeout_ms`; a future release may enforce it as a
+whole-request deadline. No IAM.
+
+```python
+HttpExporter(url="https://hooks.example.com/telemetry", headers={"Authorization": "Bearer ..."})
+```
+
+### FileExporter
+
+`mode="ndjson"` (default) appends to `{directory}/{YYYY-MM-DD}.ndjson`;
+`mode="json"` writes `{directory}/{executionName}.json`, overwriting on update.
+For Lambda use an EFS mount (IAM: `elasticfilesystem:ClientMount`,
+`elasticfilesystem:ClientWrite`) or `/tmp` for testing. Appends from many
+concurrent environments to one NDJSON file on a network file system can
+interleave; use `mode="json"` when several environments share a directory.
+
+```python
+FileExporter(directory="/mnt/efs/durable-execution-telemetry")
+```
+
+Emission behavior, record schema (`recordType: DurableExecutionTelemetry`,
+`schemaVersion: "1.0"`), sampling, content configuration (input/output
+omission, `include_errors`, per-operation result opt-in), truncation phases,
+and `top-level` vs `full-tree` operation detail all mirror the JS plugin.
+Behavior is validated cross-SDK by the `telemetry` conformance suite
+(`aws-durable-execution-conformance-tests-telemetry`).
+
+> **Note (asynchronous export).** Export rendering, truncation, `export()`, and
+> `flush()` run on one lazy background worker per plugin. Checkpoint hooks only
+> replace that execution's latest pending snapshot and wake the worker.
+> Consecutive `on-change` snapshots for one execution coalesce whenever the
+> worker has not yet claimed the previous one, including when no export is
+> running, so under fast in-memory checkpoints (the local runner) a burst may
+> deliver only its first and latest snapshots. Snapshots from different
+> executions never coalesce with each other. An invocation that emits a record
+> drains every pending snapshot and flushes exporters before it returns;
+> invocations that emit nothing do not start or flush the worker.
+
+## Requirements
+
+- `aws-durable-execution-sdk-python` with the plugin invocation hooks that
+  surface `execution_input` / `execution_result` (included since the version
+  this package declares as its minimum).

aws_durable_execution_sdk_python_telemetry_exporter-0.0.1.dist-info/RECORD

@@ -0,0 +1,28 @@
+aws_durable_execution_sdk_python_telemetry_exporter/__about__.py,sha256=GPAocThPVDL3efYeQ46aR1SYARYXBL4S0Xswkn4UeFI,137
+aws_durable_execution_sdk_python_telemetry_exporter/__init__.py,sha256=83VSkyDz8JSQ6TH52x9YnEP848mkUe7RV0M1jLMS2TA,2284
+aws_durable_execution_sdk_python_telemetry_exporter/_export_scheduler.py,sha256=D1ItjefIIeDmmE08IBZUQgnupKtVMjei1XQcBFLB7Qg,7006
+aws_durable_execution_sdk_python_telemetry_exporter/operations_index.py,sha256=xZmoEfeKGFr2wdgSHTUcV0yhN_sM72plO_iKQTgi0-M,4976
+aws_durable_execution_sdk_python_telemetry_exporter/plugin.py,sha256=yB4sxdIp6NcCDRtEbL7Qchs0Y3FAwzSyMMOZxQYi6AU,18046
+aws_durable_execution_sdk_python_telemetry_exporter/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aws_durable_execution_sdk_python_telemetry_exporter/truncation.py,sha256=KnnOWvEy8jlwYfo-sPT9UP4aC-F2Kc7LqmRTBRUzEzg,3482
+aws_durable_execution_sdk_python_telemetry_exporter/types.py,sha256=4dp5G7lgfL14Te2heyHD6NsGU_AEe8XCehnQLqHp-0k,4870
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/__init__.py,sha256=QK72ouRpu6_GmMfyxvocbVIkJTSQwdtSxmM2mcjXN2Q,2771
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/_common.py,sha256=wOHB3qUYkwVkCFgBP1pq3zS0ksGCaa-cjPWp4J7_4zg,4027
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/aurora_exporter.py,sha256=apkuD7uIxZtuplyy_Tv_SfslqT68uyhOhB1or01Z8Fc,5389
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/cloudwatch_logs_exporter.py,sha256=ilMYPXw8aNc2O515sVeNIjF0RSm9dlPbKGcniitG0B8,3195
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/dynamodb_exporter.py,sha256=FocpKBsz-TYzIqLl3gdIRbkU_-YNuxuPkqsb6uYNRkk,2692
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/eventbridge_exporter.py,sha256=22NqCpPmlPnXLZNguzu47Q95LH-k73wARBmfTQ99zoA,2816
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/file_exporter.py,sha256=kUkTIOJ2j3cXgFdO0nn6x9vq-slMc95ZZ5zhZzcIDIo,2948
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/firehose_exporter.py,sha256=lHE9BXlVvM7-R3Z0kECPKmrO8ozVp1n9CEUUOOKoy3E,2116
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/http_exporter.py,sha256=oxO6roVRkIe1IiTKaL3uGhKwt7i_OlE91Yr_IF1qOB8,3079
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/lambda_log_exporter.py,sha256=dy2ExgR6gWa_RbI-MPFVU60YnnPbF0Nnc8sM5-TNtdc,1504
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/opensearch_exporter.py,sha256=Al-fr2OCjXBwyKrmEhIIwu2AR5x7unb13i8bwNdAUMY,4104
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/otel_exporter.py,sha256=fdTC__j8XBzJcL53Wjj1QvUxWtdZ-yG3J6Zq4ENlxtc,6207
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/redshift_exporter.py,sha256=xkT2Pto64d7OJUPysyxu265HAF_PxuNDGBSIRa7Jgm8,6201
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/s3_exporter.py,sha256=Tm8crVKy0M3aoF44EazZ_OALn0Y_3EXrgmLJWxF4LYc,3877
+aws_durable_execution_sdk_python_telemetry_exporter/exporters/sqs_exporter.py,sha256=zhj65YjuqCxEctiOhN3uxOdc-YniUoOrs0YZI5YnQIM,3333
+aws_durable_execution_sdk_python_telemetry_exporter/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
+aws_durable_execution_sdk_python_telemetry_exporter/NOTICE,sha256=1CkO1kwu3Q_OHYTj-d-yiBJA_lNN73a4zSntavaD4oc,67
+aws_durable_execution_sdk_python_telemetry_exporter-0.0.1.dist-info/METADATA,sha256=FbBXlEp9YxwShlFj79i1CVninP4TZax-nWqWBQLEpgM,10952
+aws_durable_execution_sdk_python_telemetry_exporter-0.0.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+aws_durable_execution_sdk_python_telemetry_exporter-0.0.1.dist-info/RECORD,,

aws_durable_execution_sdk_python_telemetry_exporter-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any