Release 0.0.1.dev0

Author: aabmass

instrumentation-genai/opentelemetry-instrumentation-google-genai/.gitignore

@@ -6,74 +6,10 @@ OpenTelemetry Google GenAI SDK Instrumentation
 .. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-google-genai.svg
    :target: https://pypi.org/project/opentelemetry-instrumentation-google-genai/
 
-This library adds instrumentation to the `Google GenAI SDK library <https://pypi.org/project/google-genai/>`_
-to emit telemetry data following `Semantic Conventions for GenAI systems <https://opentelemetry.io/docs/specs/semconv/gen-ai/>`_. 
-It adds trace spans for GenAI operations, events/logs for recording prompts/responses, and emits metrics that describe the
-GenAI operations in aggregate.
+This library is a work in progress and is not ready to use. Follow along at
+https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3260.
 
 
-Installation
-------------
-
-If your application is already instrumented with OpenTelemetry, add this
-package to your requirements.
-::
-
-    pip install opentelemetry-instrumentation-google-genai
-
-If you don't have a Google GenAI SDK application, yet, try our `examples <examples>`_.
-
-Check out `zero-code example <examples/zero-code>`_ for a quick start.
-
-Usage
------
-
-This section describes how to set up Google GenAI SDK instrumentation if you're setting OpenTelemetry up manually.
-Check out the `manual example <examples/manual>`_ for more details.
-
-Instrumenting all clients
-*************************
-
-When using the instrumentor, all clients will automatically trace GenAI `generate_content` operations.
-You can also optionally capture prompts and responses as log events.
-
-Make sure to configure OpenTelemetry tracing, logging, metrics, and events to capture all telemetry emitted by the instrumentation.
-
-.. code-block:: python
-
-    from opentelemetry.instrumentation.google_genai import GoogleGenAiSdkInstrumentor
-    from google.genai import Client
-
-    GoogleGenAiSdkInstrumentor().instrument()
-
-
-    client = Client()
-    response = client.models.generate_content(
-        model="gemini-1.5-flash-002",
-        contents="Write a short poem on OpenTelemetry.")
-
-Enabling message content
-*************************
-
-Message content such as the contents of the prompt and response
-are not captured by default. To capture message content as log events, set the environment variable
-`OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` to `true`.
-
-Uninstrument
-************
-
-To uninstrument clients, call the uninstrument method:
-
-.. code-block:: python
-
-    from opentelemetry.instrumentation.google_genai import GoogleGenAiSdkInstrumentor
-
-    GoogleGenAiSdkInstrumentor().instrument()
-    # ...
-
-    # Uninstrument all clients
-    GoogleGenAiSdkInstrumentor().uninstrument()
-
 References
 ----------
 * `Google Gen AI SDK Documentation <https://ai.google.dev/gemini-api/docs/sdks>`_

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

@@ -2,8 +2,7 @@
 #
 # 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
-#
+# 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
@@ -34,18 +33,16 @@ classifiers = [
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12"
+  "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
   "opentelemetry-api >=1.30.0, <2",
   "opentelemetry-instrumentation >=0.51b0, <2",
-  "opentelemetry-semantic-conventions >=0.51b0, <2"
+  "opentelemetry-semantic-conventions >=0.51b0, <2",
 ]
 
 [project.optional-dependencies]
-instruments = [
-    "google-genai >= 1.0.0"
-]
+instruments = ["google-genai >= 1.0.0"]
 
 [project.entry-points.opentelemetry_instrumentor]
 google-genai = "opentelemetry.instrumentation.google_genai:GoogleGenAiSdkInstrumentor"
@@ -58,10 +55,7 @@ Repository = "https://github.com/open-telemetry/opentelemetry-python-contrib"
 path = "src/opentelemetry/instrumentation/google_genai/version.py"
 
 [tool.hatch.build.targets.sdist]
-include = [
-  "/src",
-  "/tests",
-]
+include = ["/src"]
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]