Add core OpenTelemetry instrumentation for Haystack 3.0

Author: srinjoy356

.gitattributes

@@ -0,0 +1 @@
+*.sh text eol=lf

.gitignore

@@ -79,3 +79,7 @@ MIGRATION_REPORT.md
 # dev sample projects
 dev/uv.lock
 
+# Local secrets (never commit)
+.env
+.env.*
+!.env.example

dev-requirements.txt

@@ -1,7 +1,7 @@
 pyright==1.1.411
-sphinx==9.1.0
-sphinx-rtd-theme==3.1.0
-sphinx-autodoc-typehints==3.12.1
+sphinx<9.0.0
+sphinx-rtd-theme
+sphinx-autodoc-typehints
 pytest==9.1.1
 pytest-cov==7.1.0
 readme-renderer==45.0

docs-requirements.txt

@@ -1,6 +1,6 @@
-sphinx==9.1.0
-sphinx-rtd-theme==3.1.0
-sphinx-autodoc-typehints==3.12.1
+sphinx<9.0.0
+sphinx-rtd-theme
+sphinx-autodoc-typehints
 
 # Required by opentelemetry-util-genai
 fsspec>=2026.7.0

instrumentation/opentelemetry-instrumentation-genai-haystack/.changelog/.gitignore

@@ -0,0 +1 @@
+!.gitignore

instrumentation/opentelemetry-instrumentation-genai-haystack/.changelog/318.added

@@ -0,0 +1 @@
+Add ``opentelemetry-instrumentation-genai-haystack``, migrated from ``openinference-instrumentation-haystack``, with support for pipeline, chat/embedding/retrieval, agent, and tool invocations built on ``opentelemetry-util-genai``.

instrumentation/opentelemetry-instrumentation-genai-haystack/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 Support. 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 The OpenTelemetry Authors
+
+   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.
+

instrumentation/opentelemetry-instrumentation-genai-haystack/README.rst

@@ -0,0 +1,104 @@
+OpenTelemetry Haystack Instrumentation
+=======================================
+
+|pypi|
+
+.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-genai-haystack.svg
+   :target: https://pypi.org/project/opentelemetry-instrumentation-genai-haystack/
+
+This library allows tracing GenAI operations performed with the
+`Haystack <https://haystack.deepset.ai/>`_ Python framework: LLM generator calls and embedder calls.
+
+Installation
+------------
+
+::
+
+    pip install opentelemetry-instrumentation-genai-haystack
+
+Usage
+-----
+
+.. code-block:: python
+
+    from opentelemetry.instrumentation.genai.haystack import HaystackInstrumentor
+
+    # Instrument Haystack
+    HaystackInstrumentor().instrument()
+
+
+What gets instrumented
+***********************
+
+- Components classified as a generator, embedder, or embedder -- one span per component ``run`` / ``run_async`` call.
+  Classification is a best-effort read of the component's class name and
+  ``run`` method type hints, since Haystack has no static component-kind
+  marker. Components that don't fall into one of these (prompt builders,
+  routers, converters, ...) are not wrapped: ``opentelemetry-util-genai``
+  has no invocation type for a generic pipeline step. Component classes are
+  classified the instant they're registered (hooking the ``@component``
+  decorator itself), so instrumenting before importing your pipeline's
+  components works correctly.
+
+See ``tests/conformance/`` for the exact operations covered.
+
+Known limitations
+*****************
+
+- ``gen_ai.response.id`` is not populated for real OpenAI-backed chat
+  generators: Haystack's own ``OpenAIChatGenerator`` does not copy the
+  provider response id into the reply's ``meta``, so it's only populated for
+  generators (or tests) that do include it there.
+- ``server.address`` / ``server.port`` are only populated once a component's
+  underlying SDK client has been constructed. ``Pipeline.run()`` calls
+  ``warm_up()`` automatically, so this is available for pipeline-driven
+  calls; a component called standalone only gets it starting on its second
+  call, since nothing else triggers ``warm_up()`` first.
+- ``gen_ai.provider.name`` has no mapping for Hugging Face API
+  generators/embedders (their model string encodes the provider, but there's
+  no corresponding enum value yet); it's set to ``"unknown"`` for these.
+- Only components classified as a generator, embedder, or embedder are wrapped -- there's no ``opentelemetry-util-genai`` invocation
+  type for a generic pipeline step (prompt builders, routers, converters,
+  joiners, ...).
+- Per-document embedded text/vectors aren't recorded -- ``EmbeddingInvocation``
+  only carries aggregate request/response metadata.
+
+Configuration
+-------------
+
+Capture Message Content
+***********************
+
+By default, prompts and completions are not captured. To capture message content, set the
+environment variable ``OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT`` to one of
+``NO_CONTENT``, ``SPAN_ONLY``, ``EVENT_ONLY``, or ``SPAN_AND_EVENT``:
+
+::
+
+    export OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=SPAN_AND_EVENT
+
+
+Uploading prompts and completions
+***********************************
+
+Instead of recording message content inline, prompts and completions can be uploaded to external
+storage via a completion hook. To enable the built-in upload hook, set:
+
+- ``OTEL_INSTRUMENTATION_GENAI_COMPLETION_HOOK=upload``
+- ``OTEL_INSTRUMENTATION_GENAI_UPLOAD_BASE_PATH`` to an ``fsspec``-compatible URI/path
+  (e.g. ``/path/to/prompts`` or ``gs://my_bucket``), and install the ``upload`` extra
+  (``pip install opentelemetry-util-genai[upload]``).
+
+A custom ``CompletionHook`` can also be passed programmatically, taking precedence over the
+environment variable::
+
+    HaystackInstrumentor().instrument(completion_hook=my_hook)
+
+
+References
+----------
+
+* `OpenTelemetry Project <https://opentelemetry.io/>`_
+* `OpenTelemetry GenAI semantic conventions <https://opentelemetry.io/docs/specs/semconv/gen-ai/>`_
+* `Haystack <https://haystack.deepset.ai/>`_
+* `Haystack documentation <https://docs.haystack.deepset.ai/>`_

instrumentation/opentelemetry-instrumentation-genai-haystack/examples/manual/main.py

@@ -0,0 +1,40 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+import os
+
+from haystack.components.generators.chat.openai import OpenAIChatGenerator
+from haystack.dataclasses import ChatMessage
+
+from opentelemetry import trace
+from opentelemetry.instrumentation.genai.haystack import HaystackInstrumentor
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import (
+    ConsoleSpanExporter,
+    SimpleSpanProcessor,
+)
+
+# 1. Setup OpenTelemetry
+provider = TracerProvider()
+provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter()))
+trace.set_tracer_provider(provider)
+
+# 2. Instrument Haystack
+# Set OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=True to capture message content
+os.environ["OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"] = "True"
+HaystackInstrumentor().instrument()
+
+
+# 3. Use Haystack
+def main():
+    generator = OpenAIChatGenerator(model="gpt-4o-mini")
+    messages = [
+        ChatMessage.from_user("Tell me a quick joke about observability.")
+    ]
+    response = generator.run(messages=messages)
+    print("\nResponse:")
+    print(response["replies"][0].text)
+
+
+if __name__ == "__main__":
+    main()