Skip to content

Commit

Permalink
docs: update flagd provider specs (#1432)
Browse files Browse the repository at this point in the history
This PR contains significant enhancements to flagd provider specs. If
merged, I will be opening a bunch of issues to implement what's
described here based on recon I've been doing with the existing
implementations

Specifically:

- adds `retryGraceAttempts` param, which defines the amount of stream
retry attempts before provider moves from `STALE` to `ERROR` state
- adds `contextEnricher` param, which defines mapping function for
sync-metadata to evaluation context for in process providers (exists
already in Java provider)
- improves consistency between in-process and RPC stream reconnect
behavior
- simplifies provider doc and spec to remove duplication and improve
readability

---------

Signed-off-by: Todd Baert <[email protected]>
Co-authored-by: Guido Breitenhuber <[email protected]>
Co-authored-by: Michael Beemer <[email protected]>
  • Loading branch information
3 people authored Oct 30, 2024
1 parent 0df8622 commit a19cb42
Show file tree
Hide file tree
Showing 6 changed files with 285 additions and 427 deletions.
2 changes: 2 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ config:
max-one-sentence-per-line: true
code-block-style: false # not compatible with mkdocs "details" panes
no-alt-text: false
MD007:
indent: 4

ignores:
- "**/CHANGELOG.md"
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ flagd exposes the following metrics:
flagd creates the following spans as part of a trace:

- `flagEvaluationService(resolveX)` - SpanKind server
- `jsonEvaluator(resolveX)` - SpanKind internal
- `jsonEvaluator(resolveX)` - SpanKind internal
- `jsonEvaluator(setState)` - SpanKind internal

## Export to OTEL collector
Expand Down
260 changes: 0 additions & 260 deletions docs/reference/specifications/in-process-providers.md

This file was deleted.

Loading

0 comments on commit a19cb42

Please sign in to comment.