plumbline-sdk 0.1.0__tar.gz

plumbline_sdk-0.1.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.

plumbline_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: plumbline-sdk
+Version: 0.1.0
+Summary: One-line evidence telemetry for AI products: sends model-call facts (never content) to the local Plumbline agent.
+Author: Lumetrix
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Lumetrix-Advanced-Technologies/plumbline
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# plumbline-sdk (Python SDK)
+
+One line to send evidence telemetry from an AI product to the local Plumbline evidence agent.
+
+```bash
+pip install plumbline-sdk
+```
+
+```python
+import plumbline
+plumbline.init()
+```
+
+The SDK records one span per model call with provider, model, region, token counts, operation, timing and error status, and sends it as OTLP JSON to the agent on `http://127.0.0.1:4318` (or `PLUMBLINE_AGENT_URL`). The agent aggregates per hour and signs the aggregates: it keeps them in a local evidence log (`plumbline-agent local`) or sends them to Plumbline (`plumbline-agent connect`). **The SDK never reads prompts, completions, function arguments, return values or exception messages**, so there is no content to filter.
+
+- No dependencies: standard library only, Python 3.10+.
+- Never slows or breaks the app: spans go to a bounded background buffer; when it is full, spans are dropped and counted (`plumbline.stats()`). SDK errors are swallowed and counted.
+- `PLUMBLINE_DISABLED=1` turns it off. `init()` is safe to call more than once.
+- Proxies are never used: the agent is local.
+- Works across threads, `asyncio` tasks and forked workers (gunicorn, uWSGI).
+
+## Automatic instrumentation
+
+`init()` instruments the client libraries that are installed. Nothing to configure:
+
+| Library | Calls |
+| --- | --- |
+| `openai` | `chat.completions.create` / `parse` / `stream`, `responses.create` / `parse` / `stream`, `embeddings.create`, `completions.create`; sync, async, streaming. Azure OpenAI is reported as `azure.ai.openai`; other OpenAI-compatible endpoints by their host name. |
+| `anthropic` | `messages.create` and `messages.stream` (and `beta.messages`); sync, async, streaming. `AnthropicBedrock` and `AnthropicVertex` are reported as `aws.bedrock` and `gcp.vertex_ai` with their region. |
+| `boto3` (Bedrock Runtime) | `converse`, `converse_stream`, `invoke_model`, `invoke_model_with_response_stream` |
+
+Per call it reads the request's model and stream flag, and from the response only the model, the usage block, the stop reason and Bedrock's token-count headers. Input tokens follow what the provider bills (Anthropic: uncached + cache writes + cache reads; Bedrock: `inputTokens`, as CloudWatch counts them), so Plumbline can reconcile traced against billed tokens.
+
+Things to know:
+
+- **Streams** are recorded when they end, are closed, or leave a `with` block, once, with the usage they reported. A stream dropped half-read is recorded on the next call or flush.
+- **OpenAI streamed chat completions** report usage only if asked. `plumbline.init(stream_usage=True)` sets `stream_options={"include_usage": True}` when the app has not set it; the stream then ends with one extra chunk with no `choices`. Off by default, so the app's streams are unchanged.
+- **Bedrock guardrails**: a Converse call with `guardrailConfig` is a guarded call, `block` when the stop reason is `guardrail_intervened`, else `allow`.
+- `invoke_model_with_response_stream` reports its token counts only inside the streamed body, which the SDK never reads, so those calls are counted without tokens. `with_raw_response` calls are counted without tokens too.
+- `plumbline.init(instrument=False)` turns automatic instrumentation off; the helpers still work.
+
+## What the helpers record
+
+Plumbline's evidence objectives need a few facts that no LLM client knows. Each helper is a context manager (`with` or `async with`) and a decorator.
+
+| Helper | Records |
+| --- | --- |
+| `plumbline.prompt(name, version)` | the prompt (name and version, never its text) used by calls inside |
+| `plumbline.personal_data(redacted=False)` | spans inside handle personal data; `redacted` says it was removed or masked before the model saw it |
+| `plumbline.guardrail(decision=None)` | the guardrail decision (`allow`, `block`, `flag`) for calls inside; set it later with `g.allow()`, `g.block()`, `g.flag()` |
+| `plumbline.tool(name, high_impact=False, approved=False)` | a tool call; failures inside mark it failed; set `t.approved = True` once approved |
+| `plumbline.agent_run(name)` | one agent run; model changes are tracked per agent |
+| `plumbline.escalation()` | the request was handed to a person |
+| `plumbline.trace()` | groups everything inside into one trace (for example one web request) |
+| `plumbline.llm_call(provider, model, operation="chat", region=None)` | a model call the SDK does not instrument; report usage with `c.usage(input_tokens, output_tokens)` |
+
+```python
+with plumbline.trace(), plumbline.prompt("claims-triage", "14"), plumbline.personal_data(redacted=True):
+    with plumbline.guardrail() as g:
+        if not input_policy_ok(request):
+            g.block()          # recorded as one blocked call; the model was never called
+            return refusal()
+        with plumbline.llm_call("openai", "gpt-4.1-mini", region="us-east-1") as c:
+            r = client.chat.completions.create(...)
+            c.usage(r.usage.prompt_tokens, r.usage.completion_tokens)
+        g.flag() if needs_review(r) else g.allow()
+
+@plumbline.tool("issue_refund", high_impact=True)
+def issue_refund(claim): ...
+```
+
+Names and versions are capped at 128 characters; anything that is not a string or an integer is ignored.
+
+Calls inside a `guardrail` scope are held until the scope ends, so a decision made after the call (an output check) still applies. A `block` with no call inside counts as one blocked call; pass `provider=` and `model=` to attribute it.
+
+## Already on OpenTelemetry?
+
+You can skip the SDK: point an OTLP/HTTP **JSON** exporter at the agent (`http://127.0.0.1:4318/v1/traces`) and set the `plumbline.*` attributes yourself (`spec/semconv-map.json`). Do not run both for the same calls, or they are counted twice.
+
+## Development
+
+```bash
+python3 -m unittest discover -s sdk/python/tests
+python3 sdk/python/tests/scenario.py   # rewrite sdk/testdata/python-export.jsonl
+```

plumbline_sdk-0.1.0/README.md

@@ -0,0 +1,85 @@
+# plumbline-sdk (Python SDK)
+
+One line to send evidence telemetry from an AI product to the local Plumbline evidence agent.
+
+```bash
+pip install plumbline-sdk
+```
+
+```python
+import plumbline
+plumbline.init()
+```
+
+The SDK records one span per model call with provider, model, region, token counts, operation, timing and error status, and sends it as OTLP JSON to the agent on `http://127.0.0.1:4318` (or `PLUMBLINE_AGENT_URL`). The agent aggregates per hour and signs the aggregates: it keeps them in a local evidence log (`plumbline-agent local`) or sends them to Plumbline (`plumbline-agent connect`). **The SDK never reads prompts, completions, function arguments, return values or exception messages**, so there is no content to filter.
+
+- No dependencies: standard library only, Python 3.10+.
+- Never slows or breaks the app: spans go to a bounded background buffer; when it is full, spans are dropped and counted (`plumbline.stats()`). SDK errors are swallowed and counted.
+- `PLUMBLINE_DISABLED=1` turns it off. `init()` is safe to call more than once.
+- Proxies are never used: the agent is local.
+- Works across threads, `asyncio` tasks and forked workers (gunicorn, uWSGI).
+
+## Automatic instrumentation
+
+`init()` instruments the client libraries that are installed. Nothing to configure:
+
+| Library | Calls |
+| --- | --- |
+| `openai` | `chat.completions.create` / `parse` / `stream`, `responses.create` / `parse` / `stream`, `embeddings.create`, `completions.create`; sync, async, streaming. Azure OpenAI is reported as `azure.ai.openai`; other OpenAI-compatible endpoints by their host name. |
+| `anthropic` | `messages.create` and `messages.stream` (and `beta.messages`); sync, async, streaming. `AnthropicBedrock` and `AnthropicVertex` are reported as `aws.bedrock` and `gcp.vertex_ai` with their region. |
+| `boto3` (Bedrock Runtime) | `converse`, `converse_stream`, `invoke_model`, `invoke_model_with_response_stream` |
+
+Per call it reads the request's model and stream flag, and from the response only the model, the usage block, the stop reason and Bedrock's token-count headers. Input tokens follow what the provider bills (Anthropic: uncached + cache writes + cache reads; Bedrock: `inputTokens`, as CloudWatch counts them), so Plumbline can reconcile traced against billed tokens.
+
+Things to know:
+
+- **Streams** are recorded when they end, are closed, or leave a `with` block, once, with the usage they reported. A stream dropped half-read is recorded on the next call or flush.
+- **OpenAI streamed chat completions** report usage only if asked. `plumbline.init(stream_usage=True)` sets `stream_options={"include_usage": True}` when the app has not set it; the stream then ends with one extra chunk with no `choices`. Off by default, so the app's streams are unchanged.
+- **Bedrock guardrails**: a Converse call with `guardrailConfig` is a guarded call, `block` when the stop reason is `guardrail_intervened`, else `allow`.
+- `invoke_model_with_response_stream` reports its token counts only inside the streamed body, which the SDK never reads, so those calls are counted without tokens. `with_raw_response` calls are counted without tokens too.
+- `plumbline.init(instrument=False)` turns automatic instrumentation off; the helpers still work.
+
+## What the helpers record
+
+Plumbline's evidence objectives need a few facts that no LLM client knows. Each helper is a context manager (`with` or `async with`) and a decorator.
+
+| Helper | Records |
+| --- | --- |
+| `plumbline.prompt(name, version)` | the prompt (name and version, never its text) used by calls inside |
+| `plumbline.personal_data(redacted=False)` | spans inside handle personal data; `redacted` says it was removed or masked before the model saw it |
+| `plumbline.guardrail(decision=None)` | the guardrail decision (`allow`, `block`, `flag`) for calls inside; set it later with `g.allow()`, `g.block()`, `g.flag()` |
+| `plumbline.tool(name, high_impact=False, approved=False)` | a tool call; failures inside mark it failed; set `t.approved = True` once approved |
+| `plumbline.agent_run(name)` | one agent run; model changes are tracked per agent |
+| `plumbline.escalation()` | the request was handed to a person |
+| `plumbline.trace()` | groups everything inside into one trace (for example one web request) |
+| `plumbline.llm_call(provider, model, operation="chat", region=None)` | a model call the SDK does not instrument; report usage with `c.usage(input_tokens, output_tokens)` |
+
+```python
+with plumbline.trace(), plumbline.prompt("claims-triage", "14"), plumbline.personal_data(redacted=True):
+    with plumbline.guardrail() as g:
+        if not input_policy_ok(request):
+            g.block()          # recorded as one blocked call; the model was never called
+            return refusal()
+        with plumbline.llm_call("openai", "gpt-4.1-mini", region="us-east-1") as c:
+            r = client.chat.completions.create(...)
+            c.usage(r.usage.prompt_tokens, r.usage.completion_tokens)
+        g.flag() if needs_review(r) else g.allow()
+
+@plumbline.tool("issue_refund", high_impact=True)
+def issue_refund(claim): ...
+```
+
+Names and versions are capped at 128 characters; anything that is not a string or an integer is ignored.
+
+Calls inside a `guardrail` scope are held until the scope ends, so a decision made after the call (an output check) still applies. A `block` with no call inside counts as one blocked call; pass `provider=` and `model=` to attribute it.
+
+## Already on OpenTelemetry?
+
+You can skip the SDK: point an OTLP/HTTP **JSON** exporter at the agent (`http://127.0.0.1:4318/v1/traces`) and set the `plumbline.*` attributes yourself (`spec/semconv-map.json`). Do not run both for the same calls, or they are counted twice.
+
+## Development
+
+```bash
+python3 -m unittest discover -s sdk/python/tests
+python3 sdk/python/tests/scenario.py   # rewrite sdk/testdata/python-export.jsonl
+```

plumbline_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "plumbline-sdk"
+version = "0.1.0"
+description = "One-line evidence telemetry for AI products: sends model-call facts (never content) to the local Plumbline agent."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Lumetrix" }]
+dependencies = []
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/Lumetrix-Advanced-Technologies/plumbline"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+plumbline = ["py.typed"]

plumbline_sdk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

plumbline_sdk-0.1.0/src/plumbline/__init__.py

@@ -0,0 +1,118 @@
+"""Plumbline SDK: one line to send evidence telemetry to the local Plumbline agent.
+
+    import plumbline
+    plumbline.init()
+
+Spans go as OTLP JSON to the agent (http://127.0.0.1:4318, or
+PLUMBLINE_AGENT_URL). They carry provider, model, region, token counts,
+operation, timing, error status and the helper attributes below; never
+prompts, completions, function arguments or exception messages. The SDK has no
+dependencies, never blocks a request (a full buffer drops spans and counts
+them) and never raises into the app. PLUMBLINE_DISABLED=1 turns it off.
+"""
+
+from __future__ import annotations
+
+import atexit
+import os
+import sys
+import threading
+
+from . import _core, _instrument, _otlp
+from ._core import (Guardrail, agent_run, escalation, guardrail, llm_call, personal_data, prompt, tool,
+                    trace)
+from ._export import Exporter, Transport, http_transport
+
+__version__ = "0.1.0"
+__all__ = ["init", "shutdown", "flush", "stats", "is_enabled", "trace", "prompt", "guardrail", "Guardrail",
+           "personal_data", "tool", "escalation", "agent_run", "llm_call", "__version__"]
+
+DEFAULT_AGENT_URL = "http://127.0.0.1:4318"
+_lock = threading.Lock()
+_atexit = False
+_instrumented: list[str] = []
+
+
+def _resource(service: str | None, environment: str | None) -> dict:
+    name = service or os.environ.get("PLUMBLINE_SERVICE") or os.environ.get("OTEL_SERVICE_NAME")
+    if not name:
+        prog = os.path.basename(sys.argv[0]) if sys.argv and sys.argv[0] else "python"
+        name = f"unknown_service:{prog}"
+    r = {"service.name": name[:_core.MAX_VALUE], "telemetry.sdk.name": "plumbline",
+         "telemetry.sdk.language": "python", "telemetry.sdk.version": __version__}
+    env = environment or os.environ.get("PLUMBLINE_ENVIRONMENT")
+    if env:
+        r["deployment.environment.name"] = env[:_core.MAX_VALUE]
+    return r
+
+
+def init(agent_url: str | None = None, service: str | None = None, *, environment: str | None = None,
+         instrument: bool = True, stream_usage: bool = False, transport: Transport | None = None) -> bool:
+    """Start the SDK and instrument the installed LLM clients (OpenAI,
+    Anthropic, Bedrock via boto3). Safe to call more than once; returns
+    whether it is on.
+
+    stream_usage: ask OpenAI for usage on streamed chat completions
+    (stream_options.include_usage) when the app has not set stream_options.
+    The stream then ends with one extra chunk that has no choices; leave it
+    off if the app indexes choices[0] on every chunk.
+    """
+    global _atexit, _instrumented
+    with _lock:
+        if _core.current_client().enabled:
+            return True
+        if os.environ.get("PLUMBLINE_DISABLED", "").strip().lower() in ("1", "true", "yes"):
+            return False
+        try:
+            url = (agent_url or os.environ.get("PLUMBLINE_AGENT_URL") or DEFAULT_AGENT_URL).rstrip("/")
+            resource = _resource(service, environment)
+            exporter = Exporter(transport or http_transport(url + "/v1/traces"),
+                                lambda spans: _otlp.encode(spans, resource, __version__))
+            _core.set_client(_core.Client(exporter, service=resource["service.name"]))
+            _instrumented = _instrument.install(stream_usage) if instrument else []
+            if not _atexit:
+                atexit.register(shutdown)
+                _atexit = True
+        except Exception:
+            _core.log.debug("plumbline: init failed; the SDK stays off", exc_info=True)
+            return False
+        return True
+
+
+def flush(timeout: float = 2.0) -> bool:
+    """Send buffered spans now; True when everything was handed to the agent."""
+    c = _core.current_client()
+    if c.exporter is None:
+        return True
+    try:
+        _core.run_later()
+        return c.exporter.flush(timeout)
+    except Exception:
+        return False
+
+
+def shutdown(timeout: float = 2.0) -> bool:
+    """Flush and stop. Registered at exit; later spans are not recorded."""
+    with _lock:
+        c = _core.current_client()
+        _core.set_client(_core.Client())
+    if c.exporter is None:
+        return True
+    try:
+        return c.exporter.shutdown(timeout)
+    except Exception:
+        return False
+
+
+def is_enabled() -> bool:
+    return _core.current_client().enabled
+
+
+def stats() -> dict:
+    """Counters for health checks: spans recorded, exported, dropped, failed exports
+    and swallowed instrumentation errors."""
+    c = _core.current_client()
+    e = c.exporter
+    return {"enabled": c.enabled, "spans": c.stats.spans, "instrumentation_errors": c.stats.instrumentation_errors,
+            "exported": e.exported if e else 0, "dropped": e.dropped if e else 0,
+            "export_errors": e.export_errors if e else 0, "instrumented": list(_instrumented) if c.enabled else []}