Build instrumentation-genai/README.md #3400
Conversation
github-actions
bot
assigned alizenhom, codefromthecrypt, gyliu513, karthikscale3, lmolkova, lzchen and nirga
github-actions
bot
requested review from
alizenhom,
codefromthecrypt,
gyliu513,
karthikscale3,
lmolkova,
lzchen and
nirga
...entelemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/package.py
Show resolved
Hide resolved
| @@ -0,0 +1,6 @@ | |||
|
|
|||
| | Instrumentation | Supported Packages | Metrics support | Semconv status | | |||
There was a problem hiding this comment.
I'm curious why only one signal type "Metrics" is listed there. Would it make sense to list all of the signal types?
There was a problem hiding this comment.
This is the same format as the other instrumentations, no idea what the original intent but here we are just running the same thing on another dir.
|
|
||
| | Instrumentation | Supported Packages | Metrics support | Semconv status | | ||
| | --------------- | ------------------ | --------------- | -------------- | | ||
| | [opentelemetry-instrumentation-google-genai](./opentelemetry-instrumentation-google-genai) | google-genai >= 1.0.0 | No | development |
There was a problem hiding this comment.
It's not correct that the google-genai instrumentation does not include metrics. That code emits client metrics for Gen AI. See:
There was a problem hiding this comment.
Sorry, care to update package.py like I did for openai ? It would be faster to have me approve and merge :)
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| _instruments = ("google-genai >= 1.0.0",) |
There was a problem hiding this comment.
There now appear to be multiple places where this information exists:
Is there a way to have a single source of truth for this information?
For example, can instrumentor.py be updated to load the value from package.py? Can the optional dependency in pyproject.toml somehow dynamically reference this value? Or is there some other way to keep these in sync?
There was a problem hiding this comment.
There is probably a way in hatch so use a dynamic value, maybe https://hatch.pypa.io/1.13/how-to/config/dynamic-metadata/
| root_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) | ||
| base_instrumentation_path = os.path.join(root_path, "instrumentation") | ||
|
|
||
| def main(base_instrumentation_path): |
There was a problem hiding this comment.
Do the package.py files exist solely for the purpose of supporting this?
If so, I'm wondering if it might sense to use some other data format (e.g. metadata.yaml or something else) that will make it more obvious that it is not part of the instrumentation package and just information about the instrumentation package that is used for this kind of purpose.
There was a problem hiding this comment.
It's used by most of the Instrumentor classes to implement instrumentation_dependencies and so used to catch dependency conflicts.
There was a problem hiding this comment.
@michaelsafyan also used by instrumentors.
Description
Build instrumentation-genai/README.md as we do for common instrumentations
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.