wayscribe 0.2.0__tar.gz

wayscribe-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

wayscribe-0.2.0/MANIFEST.in

@@ -0,0 +1,6 @@
+# The tests need helpers and the repository's conformance fixtures, which an
+# sdist cannot carry, so the sdist ships the package alone. Run the tests from
+# the repository: pnpm test:python.
+prune tests
+prune scripts
+global-exclude __pycache__ *.py[cod]

wayscribe-0.2.0/NOTICE

@@ -0,0 +1,8 @@
+Wayscribe
+Copyright 2026 Jorge Polanco
+
+This product includes software developed as part of the Wayscribe
+project (https://gitlab.com/jojithedev/wayscribe).
+
+Licensed under the Apache License, Version 2.0. You may obtain a copy of
+the License at http://www.apache.org/licenses/LICENSE-2.0

wayscribe-0.2.0/PKG-INFO

@@ -0,0 +1,378 @@
+Metadata-Version: 2.4
+Name: wayscribe
+Version: 0.2.0
+Summary: Native Python recorder for Wayscribe record-level debugging
+Author: Jorge Polanco
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://wayscribe.dev
+Project-URL: Source, https://gitlab.com/jojithedev/wayscribe
+Project-URL: Documentation, https://gitlab.com/jojithedev/wayscribe/-/blob/main/packages/sdk-python/README.md
+Project-URL: Changelog, https://gitlab.com/jojithedev/wayscribe/-/blob/main/CHANGELOG.md
+Project-URL: Issues, https://gitlab.com/jojithedev/wayscribe/-/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+# Wayscribe Python SDK
+
+Distribution: `wayscribe`. Import: `wayscribe`. Version: `0.2.0`.
+Python 3.11 or newer is required. Runtime code uses only the standard library;
+setuptools is a build dependency only.
+
+```sh
+python3 -m pip install wayscribe
+```
+
+Each release file on PyPI carries a publish attestation: PyPI verified that it
+was uploaded by this repository's GitLab CI release job, with no long-lived
+upload token involved. The recorder works with the published Wayscribe API
+from `v0.1.0` onward.
+
+The controlled
+[`examples/mixed-language`](https://gitlab.com/jojithedev/wayscribe/-/blob/main/examples/mixed-language/README.md)
+workflow installs a wheel built from this checkout and continues one real
+journey from Node through Python to the Go SDK. To build and install that
+wheel from the repository root:
+
+```sh
+uv build --out-dir packages/sdk-python/dist packages/sdk-python
+python3 -m pip install --no-deps packages/sdk-python/dist/wayscribe-0.2.0-py3-none-any.whl
+```
+
+The distribution and import name are both `wayscribe`.
+
+The recorder captures events synchronously and delivers immutable, redacted bytes
+from one bounded daemon sender. Record calls never wait for network work.
+
+```python
+from wayscribe import create_recorder
+
+payload = {"invoice_id": "inv_42", "amount": 10}
+with create_recorder(
+    endpoint="http://localhost:8080", api_key="provided-by-the-host",
+    service="billing-worker", environment="development",
+) as recorder:
+    journey = recorder.journey({"type": "invoice", "id": "inv_42"}, label="Invoice sync")
+    journey.identify({"external_invoice": "external_42"})
+    result = journey.transform("normalize", payload, lambda: {**payload, "amount": 1000})
+    journey.record(operation="persisted", name="write-invoice", output=result)
+    journey.complete()
+
+print(recorder.counters())
+```
+
+Use an ingestion API key for the configured project and environment. The example
+requires a local Wayscribe server and a real key to store events; an unavailable
+server never raises a recorder transport error into the host.
+
+```python
+from wayscribe import inject_http_headers, extract_http_context
+
+context = {"journeyId": "jrn_example", "entity": {"type": "order", "id": "42"}}
+headers = inject_http_headers(context, {"content-type": "application/json"})
+# Default: journey and entity type only. No aliases or entity identifier.
+assert extract_http_context(headers) == {"journeyId": "jrn_example"}
+```
+
+The HTTP, SQS and payload helpers follow `docs/PROPAGATION_SPEC.md` and run all
+committed carrier vectors. Injection accepts `level="journey-only"`,
+`"journey-and-type"` (default), or `"full"`. The latter explicitly opts in to
+propagating a usable entity identifier. `traceparent` is preserved and never
+written. `extract_payload` returns `{"context": context_or_none, "data": value}`.
+`has_journey` is a nonthrowing structural check; use extraction for validation.
+A missing `data` property in a recognized envelope becomes `None` in Python.
+
+Carriers have no environment field. Receiving recorders must use their own
+configured environment. After `journey_environment_mismatch`, the application
+must begin a new journey in the receiving environment.
+
+Timing helpers accept mappings or objects with explicit snake_case fields:
+
+```python
+from wayscribe import queue_metadata, http_metadata
+
+metadata = queue_metadata(
+    {
+        "queue_name": "orders",
+        "id": "42",
+        "timestamp": 1000,
+        "processed_on": 1300,
+        "attempts_made": 0,
+    },
+    delivery_count=1,
+)
+assert metadata["queueWaitMs"] == 300
+
+response_metadata = http_metadata(
+    {"status": 429, "headers": {"retry-after": "2"}},
+    target_url="https://api.example.com/orders/42",
+)
+assert response_metadata["targetHost"] == "api.example.com"
+```
+
+A retry needs `ready_again_at` in epoch milliseconds; the original enqueue time
+is never substituted. Unknown or invalid measurements are omitted, measured zero
+is retained, and a delivery count above one prevents initial-enqueue wait.
+`http_metadata(..., now=epoch_ms)` makes HTTP-date Retry-After deterministic;
+omitting `now` uses the observation time. Numeric Retry-After needs no clock.
+Only the URL host (and a nondefault port) is kept.
+
+Capture is synchronous and detached. Built-in secret names apply at every depth
+and in header shapes. Custom paths supplement built-ins in `redacted-payload`;
+`full-payload` retains built-ins and omits custom paths. `metadata-only` omits input
+and output while still redacting metadata. Capture repairs cycles, nonfinite
+numbers, NUL and unpaired surrogates. Shared references expand independently.
+Integers outside ±(2^53−1) are decimal strings. Bytes/bytearray become
+`{"type": "bytes", "base64": "..."}`. Dates become UTC midnight; naive datetimes
+are interpreted as UTC, and aware datetimes are converted to UTC. Strings are
+bounded in UTF-16 units, protocol identifiers and labels in Unicode code points.
+Unsupported objects become `[UNCAPTURABLE]`; arbitrary attributes are not explored.
+Rendered byte objects obey the same depth and string limits as supplied objects;
+their base64 strings may carry a truncation marker. A decimal integer string that
+exceeds the string limit causes payload omission so retained integers keep every digit.
+
+Labels and displayable aliases are stored, shown and searched in plain text.
+Do not put personal data or credentials in them. Narrow email/telephone shape
+warnings do not alter these values and cannot recognize every kind of personal
+data. Each statement of a displayable alias must list its type again; the server
+keeps it displayable only while every statement does so. Error messages are
+credential-masked and bounded; stacks are never automatically collected.
+
+Configuration comes explicitly from the host, never ambient environment
+variables. Required fields are `endpoint`, `api_key`, `service`, `environment`.
+Invalid required settings disable event admission; rejected optional settings use
+defaults or documented clamps and are available separately from call-time reports.
+`deployment` accepts `git_commit`, `version`, `image`, detached at resolution.
+`redact` and `known_safe_names` accept at most 1,000 strings. The initial sender
+concurrency is fixed at one; passing `max_concurrent_sends` is reported as rejected.
+Delivery defaults and bounds are documented below.
+The envelope budget is capped at the protocol maximum of 262,144 bytes.
+
+`on_diagnostic` receives the Node SDK's report shape and names:
+`{"kind", "code", "reason", "detail"}`, for example
+`{"kind": "breaker_opened", "code": "consecutive_failures", "reason": "...",
+"detail": {"failures": 5, "cooldownMs": 30000}}`. Match on `kind` and `code`;
+`reason` is a sentence whose wording may change. The kinds are `delivered_first`
+(once per recorder, after the first batch the server stored anything from),
+`insecure_endpoint`, `transport_error`, `breaker_opened`, `dropped`,
+`payload_omitted`, `payload_truncated`, `key_dropped`, `capture_error`,
+`configuration_error`, `unredacted_secret_name` and
+`personal_data_in_public_value`; `docs/SDK_SPEC.md` lists where Python still
+differs from Node. A report raised by the sender thread (`delivered_first`,
+`transport_error`, `breaker_opened`) is handed to the callback on a separate
+daemon thread, so a slow callback never holds up delivery; `flush()` and
+`shutdown()` wait for those callbacks within their own deadline. Every other
+report runs the callback on the calling thread before the call returns, as in
+Node. Keep the callback short either way.
+
+Diagnostics never print payloads, credentials, endpoint paths or queries, or
+exception messages. Debug logging is opt-in. A missing required setting, a
+missing or short derivation secret, public personal-data shapes and unredacted
+secret names have bounded process-wide warnings. An unredacted-secret report
+names the field, the key as written (at most 128 characters) and its path with
+every index written `[*]` (`input.lines[*].authToken`, `input[*].apiToken`; at
+most 256 characters), never its value, and so does its printed line, with
+credential shapes masked, so the name can be covered by a rule or marked
+known-safe. At most 100 names are reported per recorder, once per folded name,
+with one printed warning per process and folded name across fields and
+spellings, or every report when `log_diagnostics` is on. Personal-data callbacks
+and printing occur once per process, field and shape. A fork resets the
+process-wide warning state and its lock so a child recorder can report safely.
+
+For development, run from the repository root:
+
+```sh
+pnpm test:python
+pnpm test:python:conformance
+```
+
+The recorder passes all 35 applicable SDK fixtures; the two throwing-property
+fixtures are explicitly Node-only. Its captured request bytes are replayed
+unchanged through the real local API dry run, and a clean wheel installation is
+tested outside the source checkout. The example in `examples/python-worker`
+exercises a queryable journey through the real API. These local checks do not
+publish the package, and the separate Leadline pilot remains open.
+
+## Recorder and journey API
+
+`create_recorder(**options)` and `Recorder(**options)` create the same recorder.
+`journey(entity, journey_id=None, label=None)` copies the entity identity;
+`for_entity(entity, label=None)` derives the journey using the configured
+`journey_id_secret` (at least 32 UTF-8 bytes). A missing/invalid secret warns and
+uses a fresh unpredictable ID. Identity arguments after `entity` are keyword-only.
+`resume(context, entity=...)` uses the receiver's authoritative entity and its own
+configured environment. It continues only a journey ID valid for both propagation
+and the event protocol. Carrier parsing accepts up to 256 characters, but events
+accept 128: a longer resumed ID is diagnosed and replaced with a fresh ID. An
+explicit `journey_id` passed to `journey` is not silently replaced; invalid required
+event identity is refused without incrementing delivery counters.
+
+A journey supports `context()` (a detached mapping), `label(value)` (records
+nothing), `record(operation=..., name=..., **event_fields)`,
+`identify(aliases, displayable_aliases=())`, `fail(name, error)`, and
+`complete(name="complete")`. Event keyword fields use snake_case:
+`input`, `output`, `metadata`, `timestamp`, `duration_ms`, `attempt`, `error`,
+`parent_event_id`, `trace_id`, `span_id`, `message_id`, `correlation_id`,
+`journey_label`, `aliases`, `displayable_aliases`. `timestamp` is an ISO timestamp
+with an explicit time zone. Omitted payloads are absent; explicit `None` is JSON
+null. Pass trace/span IDs explicitly; no OpenTelemetry installation is needed.
+
+`transform`, `persist`, `publish`, `consume`, `deliver`, and `validate` each accept
+`(name, input, callback, **options)`. The callback takes no arguments and executes
+once. A synchronous result returns synchronously; an awaitable result returns an
+awaitable wrapper. Returned/resolved values, exception objects and cancellation
+are preserved. Input and static metadata/aliases are captured before the callback
+can mutate them. The event uses the start timestamp and whole elapsed milliseconds.
+An explicit `attempt > 1` changes the operation to `retried`; a failed attempt
+carries its own error, and `fail` is for terminal journey/branch failures.
+
+Wrapper options include event fields plus:
+
+- `capture_input(value)` and `capture_output(value)` project the captured view.
+  They may also accept a second `context` argument. They run synchronously;
+  exceptions or awaitable results produce `[UNCAPTURABLE]` and a safe diagnostic.
+  Output projections run only when the callback returns/resolves.
+- `is_failure(result)` classifies a returned result once. A truthy value marks
+  failure; a string supplies the message, or a mapping supplies `message` and/or
+  `code`. Other truthy values use a generic message and `result_failed` code.
+  A failed classifier leaves the host's result unchanged and reports safely.
+- `metadata_from(result[, context])` returns synchronous metadata, merged over
+  the static snapshot. Explicit `attempt` remains authoritative. For example,
+  `metadata_from=lambda response: http_metadata(response, target_url=url)` records
+  HTTP evidence without storing a URL path. A failed projection keeps static data.
+- `queue_job=job`, `ready_again_at=epoch_ms`, `delivery_count=n` add the evidence
+  from `queue_metadata`. Pass the wrapper's `attempt` explicitly when retrying.
+
+`recorder.across([journey_a, journey_b, journey_a])` exposes the operation methods,
+including `record`, wrappers, `fail` and `complete`. It deduplicates by journey ID,
+executes a wrapped callback once, and emits separate event IDs sharing timestamp
+and duration. Context-aware projections run once for each distinct journey.
+Journeys must belong to that recorder. Groups have no label/identify/context method.
+
+```python
+import asyncio
+from wayscribe import create_recorder
+
+async def main():
+    async with create_recorder(
+        endpoint="http://localhost:8080", api_key="provided-by-the-host",
+        service="async-worker", environment="development",
+    ) as recorder:
+        journey = recorder.journey({"type": "invoice", "id": "inv_42"})
+        async def work():
+            await asyncio.sleep(0)
+            return {"ok": True}
+        result = await journey.deliver("send", {}, work)
+        assert result["ok"]
+        await recorder.async_flush(timeout_ms=1000)
+
+asyncio.run(main())
+```
+
+## Delivery and lifecycle
+
+The configurable delivery bounds are `batch_size=50` (clamped to 1–100),
+`flush_interval_ms=1000`, `request_timeout_ms=1500`,
+`max_buffered_events=1000`, and `max_event_bytes=262144` (capped at 262144).
+The queue is bounded separately from the single in-flight batch (at most 100).
+Overflow discards the oldest pending event. Retries retain their original queue
+age and byte-identical envelopes. Transport uses the batch route, verified TLS for
+HTTPS, a 1 MiB response-body limit, and no ambient proxy credentials. As the
+Node SDK's `fetch` does, a 307 or 308 is followed, up to 20 times, with the same
+body, and the API key is not sent to a different origin; any other 3xx is a
+failed attempt and is retried. A 2xx body over 1 MiB cannot hold the verdicts
+for 100 events and is read as a reply with no verdict (`no_verdict`), which is
+what Node makes of a body it cannot parse.
+Use HTTPS outside a trusted local development setup.
+
+Fixed retry defaults are three HTTP attempts per logical send, full-jitter
+exponential backoff (100 ms base, 2000 ms cap), and a breaker opening after five
+failed logical sends for 30 seconds. Transient per-event refusals retain an
+independent 30-second budget from the first refusal or ten logical sends, whichever
+comes first. Ten logical sends can contain up to 30 HTTP attempts. Expired events
+are dropped before another attempt, including after backoff or breaker cooldown.
+Accepted events reset the breaker; whole-request 4xx is permanent and leaves the
+breaker count unchanged. Verdicts are matched by position, not response event ID.
+Unknown/missing/malformed successful verdicts drop once as `no_verdict`.
+
+`flush(timeout_ms=5000)` and `shutdown(timeout_ms=5000)` return whether queued work
+finished within the deadline. Finished means terminal accounting: consult counters
+to distinguish sent events, permanent refusals and drops. A flush timeout leaves
+pending work available for later delivery. Shutdown stops admission and drains until
+empty, a pass makes no progress, or the deadline expires. It aborts active sockets
+and counts every remaining event exactly once. Repeated shutdown returns its first
+result. Valid records attempted after shutdown count as recorded and dropped with
+cause `after_shutdown`; invalid calls are not admitted. Final delivery counts obey
+`recorded == sent + rejected + dropped` and drop causes sum to `dropped`.
+
+`async_flush` and `async_shutdown` await the same sender without blocking the event
+loop or creating executor threads. Cancelling async shutdown finalizes remaining
+work and propagates cancellation. Sync and async context managers call shutdown and
+never suppress an exception from the context body. Background delivery cannot keep
+the host process alive. A DNS/connect operation that the OS cannot cancel may finish
+later in the daemon, but cannot write an HTTP request after cancellation or change
+final counters. Shutdown cannot retract bytes sent earlier; the server can still
+store an earlier in-flight request after the caller's deadline.
+
+A recorder created before `fork()` (gunicorn `--preload`, Celery prefork,
+`multiprocessing` with the fork start method) keeps working in the child. The
+child's copy gets fresh locks, an empty queue, zero counters and its own sender
+without acquiring anything it inherited, so a parent thread that held a lock
+at the fork cannot block it. Events queued before the fork belong to the parent
+and are never resent by a child; the child never closes the parent's socket. A
+recorder shut down before the fork stays shut down in the child. Use detached
+`counters()` and `rejected_settings()` for health checks; diagnostics callbacks
+may safely reenter the recorder and must themselves remain short-running.
+
+The sender thread starts with the first recorded event, so a recorder that never
+records has no thread. A recorder dropped without `shutdown()` does not keep its
+thread: once its queue is empty the thread ends within about a second of the
+recorder being garbage-collected.
+
+At interpreter exit, an `atexit` handler flushes what is still queued, with one
+1,000 ms deadline shared by every recorder in the process, so exit is never held
+longer than that. It flushes and does not shut down; call `shutdown()` yourself
+for a longer drain or exact final counts. `os._exit()`, a killed process and a
+forked child that ends with `os._exit()` skip it, and their queued events are
+lost.
+
+## Check your installed recorder
+
+[CLI `check`](https://gitlab.com/jojithedev/wayscribe/-/blob/main/packages/cli/README.md#check-ingestion-and-preview-stored-events) exercises
+explicit protocol/key/server configuration through a dry run. It does not inspect
+an installed Python SDK. This separate synthetic public-SDK probe **stores an
+event** in the configured environment:
+
+```python
+import os
+from wayscribe import create_recorder
+
+with create_recorder(
+    endpoint=os.environ["WAYSCRIBE_URL"],
+    api_key=os.environ["WAYSCRIBE_API_KEY"],
+    service="python-sdk-check",
+    environment=os.environ["WAYSCRIBE_ENVIRONMENT"],
+    on_diagnostic=lambda d: print({"kind": d["kind"], "code": d["code"]}),
+) as recorder:
+    recorder.journey({"type": "sdk-check", "id": "synthetic-python"}).record(
+        operation="received", name="sdk-check"
+    )
+    drained = recorder.flush(timeout_ms=5000)
+    counters = recorder.counters()
+    print({"drained": drained, **{name: counters[name] for name in
+          ("recorded", "sent", "rejected", "dropped", "configuration_errors")}})
+```
+
+Flush completion includes rejected/dropped work. Inspect delivery counters after
+recording; an idle recorder's zero counters do not prove connectivity. The
+context manager shuts down the recorder. Log diagnostic kind/code, not payloads,
+keys or caller-written details.