@blaxel/telemetry 0.2.61 → 0.2.62-preview.65
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -25
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,51 +1,59 @@
|
|
|
1
|
-
# Blaxel
|
|
1
|
+
# Blaxel TypeScript SDK
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
<img src="https://blaxel.ai/logo-bg.png" alt="Blaxel"/>
|
|
5
|
-
</p>
|
|
3
|
+
[Blaxel](https://blaxel.ai) is a perpetual sandbox platform that achieves near instant latency by keeping infinite secure sandboxes on automatic standby, while co-hosting your agent logic to cut network overhead.
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
This package contains helper functions for Blaxel's TypeScript SDK, to enable integrated telemetry.
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
Traces are automatically sampled at 10%, and can be retrieved from the Blaxel Console.
|
|
10
8
|
|
|
11
|
-
|
|
12
|
-
- [Features](#features)
|
|
9
|
+
## Installation
|
|
13
10
|
|
|
11
|
+
```bash
|
|
12
|
+
# npm
|
|
13
|
+
npm install @blaxel/telemetry
|
|
14
14
|
|
|
15
|
+
# yarn
|
|
16
|
+
yarn add @blaxel/telemetry
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
# bun
|
|
19
|
+
bun add @blaxel/telemetry
|
|
20
|
+
```
|
|
17
21
|
|
|
18
|
-
|
|
22
|
+
## Authentication
|
|
19
23
|
|
|
20
|
-
|
|
21
|
-
## npm
|
|
22
|
-
npm install @blaxel/telemetry
|
|
24
|
+
The SDK authenticates with your Blaxel workspace using these sources (in priority order):
|
|
23
25
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
+
1. Blaxel CLI, when logged in
|
|
27
|
+
2. Environment variables in `.env` file (`BL_WORKSPACE`, `BL_API_KEY`)
|
|
28
|
+
3. System environment variables
|
|
29
|
+
4. Blaxel configuration file (`~/.blaxel/config.yaml`)
|
|
26
30
|
|
|
27
|
-
|
|
28
|
-
|
|
31
|
+
When developing locally, the recommended method is to just log in to your workspace with the Blaxel CLI:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
bl login YOUR-WORKSPACE
|
|
29
35
|
```
|
|
30
36
|
|
|
37
|
+
This allows you to run Blaxel SDK functions that will automatically connect to your workspace without additional setup. When you deploy on Blaxel, this connection persists automatically.
|
|
31
38
|
|
|
32
|
-
|
|
33
|
-
- Enable tracing : Trace are automatically sampled at 10%, and can be retrieved from the Blaxel console.
|
|
39
|
+
When running Blaxel SDK from a remote server that is not Blaxel-hosted, we recommend using environment variables as described in the third option above.
|
|
34
40
|
|
|
41
|
+
## Usage
|
|
35
42
|
|
|
36
|
-
|
|
37
|
-
|
|
43
|
+
Enable automatic telemetry by importing the `@blaxel/telemetry` package:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
38
46
|
import "@blaxel/telemetry";
|
|
39
47
|
```
|
|
40
48
|
|
|
49
|
+
## Requirements
|
|
41
50
|
|
|
51
|
+
- Node.js v18 or later
|
|
42
52
|
|
|
43
53
|
## Contributing
|
|
44
54
|
|
|
45
|
-
Contributions are welcome! Please feel free to submit a
|
|
46
|
-
|
|
47
|
-
|
|
55
|
+
Contributions are welcome! Please feel free to [submit a pull request](https://github.com/blaxel-ai/sdk-typescript/pulls).
|
|
48
56
|
|
|
49
57
|
## License
|
|
50
58
|
|
|
51
|
-
This project is licensed under the MIT License
|
|
59
|
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blaxel/telemetry",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.62-preview.65",
|
|
4
4
|
"description": "Blaxel SDK for TypeScript",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Blaxel, INC (https://blaxel.ai)",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"@ai-sdk/google": "^2.0.25",
|
|
55
55
|
"@ai-sdk/groq": "^2.0.26",
|
|
56
56
|
"@ai-sdk/openai": "^2.0.57",
|
|
57
|
-
"@blaxel/core": "
|
|
57
|
+
"@blaxel/core": "0.2.62-preview.65",
|
|
58
58
|
"@opentelemetry/api": "^1.9.0",
|
|
59
59
|
"@opentelemetry/api-logs": "^0.200.0",
|
|
60
60
|
"@opentelemetry/exporter-logs-otlp-http": "^0.200.0",
|