[chore] Fix failure of github CI (#62)

Author: Cirilla-zmh

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/__init__.py

@@ -235,16 +235,20 @@ def generate_misc_workflow(
         workflow_directory_path,
     )
 
+
 # LoongSuite Extension
 def get_loongsuite_tox_envs(additional_config_path: Path) -> list:
     if not additional_config_path or not additional_config_path.exists():
         return []
-    
+
     additional_tox_ini = ToxIni(additional_config_path)
     additional_conf = State(get_options(), []).conf
     additional_section = next(additional_tox_ini.sections())
     additional_config_set = CoreConfigSet(
-        additional_conf, additional_section, additional_config_path.parent, additional_config_path
+        additional_conf,
+        additional_section,
+        additional_config_path.parent,
+        additional_config_path,
     )
     (
         additional_config_set.loaders.extend(
@@ -265,17 +269,14 @@ def generate_extension_test_workflow(
     tox_ini_path: Path,
     workflow_directory_path: Path,
     additional_config_path: Path,
-    *operating_systems
+    *operating_systems,
 ) -> None:
     loongsuite_envs = get_loongsuite_tox_envs(additional_config_path)
     if not loongsuite_envs:
         return
-    
+
     _generate_workflow_with_template(
-        get_test_job_datas(
-            loongsuite_envs,
-            list(operating_systems)
-        ),
+        get_test_job_datas(loongsuite_envs, list(operating_systems)),
         "loongsuite_test",
         "test",
         workflow_directory_path,
@@ -290,7 +291,7 @@ def generate_extension_lint_workflow(
     loongsuite_envs = get_loongsuite_tox_envs(additional_config_path)
     if not loongsuite_envs:
         return
-    
+
     _generate_workflow_with_template(
         get_lint_job_datas(loongsuite_envs),
         "loongsuite_lint",
@@ -307,7 +308,7 @@ def generate_extension_misc_workflow(
     loongsuite_envs = get_loongsuite_tox_envs(additional_config_path)
     if not loongsuite_envs:
         return
-    
+
     _generate_workflow_with_template(
         get_misc_job_datas(loongsuite_envs),
         "loongsuite_misc",
@@ -317,7 +318,11 @@ def generate_extension_misc_workflow(
 
 
 def _generate_workflow_with_template(
-    job_datas: list, name: str, template_name: str, workflow_directory_path: Path, max_jobs=250
+    job_datas: list,
+    name: str,
+    template_name: str,
+    workflow_directory_path: Path,
+    max_jobs=250,
 ):
     # Github seems to limit the amount of jobs in a workflow file, that is why
     # they are split in groups of 250 per workflow file.

.github/workflows/generate_workflows_loongsuite.py

@@ -8,9 +8,20 @@
 
 tox_ini_path = Path(__file__).parent.parent.parent.joinpath("tox.ini")
 # loongsuite instrumentation modules
-tox_loongsuite_ini_path = Path(__file__).parent.parent.parent.joinpath("tox-loongsuite.ini")
+tox_loongsuite_ini_path = Path(__file__).parent.parent.parent.joinpath(
+    "tox-loongsuite.ini"
+)
 workflows_directory_path = Path(__file__).parent
 
-generate_extension_test_workflow(tox_ini_path, workflows_directory_path, tox_loongsuite_ini_path, "ubuntu-latest")
-generate_extension_lint_workflow(tox_ini_path, workflows_directory_path, tox_loongsuite_ini_path)
-generate_extension_misc_workflow(tox_ini_path, workflows_directory_path, tox_loongsuite_ini_path)
+generate_extension_test_workflow(
+    tox_ini_path,
+    workflows_directory_path,
+    tox_loongsuite_ini_path,
+    "ubuntu-latest",
+)
+generate_extension_lint_workflow(
+    tox_ini_path, workflows_directory_path, tox_loongsuite_ini_path
+)
+generate_extension_misc_workflow(
+    tox_ini_path, workflows_directory_path, tox_loongsuite_ini_path
+)

README.md

@@ -6,7 +6,7 @@ Loongsuite Python Agent is a key component of LoongSuite, Alibaba's unified obse
 
 LoongSuite includes the following key components:
 * [LoongCollector](https://github.com/alibaba/loongcollector): universal node agent, which prodivdes log collection, prometheus metric collection, and network and security collection capabilities based on eBPF.
-* [LoongSuite Python Agent](https://github.com/alibaba/loongsuite-python-agent): a process agent providing instrumentaion for python applications.
+* [LoongSuite Python Agent](https://github.com/alibaba/loongsuite-python-agent): a process agent providing instrumentation for python applications.
 * [LoongSuite Go Agent](https://github.com/alibaba/loongsuite-go-agent): a process agent for golang with compile time instrumentation.
 * [LoongSuite Java Agent](https://github.com/alibaba/loongsuite-java-agent): a process agent for Java applications.
 * Other upcoming language agent.
@@ -179,7 +179,7 @@ global:
   StructureType: v2
 inputs:
   - Type: service_otlp
-    Protocals:
+    Protocols:
       GRPC:
         Endpoint: 0.0.0.0:6666
 flushers:
@@ -234,6 +234,6 @@ our [DingTalk group](https://qr.dingtalk.com/action/joingroup?code=v1,k1,mexukXI
 |----|----|
 | <img src="docs/_assets/img/loongsuite-go-sig-dingtalk.png" height="150"> | <img src="docs/_assets/img/loongsuite-java-sig-dingtalk.jpg" height="150"> |
 
-## Resoures
+## Resources
 * AgentScope: https://github.com/modelscope/agentscope
 * Observability Community: https://observability.cn

instrumentation-loongsuite/loongsuite-instrumentation-agentscope/src/opentelemetry/instrumentation/agentscope/__init__.py

@@ -1,15 +1,17 @@
 # -*- coding: utf-8 -*-
-from typing import Any, Collection, Callable, Optional
-from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from typing import Any, Collection
+
 from opentelemetry.instrumentation.agentscope.package import _instruments
 from opentelemetry.instrumentation.agentscope.utils import is_agentscope_v1
-from typing_extensions import Coroutine
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 
 __all__ = ["AgentScopeInstrumentor"]
 
-class AgentScopeInstrumentor(BaseInstrumentor):  # type: ignore
 
-    def __init__(self,):
+class AgentScopeInstrumentor(BaseInstrumentor):  # type: ignore
+    def __init__(
+        self,
+    ):
         self._meter = None
 
     def instrumentation_dependencies(self) -> Collection[str]:
@@ -18,18 +20,28 @@ def instrumentation_dependencies(self) -> Collection[str]:
     def _instrument(self, **kwargs: Any) -> None:
         """Enable AgentScope instrumentation."""
         if is_agentscope_v1():
-            from opentelemetry.instrumentation.agentscope.v1 import AgentScopeV1Instrumentor
+            from opentelemetry.instrumentation.agentscope.v1 import (
+                AgentScopeV1Instrumentor,
+            )
+
             AgentScopeV1Instrumentor().instrument(**kwargs)
         else:
-            from opentelemetry.instrumentation.agentscope.v0 import AgentScopeV0Instrumentor
+            from opentelemetry.instrumentation.agentscope.v0 import (
+                AgentScopeV0Instrumentor,
+            )
+
             AgentScopeV0Instrumentor().instrument(**kwargs)
 
     def _uninstrument(self, **kwargs: Any) -> None:
-
         if is_agentscope_v1():
-            from opentelemetry.instrumentation.agentscope.v1 import AgentScopeV1Instrumentor
+            from opentelemetry.instrumentation.agentscope.v1 import (
+                AgentScopeV1Instrumentor,
+            )
+
             AgentScopeV1Instrumentor().uninstrument(**kwargs)
         else:
-            from opentelemetry.instrumentation.agentscope.v0 import AgentScopeV0Instrumentor
-            AgentScopeV0Instrumentor().uninstrument(**kwargs)
+            from opentelemetry.instrumentation.agentscope.v0 import (
+                AgentScopeV0Instrumentor,
+            )
 
+            AgentScopeV0Instrumentor().uninstrument(**kwargs)

instrumentation-loongsuite/loongsuite-instrumentation-agentscope/src/opentelemetry/instrumentation/agentscope/shared/__init__.py

@@ -7,25 +7,41 @@
 and common attribute definitions.
 """
 
-from .constants import *
-from .telemetry_options import GenAITelemetryOptions, get_telemetry_options, set_telemetry_options
-from .attributes import *
+from .attributes import (
+    AgentRequestAttributes,
+    CommonAttributes,
+    EmbeddingRequestAttributes,
+    GenAiSpanKind,
+    LLMRequestAttributes,
+    LLMResponseAttributes,
+    ToolRequestAttributes,
+)
+from .constants import (
+    OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT,
+    OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT_MAX_LENGTH,
+    OTEL_INSTRUMENTATION_GENAI_MESSAGE_STRATEGY,
+)
+from .telemetry_options import (
+    GenAITelemetryOptions,
+    get_telemetry_options,
+    set_telemetry_options,
+)
 
 __all__ = [
     # Constants
     "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT",
-    "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT_MAX_LENGTH", 
+    "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT_MAX_LENGTH",
     "OTEL_INSTRUMENTATION_GENAI_MESSAGE_STRATEGY",
     # Telemetry options
     "GenAITelemetryOptions",
     "get_telemetry_options",
     "set_telemetry_options",
     # Attributes
     "LLMRequestAttributes",
-    "LLMResponseAttributes", 
+    "LLMResponseAttributes",
     "EmbeddingRequestAttributes",
     "AgentRequestAttributes",
-    "ToolRequestAttributes", 
+    "ToolRequestAttributes",
     # Enums
     "GenAiSpanKind",
     # Attribute constants

instrumentation-loongsuite/loongsuite-instrumentation-agentscope/src/opentelemetry/instrumentation/agentscope/shared/attributes.py

@@ -9,15 +9,18 @@
 from abc import ABC
 from dataclasses import dataclass, fields
 from typing import Dict, List, Optional
+
+from agentscope import _config
+
 from opentelemetry.semconv._incubating.attributes import (
     gen_ai_attributes as GenAIAttributes,
 )
 from opentelemetry.util.types import AttributeValue
+
 from .constants import (
     CommonAttributes,
     GenAiSpanKind,
 )
-from agentscope import _config
 
 
 class ASBaseAttributes(ABC):
@@ -45,12 +48,14 @@ def get_span_attributes(self) -> Dict[str, AttributeValue]:
 
         return attributes
 
+
 @dataclass
 class LLMRequestAttributes(ASBaseAttributes):
     """LLM 请求属性类
-    
+
     用于存储和管理 LLM 请求相关的 GenAI 语义约定属性。
     """
+
     SPAN_KIND = GenAiSpanKind.LLM.value
 
     provider_name: Optional[str] = None
@@ -73,9 +78,10 @@ class LLMRequestAttributes(ASBaseAttributes):
 @dataclass
 class LLMResponseAttributes(ASBaseAttributes):
     """LLM 响应属性类
-    
+
     用于存储和管理 LLM 响应相关的 GenAI 语义约定属性。
     """
+
     response_id: Optional[str] = None
     response_model: Optional[str] = None
     output_type: Optional[str] = None
@@ -87,9 +93,10 @@ class LLMResponseAttributes(ASBaseAttributes):
 @dataclass
 class EmbeddingRequestAttributes(ASBaseAttributes):
     """Embedding 请求属性类
-    
+
     用于存储和管理 Embedding 请求相关的 GenAI 语义约定属性。
     """
+
     SPAN_KIND = GenAiSpanKind.EMBEDDING.value
 
     provider_name: Optional[str] = None
@@ -102,9 +109,10 @@ class EmbeddingRequestAttributes(ASBaseAttributes):
 @dataclass
 class AgentRequestAttributes(ASBaseAttributes):
     """Agent 请求属性类
-    
+
     用于存储和管理 Agent 请求相关的 GenAI 语义约定属性。
     """
+
     SPAN_KIND = GenAiSpanKind.AGENT.value
 
     agent_id: Optional[str] = None
@@ -120,9 +128,10 @@ class AgentRequestAttributes(ASBaseAttributes):
 @dataclass
 class ToolRequestAttributes(ASBaseAttributes):
     """Tool 请求属性类
-    
+
     用于存储和管理 Tool 请求相关的 GenAI 语义约定属性。
     """
+
     SPAN_KIND = GenAiSpanKind.TOOL.value
 
     tool_call_id: Optional[str] = None
@@ -148,25 +157,21 @@ class ToolRequestAttributes(ASBaseAttributes):
     "request_stop_sequences": GenAIAttributes.GEN_AI_REQUEST_STOP_SEQUENCES,
     "system_instructions": GenAIAttributes.GEN_AI_SYSTEM_INSTRUCTIONS,
     "input_messages": GenAIAttributes.GEN_AI_INPUT_MESSAGES,
-    "request_tool_definitions": CommonAttributes.GEN_AI_REQUEST_TOOL_DEFINITIONS, # agentscope semconv
-
+    "request_tool_definitions": CommonAttributes.GEN_AI_REQUEST_TOOL_DEFINITIONS,  # agentscope semconv
     "response_id": GenAIAttributes.GEN_AI_RESPONSE_ID,
     "response_model": GenAIAttributes.GEN_AI_RESPONSE_MODEL,
     "output_type": GenAIAttributes.GEN_AI_OUTPUT_TYPE,
     "response_finish_reasons": GenAIAttributes.GEN_AI_RESPONSE_FINISH_REASONS,
     "usage_input_tokens": GenAIAttributes.GEN_AI_USAGE_INPUT_TOKENS,
     "usage_output_tokens": GenAIAttributes.GEN_AI_USAGE_OUTPUT_TOKENS,
-
     "request_encoding_formats": GenAIAttributes.GEN_AI_REQUEST_ENCODING_FORMATS,
-
     "agent_id": GenAIAttributes.GEN_AI_AGENT_ID,
     "agent_name": GenAIAttributes.GEN_AI_AGENT_NAME,
     "agent_description": GenAIAttributes.GEN_AI_AGENT_DESCRIPTION,
     "conversation_id": GenAIAttributes.GEN_AI_CONVERSATION_ID,
-
     "tool_call_id": GenAIAttributes.GEN_AI_TOOL_CALL_ID,
     "tool_name": GenAIAttributes.GEN_AI_TOOL_NAME,
     "tool_description": GenAIAttributes.GEN_AI_TOOL_DESCRIPTION,
     "tool_type": GenAIAttributes.GEN_AI_TOOL_TYPE,
-    "tool_call_arguments": CommonAttributes.GEN_AI_TOOL_CALL_ARGUMENTS, # agentscope semconv
+    "tool_call_arguments": CommonAttributes.GEN_AI_TOOL_CALL_ARGUMENTS,  # agentscope semconv
 }

instrumentation-loongsuite/loongsuite-instrumentation-agentscope/src/opentelemetry/instrumentation/agentscope/shared/constants.py

@@ -6,13 +6,20 @@
 from enum import Enum
 
 # Environment Variables
-OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
-OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT_MAX_LENGTH = "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT_MAX_LENGTH"
-OTEL_INSTRUMENTATION_GENAI_MESSAGE_STRATEGY = "OTEL_INSTRUMENTATION_GENAI_MESSAGE_STRATEGY"
+OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = (
+    "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
+)
+OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT_MAX_LENGTH = (
+    "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT_MAX_LENGTH"
+)
+OTEL_INSTRUMENTATION_GENAI_MESSAGE_STRATEGY = (
+    "OTEL_INSTRUMENTATION_GENAI_MESSAGE_STRATEGY"
+)
 
 
 class CommonAttributes:
     """Common GenAI attributes shared across all span types"""
+
     GEN_AI_SPAN_KIND = "gen_ai.span.kind"
     GEN_AI_SYSTEM_INSTRUCTIONS = "gen_ai.system_instructions"
     GEN_AI_REQUEST_TOOL_DEFINITIONS = "gen_ai.tool.definitions"
@@ -24,12 +31,14 @@ class CommonAttributes:
 
 class GenAiSpanKind(str, Enum):
     """GenAI span kinds"""
+
     LLM = "llm"
     EMBEDDING = "embedding"
     AGENT = "agent"
     TOOL = "tool"
     FORMATTER = "formatter"
 
+
 class AgentScopeGenAiProviderName(str, Enum):
     OLLAMA = "ollama"
     DASHSCOPE = "dashscope"