apophis/apophis-fastify
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: remove observe CLI references — observe is programmatic only

Browse Source
This commit is contained in:
John Dvorak
2026-05-22 14:00:47 -07:00
parent fe8e94fbaa
commit fca585f1e7
5 changed files with 9 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/observe.md
+7 -18
View File
@@ -2,11 +2,9 @@
Runtime visibility and drift detection without blocking by default.
APOPHIS observe has two paths:
APOPHIS observe is **programmatic only**. Register the APOPHIS plugin with `observe.enabled: true` and `observe.sinks` to emit contract pass/violation/error events from live traffic without blocking responses. Sampling controls the fraction of observed requests.
1. **CLI `apophis observe`**: Validates observe configuration readiness (policy, sinks, sampling, safety boundaries). Introduces no service process or runtime hooks. Use this for CI config validation before deployment.
2. **Programmatic runtime observation**: Register the APOPHIS plugin with `observe.enabled: true` and `observe.sinks` to emit contract pass/violation/error events from live traffic without blocking responses. Sampling controls the fraction of observed requests.
Use `apophis doctor --mode observe` to validate your observe configuration (sinks, sampling, blocking, production safety) before deploying.
## When to Use It
@@ -95,15 +93,9 @@ profiles: {
}
```
## `--check-config` Flag
## Config Validation
Validate config without activating observe mode:
```bash
apophis observe --profile staging-observe --check-config
```
This is useful in CI to ensure observe config is valid before deployment.
Validate your observe config before deployment with doctor:
## Exit Codes
@@ -161,10 +153,7 @@ export default {
## Programmatic Runtime Activation
The CLI only validates configuration. To activate runtime observation, register
APOPHIS with observe options in your application before routes are registered.
Observe remains active in production because it is non-blocking; blocking
runtime validation still stays disabled in production.
Register APOPHIS with observe options in your application before routes are registered.
```typescript
import Fastify from 'fastify'
@@ -248,9 +237,9 @@ plug in any backend. Common patterns:
## Monorepo Validation
For monorepos, use `apophis doctor --workspace` to validate observe configuration across all workspace packages. `observe` itself does not support `--workspace`; use `doctor` to check config in each package.
For monorepos, use `apophis doctor --mode observe --workspace` to validate observe configuration across all workspace packages.
## Mode Mismatch
Profiles configured for `verify` mode will be rejected by `apophis observe`. Only profiles with `mode: 'observe'` are valid.
Profiles configured for `verify` mode will be rejected at runtime. Only profiles with `mode: 'observe'` are valid for observe mode.
```