mseep-agentops 0.4.18__py3-none-any.whl → 0.4.22__py3-none-any.whl

agentops/instrumentation/agentic/crewai/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2023 openllmetry
+
+   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. 

agentops/instrumentation/agentic/crewai/NOTICE.md

@@ -0,0 +1,10 @@
+This package contains code derived from the OpenLLMetry project, which is licensed under the Apache License, Version 2.0.
+
+Original repository: https://github.com/traceloop/openllmetry
+
+Copyright notice from the original project:
+Copyright (c) Traceloop (https://traceloop.com)
+
+The Apache 2.0 license can be found in the LICENSE file in this directory.
+
+This code has been modified and adapted for use in the AgentOps project. 

agentops/instrumentation/agentic/crewai/__init__.py

@@ -0,0 +1,6 @@
+"""OpenTelemetry CrewAI instrumentation"""
+
+from agentops.instrumentation.agentic.crewai.version import __version__
+from agentops.instrumentation.agentic.crewai.instrumentation import CrewaiInstrumentor
+
+__all__ = ["CrewaiInstrumentor", "__version__"]

agentops/instrumentation/agentic/crewai/crewai_span_attributes.py

@@ -0,0 +1,335 @@
+"""OpenTelemetry instrumentation for CrewAI."""
+
+import json
+import logging
+from typing import Any
+from opentelemetry.trace import Span
+
+from agentops.semconv.span_attributes import SpanAttributes
+from agentops.semconv.agent import AgentAttributes
+from agentops.semconv.message import MessageAttributes
+
+# Initialize logger for logging potential issues and operations
+logger = logging.getLogger(__name__)
+
+
+def _parse_tools(tools):
+    """Parse tools into a JSON string with name and description."""
+    result = []
+    for tool in tools:
+        res = {}
+        if hasattr(tool, "name") and tool.name is not None:
+            res["name"] = tool.name
+        if hasattr(tool, "description") and tool.description is not None:
+            res["description"] = tool.description
+        if res:
+            result.append(res)
+    return result
+
+
+def set_span_attribute(span: Span, key: str, value: Any) -> None:
+    """Set a single attribute on a span."""
+    if value is not None and value != "":
+        if hasattr(value, "__str__"):
+            value = str(value)
+        span.set_attribute(key, value)
+
+
+class CrewAISpanAttributes:
+    """Manages span attributes for CrewAI instrumentation."""
+
+    def __init__(self, span: Span, instance, skip_agent_processing=False) -> None:
+        self.span = span
+        self.instance = instance
+        self.skip_agent_processing = skip_agent_processing
+        self.process_instance()
+
+    def process_instance(self):
+        """Process the instance based on its type."""
+        instance_type = self.instance.__class__.__name__
+        self._set_attribute(SpanAttributes.LLM_SYSTEM, "crewai")
+        self._set_attribute(SpanAttributes.AGENTOPS_ENTITY_NAME, instance_type)
+
+        method_mapping = {
+            "Crew": self._process_crew,
+            "Agent": self._process_agent,
+            "Task": self._process_task,
+            "LLM": self._process_llm,
+        }
+        method = method_mapping.get(instance_type)
+        if method:
+            method()
+
+    def _process_crew(self):
+        """Process a Crew instance."""
+        crew_id = getattr(self.instance, "id", "")
+        self._set_attribute("crewai.crew.id", str(crew_id))
+        self._set_attribute("crewai.crew.type", "crewai.crew")
+        self._set_attribute(SpanAttributes.AGENTOPS_SPAN_KIND, "workflow")
+
+        logger.debug(f"CrewAI: Processing crew with id {crew_id}")
+
+        for key, value in self.instance.__dict__.items():
+            if value is None:
+                continue
+
+            if key == "tasks":
+                if isinstance(value, list):
+                    self._set_attribute("crewai.crew.max_turns", str(len(value)))
+                    logger.debug(f"CrewAI: Found {len(value)} tasks")
+            elif key == "agents":
+                if isinstance(value, list):
+                    logger.debug(f"CrewAI: Found {len(value)} agents in crew")
+
+                if not self.skip_agent_processing:
+                    self._parse_agents(value)
+            elif key == "llms":
+                self._parse_llms(value)
+            elif key == "result":
+                self._set_attribute("crewai.crew.final_output", str(value))
+                self._set_attribute("crewai.crew.output", str(value))
+                self._set_attribute(SpanAttributes.AGENTOPS_ENTITY_OUTPUT, str(value))
+            else:
+                self._set_attribute(f"crewai.crew.{key}", str(value))
+
+    def _process_agent(self):
+        """Process an Agent instance."""
+        agent = {}
+        self._set_attribute(SpanAttributes.AGENTOPS_SPAN_KIND, "agent")
+
+        for key, value in self.instance.__dict__.items():
+            if key == "tools":
+                parsed_tools = _parse_tools(value)
+                for i, tool in enumerate(parsed_tools):
+                    tool_prefix = f"crewai.agent.tool.{i}."
+                    for tool_key, tool_value in tool.items():
+                        self._set_attribute(f"{tool_prefix}{tool_key}", str(tool_value))
+
+                agent[key] = json.dumps(parsed_tools)
+
+            if value is None:
+                continue
+
+            if key != "tools":
+                agent[key] = str(value)
+
+        self._set_attribute(AgentAttributes.AGENT_ID, agent.get("id", ""))
+        self._set_attribute(AgentAttributes.AGENT_ROLE, agent.get("role", ""))
+        self._set_attribute(AgentAttributes.AGENT_NAME, agent.get("name", ""))
+        self._set_attribute(AgentAttributes.AGENT_TOOLS, agent.get("tools", ""))
+
+        if "reasoning" in agent:
+            self._set_attribute(AgentAttributes.AGENT_REASONING, agent.get("reasoning", ""))
+
+        if "goal" in agent:
+            self._set_attribute(SpanAttributes.AGENTOPS_ENTITY_INPUT, agent.get("goal", ""))
+
+        self._set_attribute("crewai.agent.goal", agent.get("goal", ""))
+        self._set_attribute("crewai.agent.backstory", agent.get("backstory", ""))
+        self._set_attribute("crewai.agent.cache", agent.get("cache", ""))
+        self._set_attribute("crewai.agent.allow_delegation", agent.get("allow_delegation", ""))
+        self._set_attribute("crewai.agent.allow_code_execution", agent.get("allow_code_execution", ""))
+        self._set_attribute("crewai.agent.max_retry_limit", agent.get("max_retry_limit", ""))
+
+        if hasattr(self.instance, "llm") and self.instance.llm is not None:
+            model_name = (
+                getattr(self.instance.llm, "model", None) or getattr(self.instance.llm, "model_name", None) or ""
+            )
+            temp = getattr(self.instance.llm, "temperature", None)
+            max_tokens = getattr(self.instance.llm, "max_tokens", None)
+            top_p = getattr(self.instance.llm, "top_p", None)
+
+            self._set_attribute(SpanAttributes.LLM_REQUEST_MODEL, model_name)
+            if temp is not None:
+                self._set_attribute(SpanAttributes.LLM_REQUEST_TEMPERATURE, str(temp))
+            if max_tokens is not None:
+                self._set_attribute(SpanAttributes.LLM_REQUEST_MAX_TOKENS, str(max_tokens))
+            if top_p is not None:
+                self._set_attribute(SpanAttributes.LLM_REQUEST_TOP_P, str(top_p))
+
+            self._set_attribute("crewai.agent.llm", str(model_name))
+            self._set_attribute(AgentAttributes.AGENT_MODELS, str(model_name))
+
+    def _process_task(self):
+        """Process a Task instance."""
+        task = {}
+        self._set_attribute(SpanAttributes.AGENTOPS_SPAN_KIND, "workflow.step")
+
+        for key, value in self.instance.__dict__.items():
+            if value is None:
+                continue
+            if key == "tools":
+                parsed_tools = _parse_tools(value)
+                for i, tool in enumerate(parsed_tools):
+                    tool_prefix = f"crewai.task.tool.{i}."
+                    for tool_key, tool_value in tool.items():
+                        self._set_attribute(f"{tool_prefix}{tool_key}", str(tool_value))
+
+                task[key] = json.dumps(parsed_tools)
+
+            elif key == "agent":
+                task[key] = value.role if value else None
+                if value:
+                    agent_id = getattr(value, "id", "")
+                    self._set_attribute(AgentAttributes.FROM_AGENT, str(agent_id))
+            else:
+                task[key] = str(value)
+
+        self._set_attribute("crewai.task.name", task.get("description", ""))
+        self._set_attribute("crewai.task.type", "task")
+        self._set_attribute("crewai.task.input", task.get("context", ""))
+        self._set_attribute("crewai.task.expected_output", task.get("expected_output", ""))
+
+        if "description" in task:
+            self._set_attribute(SpanAttributes.AGENTOPS_ENTITY_INPUT, task.get("description", ""))
+        if "output" in task:
+            self._set_attribute(SpanAttributes.AGENTOPS_ENTITY_OUTPUT, task.get("output", ""))
+            self._set_attribute("crewai.task.output", task.get("output", ""))
+
+        if "id" in task:
+            self._set_attribute("crewai.task.id", str(task.get("id", "")))
+
+        if "status" in task:
+            self._set_attribute("crewai.task.status", task.get("status", ""))
+
+        self._set_attribute("crewai.task.agent", task.get("agent", ""))
+        self._set_attribute("crewai.task.human_input", task.get("human_input", ""))
+        self._set_attribute("crewai.task.processed_by_agents", str(task.get("processed_by_agents", "")))
+
+        if "tools" in task and task["tools"]:
+            try:
+                tools = json.loads(task["tools"])
+                for i, tool in enumerate(tools):
+                    self._set_attribute(MessageAttributes.TOOL_CALL_NAME.format(i=i), tool.get("name", ""))
+                    self._set_attribute(
+                        MessageAttributes.TOOL_CALL_DESCRIPTION.format(i=i), tool.get("description", "")
+                    )
+            except (json.JSONDecodeError, TypeError):
+                logger.warning(f"Failed to parse tools for task: {task.get('id', 'unknown')}")
+
+    def _process_llm(self):
+        """Process an LLM instance."""
+        llm = {}
+        self._set_attribute(SpanAttributes.AGENTOPS_SPAN_KIND, "llm")
+
+        for key, value in self.instance.__dict__.items():
+            if value is None:
+                continue
+            llm[key] = str(value)
+
+        model_name = llm.get("model_name", "") or llm.get("model", "")
+        self._set_attribute(SpanAttributes.LLM_REQUEST_MODEL, model_name)
+        self._set_attribute(SpanAttributes.LLM_REQUEST_TEMPERATURE, llm.get("temperature", ""))
+        self._set_attribute(SpanAttributes.LLM_REQUEST_MAX_TOKENS, llm.get("max_tokens", ""))
+        self._set_attribute(SpanAttributes.LLM_REQUEST_TOP_P, llm.get("top_p", ""))
+
+        if "frequency_penalty" in llm:
+            self._set_attribute(SpanAttributes.LLM_REQUEST_FREQUENCY_PENALTY, llm.get("frequency_penalty", ""))
+        if "presence_penalty" in llm:
+            self._set_attribute(SpanAttributes.LLM_REQUEST_PRESENCE_PENALTY, llm.get("presence_penalty", ""))
+        if "streaming" in llm:
+            self._set_attribute(SpanAttributes.LLM_REQUEST_STREAMING, llm.get("streaming", ""))
+
+        if "api_key" in llm:
+            self._set_attribute("gen_ai.request.api_key_present", "true")
+
+        if "base_url" in llm:
+            self._set_attribute(SpanAttributes.LLM_OPENAI_API_BASE, llm.get("base_url", ""))
+
+        if "api_version" in llm:
+            self._set_attribute(SpanAttributes.LLM_OPENAI_API_VERSION, llm.get("api_version", ""))
+
+    def _parse_agents(self, agents):
+        """Parse agents into a list of dictionaries."""
+        if not agents:
+            logger.debug("CrewAI: No agents to parse")
+            return
+
+        agent_count = len(agents)
+        logger.debug(f"CrewAI: Parsing {agent_count} agents")
+
+        # Pre-process all agents to collect their data first
+        agent_data_list = []
+
+        for idx, agent in enumerate(agents):
+            if agent is None:
+                logger.debug(f"CrewAI: Agent at index {idx} is None, skipping")
+                agent_data_list.append(None)
+                continue
+
+            logger.debug(f"CrewAI: Processing agent at index {idx}")
+            try:
+                agent_data = self._extract_agent_data(agent)
+                agent_data_list.append(agent_data)
+            except Exception as e:
+                logger.error(f"CrewAI: Error extracting data for agent at index {idx}: {str(e)}")
+                agent_data_list.append(None)
+
+        # Now set all attributes at once for each agent
+        for idx, agent_data in enumerate(agent_data_list):
+            if agent_data is None:
+                continue
+
+            for key, value in agent_data.items():
+                if key == "tools" and isinstance(value, list):
+                    for tool_idx, tool in enumerate(value):
+                        for tool_key, tool_value in tool.items():
+                            self._set_attribute(f"crewai.agents.{idx}.tools.{tool_idx}.{tool_key}", str(tool_value))
+                else:
+                    self._set_attribute(f"crewai.agents.{idx}.{key}", value)
+
+    def _parse_llms(self, llms):
+        """Parse LLMs into a list of dictionaries."""
+        for idx, llm in enumerate(llms):
+            if llm is not None:
+                model_name = getattr(llm, "model", None) or getattr(llm, "model_name", None) or ""
+                llm_data = {
+                    "model": model_name,
+                    "temperature": llm.temperature,
+                    "max_tokens": llm.max_tokens,
+                    "max_completion_tokens": llm.max_completion_tokens,
+                    "top_p": llm.top_p,
+                    "n": llm.n,
+                    "seed": llm.seed,
+                    "base_url": llm.base_url,
+                    "api_version": llm.api_version,
+                }
+
+                self._set_attribute(f"{SpanAttributes.LLM_REQUEST_MODEL}.{idx}", model_name)
+                if hasattr(llm, "temperature"):
+                    self._set_attribute(f"{SpanAttributes.LLM_REQUEST_TEMPERATURE}.{idx}", str(llm.temperature))
+                if hasattr(llm, "max_tokens"):
+                    self._set_attribute(f"{SpanAttributes.LLM_REQUEST_MAX_TOKENS}.{idx}", str(llm.max_tokens))
+                if hasattr(llm, "top_p"):
+                    self._set_attribute(f"{SpanAttributes.LLM_REQUEST_TOP_P}.{idx}", str(llm.top_p))
+
+                for key, value in llm_data.items():
+                    if value is not None:
+                        self._set_attribute(f"crewai.llms.{idx}.{key}", str(value))
+
+    def _extract_agent_data(self, agent):
+        """Extract data from an agent."""
+        model = getattr(agent.llm, "model", None) or getattr(agent.llm, "model_name", None) or ""
+
+        tools_list = []
+        if hasattr(agent, "tools") and agent.tools:
+            tools_list = _parse_tools(agent.tools)
+
+        return {
+            "id": str(agent.id),
+            "role": agent.role,
+            "goal": agent.goal,
+            "backstory": agent.backstory,
+            "cache": agent.cache,
+            "config": agent.config,
+            "verbose": agent.verbose,
+            "allow_delegation": agent.allow_delegation,
+            "tools": tools_list,
+            "max_iter": agent.max_iter,
+            "llm": str(model),
+        }
+
+    def _set_attribute(self, key, value):
+        """Set an attribute on the span."""
+        if value is not None and value != "":
+            set_span_attribute(self.span, key, value)