@mastra/arize 1.3.13-alpha.0 → 1.3.13-alpha.2

package/README.md

@@ -1,4 +1,4 @@
-# @mastra/arize - OpenTelemetry + OpenInference Tracing Exporter
+# @mastra/arize
 
 Export Mastra traces to any OpenTelemetry observability platform that supports OpenInference, like [Arize AX](https://arize.com/generative-ai/), or [Phoenix](https://phoenix.arize.com/).
 
@@ -10,198 +10,35 @@ For more information on OpenInference, see the [OpenInference Semantic Conventio
 npm install @mastra/arize
 ```
 
-## Configuration
+## Usage
 
-You can add `ArizeExporter` to your Mastra configuration to export traces to Arize AX or Phoenix, or any other OpenTelemetry compatible observability platform that supports OpenInference.
-
-The exporter automatically reads credentials from environment variables, enabling zero-config setup.
-
-### Phoenix (Zero-Config)
-
-Set environment variables and use zero-config:
-
-```bash
-# Required - endpoint must end in /v1/traces
-PHOENIX_COLLECTOR_ENDPOINT=http://localhost:6006/v1/traces
-
-# Optional - for authenticated Phoenix instances
-PHOENIX_API_KEY=your-api-key
-
-# Optional - project name
-PHOENIX_PROJECT_NAME=my-project
-```
-
-```typescript
-import { ArizeExporter } from '@mastra/arize';
-import { Mastra } from '@mastra/core/mastra';
-
-const mastra = new Mastra({
-  ...,
-  observability: {
-    configs: {
-      arize: {
-        serviceName: 'my-service',
-        exporters: [new ArizeExporter()],
-      },
-    },
-  },
-});
-```
-
-### Phoenix (Explicit Configuration)
+Set `PHOENIX_COLLECTOR_ENDPOINT` and, for authenticated instances, `PHOENIX_API_KEY`.
 
 ```typescript
-import { ArizeExporter } from '@mastra/arize';
 import { Mastra } from '@mastra/core/mastra';
-
-const mastra = new Mastra({
-  ...,
-  observability: {
-    configs: {
-      arize: {
-        serviceName: 'my-service',
-        exporters: [
-          new ArizeExporter({
-            endpoint: 'http://localhost:6006/v1/traces',
-            apiKey: 'your-api-key', // Optional
-            projectName: 'my-project', // Optional
-          }),
-        ],
-      },
-    },
-  },
-});
-```
-
-> [!TIP]
-> You can easily use this exporter with both [self-hosted Phoenix](https://docs.arize.com/phoenix/deployment), or, [Phoenix Cloud](https://app.phoenix.arize.com/login).
->
-> To quickly verify functionality, you can try out a local in-memory Phoenix instance:
->
-> ```bash
-> docker run --pull=always -d --name arize-phoenix -p 6006:6006 -e PHOENIX_SQL_DATABASE_URL="sqlite:///:memory:" arizephoenix/phoenix:latest
-> ```
->
-> Configure your `ArizeExporter` endpoint to `http://localhost:6006/v1/traces` and run the default Mastra weather agent to see traces!
-
-### Arize AX (Zero-Config)
-
-Set environment variables and use zero-config:
-
-```bash
-# Required
-ARIZE_SPACE_ID=your-space-id
-ARIZE_API_KEY=your-api-key
-
-# Optional
-ARIZE_PROJECT_NAME=my-project
-```
-
-```typescript
+import { Observability } from '@mastra/observability';
 import { ArizeExporter } from '@mastra/arize';
-import { Mastra } from '@mastra/core/mastra';
 
-const mastra = new Mastra({
-  ...,
-  observability: {
+export const mastra = new Mastra({
+  observability: new Observability({
     configs: {
       arize: {
         serviceName: 'my-service',
         exporters: [new ArizeExporter()],
       },
     },
-  },
-});
-```
-
-### Arize AX (Explicit Configuration)
-
-```typescript
-import { ArizeExporter } from '@mastra/arize';
-import { Mastra } from '@mastra/core/mastra';
-
-const mastra = new Mastra({
-  ...,
-  observability: {
-    configs: {
-      arize: {
-        serviceName: 'my-service',
-        exporters: [
-          new ArizeExporter({
-            spaceId: 'your-space-id',
-            apiKey: 'your-api-key',
-            projectName: 'my-project', // Optional
-          }),
-        ],
-      },
-    },
-  },
+  }),
 });
 ```
 
-> [!TIP]
-> Need an Arize AX API key? [Get one here](https://app.arize.com/).
+## Documentation
 
-## Optional Configuration
-
-You can configure the `ArizeExporter` to tweak the underlying OpenTelemetry `BatchSpanProcessor`, or add additional resource attributes to each span.
-
-```typescript
-import { ArizeExporter } from '@mastra/arize';
-import { Mastra } from '@mastra/core/mastra';
-
-const mastra = new Mastra({
-  ...,
-  observability: {
-    configs: {
-      arize: {
-        serviceName: 'mastra-service',
-        exporters: [
-          new ArizeExporter({
-            // Required at runtime
-            endpoint: 'https://your-collector.example.com/v1/traces',
-            // Required if using authenticated endpoint
-            apiKey: "your-api-key",
-            // Optional headers to be added to each OTLP request, in addition to authentication headers
-            headers: {
-              'x-api-key': process.env.API_KEY,
-            },
-            // Optional log level for debugging the exporter
-            logLevel: 'debug',
-            // Optional batch size for the underlying BatchSpanProcessor, before spans are exported
-            batchSize: 512,
-            // Optional timeout for the underlying BatchSpanProcessor, before spans are exported
-            timeout: 30000,
-            // Optional resource attributes to be added to each span
-            resourceAttributes: {
-              'custom.attribute': 'value',
-            },
-          })
-        ],
-      },
-    },
-  },
-});
-```
-
-### Custom metadata
-
-Any custom span attributes that are not part of the standard Mastra/OpenInference fields are serialized into the OpenInference `metadata` payload and shown in Arize/Phoenix. An easy way to add them is through `tracingOptions.metadata`:
-
-```ts
-await agent.generate(input, {
-  tracingOptions: {
-    metadata: {
-      companyId: 'acme-co',
-    },
-  },
-});
-```
+- [@mastra/arize documentation](https://mastra.ai/integrations/observability/arize)
 
-## OpenInference Semantic Conventions
+## Changelog
 
-This exporter follows the [OpenInference Semantic Conventions](https://github.com/Arize-ai/openinference/tree/main/spec) for generative AI applications.
+See the [package changelog](https://github.com/mastra-ai/mastra/blob/main/observability/arize/CHANGELOG.md) for version history and release notes.
 
-## License
+## Support
 
-Apache 2.0
+We have an [open community Discord](https://discord.gg/mastra-ai). Come and say hello and let us know if you have any questions or need any help getting things running.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/arize",
-  "version": "1.3.13-alpha.0",
+  "version": "1.3.13-alpha.2",
   "description": "Arize observability provider for Mastra - includes tracing and future observability features",
   "type": "module",
   "main": "dist/index.js",
@@ -30,7 +30,7 @@
     "@opentelemetry/resources": "^2.10.0",
     "@opentelemetry/sdk-trace-base": "^2.10.0",
     "@opentelemetry/semantic-conventions": "^1.43.0",
-    "@mastra/otel-exporter": "1.3.13-alpha.0"
+    "@mastra/otel-exporter": "1.3.13-alpha.2"
   },
   "devDependencies": {
     "@types/node": "22.20.1",
@@ -40,9 +40,9 @@
     "tsdown": "0.22.9",
     "typescript": "^7.0.2",
     "vitest": "4.1.10",
-    "@internal/lint": "0.0.129",
     "@internal/types-builder": "0.0.104",
-    "@mastra/core": "1.64.0-alpha.2"
+    "@internal/lint": "0.0.129",
+    "@mastra/core": "1.64.0-alpha.8"
   },
   "peerDependencies": {
     "@mastra/core": ">=1.16.0-0 <2.0.0-0"