021-python-observability 0.3.0__tar.gz

021_python_observability-0.3.0/.gitignore

@@ -0,0 +1,8 @@
+.venv*/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+.env*
+!.env.example
+dist/

021_python_observability-0.3.0/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+## [0.3.0](https://github.com/from021-io/observability-python/compare/v0.2.0...v0.3.0) (2026-10-21)
+
+
+### ⚠ BREAKING CHANGES
+
+* **package:** consumers rename the dependency from 021-observability to 021-python-observability (with its extras) in their project dependencies, [tool.uv.sources] key or requirements line when moving past v0.2.0, then regenerate their lock.
+
+### Build
+
+* **package:** publish to PyPI as 021-python-observability ([#11](https://github.com/from021-io/observability-python/issues/11)) ([7c9056f](https://github.com/from021-io/observability-python/commit/7c9056f68a93fdaf31949df79b8da16785c27853))
+
+## [0.2.0](https://github.com/from021-io/observability-python/compare/v0.1.0...v0.2.0) (2026-10-01)
+
+
+### Bug fixes
+
+* **grafana:** reject duplicate panel ids during validation ([a285659](https://github.com/from021-io/observability-python/commit/a285659816d7e6f653f63f0eb15617bee0286786))
+
+
+### Refactors
+
+* **grafana:** share synchronization tooling and tests ([2a3cd4c](https://github.com/from021-io/observability-python/commit/2a3cd4c47b8b1e82fa9af49fe5514f5b259cee26))
+
+
+### CI
+
+* **release:** version and tag the library with release-please ([#8](https://github.com/from021-io/observability-python/issues/8)) ([bdb1a90](https://github.com/from021-io/observability-python/commit/bdb1a90af1996ef24aa5dc3c3f57d0bcfc8ce69c))
+
+## [0.1.0] - 2026-09-23
+
+### Added
+
+- Shared Prometheus reader for consumer scrape compatibility, approved domain dimensions and scalar units, typed HTTPX transport surface and a complete-request HTTP context for existing service clients.
+- **Observability**: common FastAPI/ASGI request metrics, correlated JSON logs and configurable OTLP metrics/traces.
+- **Dependencies**: explicit HTTPX and SQLAlchemy instrumentation, process/pool signals, health/readiness and domain operation helpers.
+- **Verification**: local OTLP receiver and Python 3.12/3.14 contract checks; package distribution and consumer deployment remain separate decisions.
+
+### Changed
+
+- **Rollout**: document the readiness JSON contract, protobuf headers, log correlation and coordinated consumer pin/monitor migration.
+- **Repository**: rename the GitHub repository to `from021-io/observability-python`; keep the Python distribution and import names unchanged.
+- Keep task progress in workspace documents instead of a repository `PROGRESS.md`.
+- Reapply safe logging at lifespan startup and route Uvicorn errors through the common formatter.
+- Replace outbound correlation headers case-insensitively to avoid conflicting context.
+- Pin setup-uv to the published v9.0.0 tag for the Python contract matrix.
+
+### Fixed
+
+- **Logs**: preserve validated domain correlation UUIDs and bounded exception types/frame locations for structlog, stdlib, Uvicorn and unhandled ASGI failures, without exposing exception messages, source lines, locals or absolute directories. IDs remain excluded from metric labels.
+- Preserve FastAPI included-router prefixes and safe structured stdlib failure fields; quiet HTTPX2/Neo4j drivers and skip Vercel continuations when no remote exporter is configured.
+- **Configuration**: explicit empty headers no longer inherit unrelated ambient OTLP credentials from the SDK.
+
+[Unreleased]: https://github.com/from021-io/observability-python/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/from021-io/observability-python/releases/tag/v0.1.0

021_python_observability-0.3.0/CONTRACT.md

@@ -0,0 +1,127 @@
+# Signal contract 0.1
+
+Resource fields: `service.name`, `service.version`, `service.instance.id`,
+`deployment.environment.name`. Each app owns its providers; none are installed globally.
+Use `app.state.observability.tracer` if infrastructure needs the same explicit tracer.
+The application must remove its old server instrumentation when adopting this package.
+
+| Signal | Kind / unit | Dimensions |
+| --- | --- | --- |
+| `http.server.request.count` | Counter / `{request}` | method, route, final status when sent, outcome, bounded error type when applicable |
+| `http.server.request.duration` | Histogram / `s` | same |
+| `http.server.active_requests` | UpDownCounter / `{request}` | method |
+| `http.client.request.count` | Counter / `{request}` | dependency, method, status when received, bounded error type |
+| `http.client.request.duration` | Histogram / `s` | same |
+| `db.client.operation.count` | Counter / `{operation}` | dependency, status, bounded error type |
+| `db.client.operation.duration` | Histogram / `s` | same |
+| `db.client.connection.count` | ObservableGauge / `{connection}` | dependency, state `used`/`idle` |
+| `app.operation.count` | Counter / `{operation}` | operation, status |
+| `app.operation.duration` | Histogram / `s` | operation, status |
+| `app.*` domain counters | Counter / `1` | operation, status |
+| `app.*.duration` domain durations | Histogram / `s` | operation, status |
+| `process.cpu.time` | ObservableCounter / `s` | none |
+| `process.uptime` | ObservableGauge / `s` | none |
+| `process.memory.peak_usage` | ObservableGauge / `By` | none |
+| `process.thread.count` | ObservableGauge / `{thread}` | none |
+
+Actual HTTP label names are `http.request.method`, `http.route`,
+`http.response.status_code`, `response.outcome`, `error.type`. Outcomes: `completed`,
+`cancelled`, `disconnected`, `error`. Error types: `timeout`, `cancelled`,
+`connection_error`, `internal_error`. Other instruments use `dependency`, `operation`,
+`status`, `state` as listed. Unknown methods become `_OTHER`; an unresolved route becomes
+`__unresolved__`. Raw URL paths and request/trace/user/document IDs are never metric labels.
+
+All duration histograms have finite boundaries in seconds:
+`.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 30, 60, 120, 300`, then +Inf.
+
+## Measurement boundaries
+
+- Server: ASGI application entry to return/exception, including streaming and application
+  background work. One measurement per HTTP invocation. Final status is captured only after
+  response-start is successfully sent. Informational 1xx messages do not finish or add
+  requests. Cancellation before headers has no invented status. Runtime/proxy failures
+  outside the ASGI application require platform telemetry; WebSockets are not HTTP requests.
+- Client: transport request start to response headers or transport error. Response stream
+  consumption is outside this initial client duration/span. Explicitly name dependencies;
+  neither destinations nor query strings become telemetry attributes.
+- SQL: cursor execution start to success or error. Does not include acquiring a connection,
+  fetching streamed results or transaction duration. Pool counters cover QueuePool and its
+  async variant, not NullPool or external poolers. Replacing an engine's pool requires
+  reinstrumenting a new engine; process memory is peak RSS, not current heap usage.
+- Local process signals target the macOS/Linux runtimes used by 021. They do not claim
+  container-wide saturation, external database capacity or platform-wide health.
+- HTTP request/span resource identity and structured context are library-generated.
+  Domain callers are responsible for using static instrument names and safe approved fields.
+
+## Migration mapping (consumer PRs)
+
+| Current signal | New signal / change |
+| --- | --- |
+| API `http_requests_total` | `http.server.request.count`; normalized route; real final response |
+| API `http_request_duration_seconds` | `http.server.request.duration`; full ASGI duration and longer buckets |
+| API Prometheus business helpers | `app.operation.*` / explicit `app.*`; operation and result remain separate |
+| Brain request count/duration | middleware observes errors and streaming as well as successful handlers |
+| Brain histograms without units | durations use seconds; convert existing millisecond observations |
+| Existing structlog setup | one common stdout JSON configuration; raw exception strings removed |
+| Existing `/health` / `/ready` | opt-in migration after checking monitors and auth exemptions |
+
+OpenTelemetry backends may translate dotted names to Prometheus-style names and suffixes.
+Validate actual ingestion names/queries in staging before changing dashboards or retiring
+`/metrics`. The package does not create dashboards, alerting, auth, quotas or business logic.
+Logs stay in Vercel; internal agent traces and LLM token/cost instrumentation remain excluded.
+
+## Safe log diagnostics
+
+Domain correlation in logs accepts only UUID objects/strings for `brain_id`, `job_id`,
+`file_id`, `file_version_id`, `entity_id`, `event_id` and `correlation_id`. Values are
+normalized into JSON and `message`; invalid values are dropped. The metric attribute
+allowlist is unchanged and excludes these IDs.
+
+When `exc_info` supplies an exception (instance, tuple or `True` inside an exception
+handler), the formatter derives `error_type` and `exception` entries with `type`,
+`frames` (`file` basename, `function`, `line`) and `frames_truncated`. It follows at most
+8 causes/unsuppressed contexts and retains the nearest 32 frames per exception; cycles
+and longer chains set `exception_truncated`. Exception-group members are not expanded.
+Type/function names are limited to 128 characters and basenames to 256. No exception
+message, notes, source lines, locals, absolute directories or arbitrary diagnostic extras
+are emitted. This applies to structlog, stdlib and Uvicorn, including unhandled ASGI
+failure logs. Existing explicitly supplied `error_type` is retained only when there is
+no actual exception to derive it from. No traceback metadata is added to spans/metrics.
+
+## Probes and correlation
+
+Both routes stay public and registered after adoption:
+
+| Route / result | HTTP | JSON |
+| --- | --- | --- |
+| `/health`, process alive | 200 | `{"status":"ok"}` |
+| `/ready`, all declared checks succeed | 200 | `{"status":"ok","checks":{"database":"ok"}}` |
+| `/ready`, any check fails or times out | 503 | `{"status":"unavailable","checks":{"database":"unavailable"}}` |
+
+The check names above are examples; each consumer declares its dependencies. A timed-out
+check is `timeout`. `/ready` never returns `status: ready`. Dependency monitors must use
+its HTTP status; `/health` remains 200 when a dependency is down. A consumer that accepts
+disabled adapters as available must verify its intended provider configuration separately.
+
+Inbound UUID request IDs are preserved; missing or invalid IDs are replaced and echoed in
+the response. Correlate using that returned value. `http_request(..., headers=...)` mutates
+the supplied headers, replaces W3C trace context case-insensitively and propagates the
+current validated request ID. The Vercel extra is required for post-response export there.
+
+## Consumer adapters
+
+The optional `prometheus` extra and `setup_observability(..., prometheus=True)` add a
+Prometheus reader over the same instruments; `obs.prometheus_latest()` exposes its private
+registry. No process-global Prometheus registry or duplicate observations are introduced.
+
+`increment`/`observe` accept approved static domain `attributes`: event, code, scope,
+permission, action, reason, mode, channel, provider, dry_run and error_type. Unknown keys
+(including IDs) are omitted; operation and status remain distinct. Callers must use static
+values, not user-provided labels. `observe` defaults to seconds; unit `1` supports existing
+scalar distributions and `USD` preserves existing cost observations. Units cannot change
+for an existing instrument. Only duration instruments use the duration buckets.
+
+`obs.http_request(method=..., dependency=..., headers=...)` observes a service-owned HTTP
+call; set its yielded attributes' `http.response.status_code` on success. Wrapping the
+complete HTTPX request also includes reading its body. Transport adapters retain their
+headers-only boundary. Do not combine the two around the same HTTP request.

021_python_observability-0.3.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.