aws-durable-execution-sdk-python-telemetry-exporter 0.0.1__tar.gz

aws_durable_execution_sdk_python_telemetry_exporter-0.0.1/.gitignore

@@ -0,0 +1,39 @@
+*~
+*#
+*.swp
+*.iml
+*.DS_Store
+
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+
+*.coverage
+/.coverage
+/.coverage.*
+/.cache
+/.pytest_cache
+/.mypy_cache
+/.vscode
+
+/doc/_apidoc/
+/build
+
+.venv
+.venv/
+
+.attach_*
+
+dist/
+
+.idea
+
+.kiro/
+
+**/build/
+**/*.zip
+.aws-sam/
+**/template.generated.json
+
+.env

aws_durable_execution_sdk_python_telemetry_exporter-0.0.1/LICENSE

@@ -0,0 +1,175 @@
+
+                                 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.

aws_durable_execution_sdk_python_telemetry_exporter-0.0.1/NOTICE

@@ -0,0 +1 @@
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

aws_durable_execution_sdk_python_telemetry_exporter-0.0.1/PKG-INFO

@@ -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).