veadk-python 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

veadk/tracing/telemetry/opentelemetry_tracer.py

@@ -19,14 +19,17 @@ import time
 from typing import Any
 
 from openinference.instrumentation.google_adk import GoogleADKInstrumentor
+from opentelemetry import trace as trace_api
 from opentelemetry.sdk import trace as trace_sdk
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor, SimpleSpanProcessor
 from pydantic import BaseModel, ConfigDict, Field
 from typing_extensions import override
 
 from veadk.tracing.base_tracer import BaseTracer
 from veadk.tracing.telemetry.exporters.apiserver_exporter import ApiServerExporter
+from veadk.tracing.telemetry.exporters.apmplus_exporter import APMPlusExporter
 from veadk.tracing.telemetry.exporters.base_exporter import BaseExporter
 from veadk.tracing.telemetry.exporters.inmemory_exporter import InMemoryExporter
 from veadk.tracing.telemetry.metrics.opentelemetry_metrics import MeterUploader
@@ -51,39 +54,26 @@ class OpentelemetryTracer(BaseModel, BaseTracer):
         DEFAULT_VEADK_TRACER_NAME, description="The identifier of tracer."
     )
 
+    app_name: str = Field(
+        "veadk_app",
+        description="The identifier of app.",
+    )
+
     def model_post_init(self, context: Any, /) -> None:
         self._processors = []
-        self._inmemory_exporter: InMemoryExporter = None
+        self._inmemory_exporter: InMemoryExporter | None = None
 
-        # Inmemory & APIServer are the default exporters
-        have_inmemory_exporter = False
-        have_apiserver_exporter = False
+        # InMemoryExporter is a default exporter for exporting local tracing file
         for exporter in self.exporters:
             if isinstance(exporter, InMemoryExporter):
-                have_inmemory_exporter = True
-            elif isinstance(exporter, ApiServerExporter):
-                have_apiserver_exporter = True
-
-        if not have_inmemory_exporter:
-            inmemory_exporter = InMemoryExporter()
-            self.exporters.append(inmemory_exporter)
-            self._inmemory_exporter = inmemory_exporter
-        if not have_apiserver_exporter:
-            apiserver_exporter = ApiServerExporter()
-            self.exporters.append(apiserver_exporter)
-            self._apiserver_exporter = apiserver_exporter
-
-        tracer_provider = trace_sdk.TracerProvider()
-        for exporter in self.exporters:
-            processor, resource_attributes = exporter.get_processor()
-            if resource_attributes is not None:
-                update_resource_attributions(tracer_provider, resource_attributes)
-            tracer_provider.add_span_processor(processor)
+                self._inmemory_exporter = exporter
 
-            logger.debug(f"Add exporter `{exporter.__class__.__name__}` to tracing.")
-            self._processors.append(processor)
-        logger.debug(f"Init OpentelemetryTracer with {len(self.exporters)} exporters.")
+        if self._inmemory_exporter is None:
+            self._inmemory_exporter = InMemoryExporter()
+            self.exporters.append(self._inmemory_exporter)
+        # ========================================================================
 
+        # Process meter-related attributes
         self._meter_contexts = []
         self._meter_uploaders = []
         for exporter in self.exporters:
@@ -94,14 +84,62 @@ class OpentelemetryTracer(BaseModel, BaseTracer):
         for meter_context in self._meter_contexts:
             meter_uploader = MeterUploader(meter_context)
             self._meter_uploaders.append(meter_uploader)
+        # ================================
+
+        # init tracer provider
+        # VeADK operates on global OpenTelemetry provider, hence return nothing
+        self._init_tracer_provider()
 
         # just for debug
         self._trace_file_path = ""
 
-        # patch this before starting instrumentation
-        # enable_veadk_tracing(self.dump)
+        GoogleADKInstrumentor().instrument()
+
+    def _init_tracer_provider(self) -> None:
+        # 1. get global trace provider
+        global_tracer_provider = trace_api.get_tracer_provider()
 
-        GoogleADKInstrumentor().instrument(tracer_provider=tracer_provider)
+        if not isinstance(global_tracer_provider, TracerProvider):
+            logger.info(
+                "Global tracer provider has not been set. Create tracer provider and set it now."
+            )
+            # 1.1 init tracer provider
+            tracer_provider = trace_sdk.TracerProvider()
+            trace_api.set_tracer_provider(tracer_provider)
+            global_tracer_provider = trace_api.get_tracer_provider()
+
+        have_apmplus_exporter = False
+        # 2. check if apmplus exporter is already exist
+        for processor in global_tracer_provider._active_span_processor._span_processors:
+            if isinstance(processor, (BatchSpanProcessor, SimpleSpanProcessor)):
+                # try to get endpoint, in case of exporter has no _endpoint attribute
+                try:
+                    exporter_endpoint = processor.span_exporter._endpoint
+                    if "apmplus" in exporter_endpoint:
+                        have_apmplus_exporter = True
+                except AttributeError:
+                    # log a warning and pass this exporter
+                    logger.warning(
+                        f"Exporter {processor.span_exporter} has no endpoint."
+                    )
+
+        # 3. add exporters to global tracer_provider
+        # range over a copy of exporters to avoid index issues
+        if have_apmplus_exporter:
+            self.exporters = [
+                e for e in self.exporters if not isinstance(e, APMPlusExporter)
+            ]
+
+        for exporter in self.exporters[:]:
+            processor, resource_attributes = exporter.get_processor()
+            if resource_attributes is not None:
+                update_resource_attributions(
+                    global_tracer_provider, resource_attributes
+                )
+            global_tracer_provider.add_span_processor(processor)
+            logger.debug(f"Add exporter `{exporter.__class__.__name__}` to tracing.")
+            self._processors.append(processor)
+        logger.debug(f"Init OpentelemetryTracer with {len(self.exporters)} exporters.")
 
     @override
     def dump(
@@ -110,6 +148,12 @@ class OpentelemetryTracer(BaseModel, BaseTracer):
         session_id: str,
         path: str = "/tmp",
     ) -> str:
+        if not self._inmemory_exporter:
+            logger.warning(
+                "InMemoryExporter is not initialized. Please check your tracer exporters."
+            )
+            return ""
+
         prompt_tokens = self._inmemory_exporter._real_exporter.prompt_tokens
         completion_tokens = self._inmemory_exporter._real_exporter.completion_tokens
 

veadk/utils/mcp_utils.py

@@ -0,0 +1,44 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+from typing import Any
+
+from google.adk.tools.mcp_tool.mcp_toolset import (
+    SseConnectionParams,
+    StreamableHTTPConnectionParams,
+)
+
+from veadk.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def get_mcp_params(url: str) -> Any:
+    """Automatically set MCP connection params according to url.
+
+    Only support http and sse protocol.
+
+    Args:
+        url (str): MCP server url
+    """
+    if "/mcp" in url:
+        logger.info("MCP url detected, use StreamableHTTPConnectionParams.")
+        return StreamableHTTPConnectionParams(url=url)
+    elif "/sse" in url:
+        logger.info("SSE url detected, use SseConnectionParams.")
+        return SseConnectionParams(url=url)
+    else:
+        raise ValueError(
+            "Unsupported MCP url, because it has no `/mcp` or `/sse` field in your url. Please specify your connection params manually."
+        )

veadk/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-VERSION = "0.1.0"
+VERSION = "0.2.1"

{veadk_python-0.1.0.dist-info → veadk_python-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.1.0
+Version: 0.2.1
 Summary: Volcengine agent development kit, integrations with Volcengine cloud services.
 Author-email: Yaozheng Fang <fangyozheng@gmail.com>, Guodong Li <cu.eric.lee@gmail.com>, Zhi Han <sliverydayday@gmail.com>, Meng Wang <mengwangwm@gmail.com>
 Requires-Python: >=3.10
@@ -79,9 +79,18 @@ uv pip install -e .
 
 ## Configuration
 
-We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically.
+We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file:
 
-You can refer to the [example config file](config.yaml.example) for more details.
+```yaml
+model:
+  agent:
+    provider: openai
+    name: doubao-seed-1-6-250615
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: # <-- set your Volcengine ARK api key here
+```
+
+You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details.
 
 ## Have a try
 
@@ -101,8 +110,8 @@ print(res)
 
 VeADK provides several useful command line tools for faster deployment and optimization, such as:
 
-- `veadk deploy`: deploy your project to Volcengine VeFaaS platform (you can use `veadk init` to init a demo project first)
-- `veadk prompt`: otpimize the system prompt of your agent by PromptPilot
+- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
+- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
 
 ## Contribution