Skip to content

Commit 741c5a1

Browse files
committed
Docs updates
1 parent f1c65a6 commit 741c5a1

File tree

401 files changed

+8471
-3338
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

401 files changed

+8471
-3338
lines changed

.env-dist

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,13 @@ JINAREADER_API_KEY=''
4040
SCRAPFLY_API_KEY=''
4141
SCRAPINGBEE_API_KEY=''
4242

43-
#########################################################
44-
# MISC
45-
#########################################################
46-
47-
SHOWCODE_API_KEY=''
43+
#########################################################
44+
# MISC
45+
#########################################################
46+
47+
SHOWCODE_API_KEY=''
48+
LOGFIRE_TOKEN=''
49+
LOGFIRE_OTLP_ENDPOINT=''
50+
LANGFUSE_BASE_URL=''
51+
LANGFUSE_PUBLIC_KEY=''
52+
LANGFUSE_SECRET_KEY=''

QUALITY.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All commands below run from the monorepo root unless noted otherwise.
99
| `composer qa` | Full QA pipeline (PHPStan + Psalm + Pint + Semgrep) |
1010
| `composer test` | Unit + Feature + Regression tests |
1111
| `composer test-all` | Every test in the monorepo, no exclusions |
12+
| `composer test:telemetry-interop` | Telemetry live-backend integration suite (requires opt-in env) |
1213
| `composer bench` | PHPBench benchmarks (instructor + polyglot) |
1314
| `composer docs qa` | Docs QA checks across all packages |
1415
| `composer docs drift` | Detect documentation drift per package |
@@ -30,8 +31,32 @@ composer test
3031

3132
# Everything, including Integration
3233
composer test-all
34+
35+
# Telemetry live backend interop only
36+
TELEMETRY_INTEROP_ENABLED=1 composer test:telemetry-interop
3337
```
3438

39+
### Opt-In Live Backend Suites
40+
41+
Some Integration coverage talks to real third-party services and is therefore
42+
opt-in. The telemetry backend interop suite is the current example.
43+
44+
It lives at `packages/telemetry/tests/Integration` and requires:
45+
46+
- `TELEMETRY_INTEROP_ENABLED=1`
47+
- Logfire env for Logfire cases:
48+
- `LOGFIRE_TOKEN`
49+
- `LOGFIRE_OTLP_ENDPOINT`
50+
- `LOGFIRE_READ_TOKEN`
51+
- Langfuse env for Langfuse cases:
52+
- `LANGFUSE_BASE_URL`
53+
- `LANGFUSE_PUBLIC_KEY`
54+
- `LANGFUSE_SECRET_KEY`
55+
- `OPENAI_API_KEY` for the inference, streaming, and agent runtime smoke portion
56+
- a usable `codex` CLI with working auth/config for the AgentCtrl smoke portion
57+
58+
When the opt-in env is missing, the suite skips instead of failing.
59+
3560
### Package-Level Tests
3661

3762
Each package can be tested independently:

builds/docs-build/cheatsheets/laravel.mdx

Lines changed: 34 additions & 31 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

builds/docs-build/cheatsheets/telemetry.mdx

Lines changed: 20 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

builds/docs-build/cookbook/examples/A03_Troubleshooting/structured_telemetry_langfuse.mdx

Lines changed: 36 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

builds/docs-build/cookbook/examples/A03_Troubleshooting/structured_telemetry_logfire.mdx

Lines changed: 29 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)