Skip to content

Commit ce64a43

Browse files
committed
fixup: md lint
Signed-off-by: Todd Baert <[email protected]>
1 parent fc0e0da commit ce64a43

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

.markdownlint-cli2.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ config:
1313
max-one-sentence-per-line: true
1414
code-block-style: false # not compatible with mkdocs "details" panes
1515
no-alt-text: false
16+
MD007:
17+
indent: 4
1618

1719
ignores:
1820
- "**/CHANGELOG.md"

docs/reference/monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ flagd exposes the following metrics:
6161
flagd creates the following spans as part of a trace:
6262

6363
- `flagEvaluationService(resolveX)` - SpanKind server
64-
- `jsonEvaluator(resolveX)` - SpanKind internal
64+
- `jsonEvaluator(resolveX)` - SpanKind internal
6565
- `jsonEvaluator(setState)` - SpanKind internal
6666

6767
## Export to OTEL collector

docs/reference/specifications/providers.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
description: flagd provider specification
33
---
44

5+
# flagd Providers
6+
57
!!! note
68

79
This document serves as both a specification and general documentation for flagd providers.
810
For language-specific details, see the `README.md` for the provider in question.
911

10-
# flagd Providers
11-
1212
flagd providers are as essential as the flagd daemon itself, acting as the "bridge" between the OpenFeature SDK and flagd.
1313
In fact, flagd providers may be the most crucial part of the flagd framework, as they can be used without an active flagd instance.
1414
This document outlines their behavior and configuration.
@@ -73,7 +73,7 @@ The lifecycle is summarized below:
7373
- if stream connection fails or exceeds the time specified by `deadline`, abort initialization (SDK will emit `PROVIDER_ERROR`), and attempt to [reconnect](#stream-reconnection)
7474
- while connected:
7575
- flags are resolved according to resolver mode; either by calling evaluation RPCs, or by evaluating the stored `flag set` rules
76-
- for RPC providers, flags resolved with `reason=STATIC` are [cached](#caching)
76+
- for RPC providers, flags resolved with `reason=STATIC` are [cached](#flag-evaluation-caching)
7777
- if flags change the associated stream (event or sync) indicates flags have changed, flush cache, or update `flag set` rules respectively and emit `PROVIDER_CONFIGURATION_CHANGED`
7878
- if stream disconnects:
7979
- [reconnect](#stream-reconnection) with backoff
@@ -82,7 +82,7 @@ The lifecycle is summarized below:
8282
- if reconnect attempt <= `retryGraceAttempts`
8383
- emit `PROVIDER_STALE`
8484
- RPC mode resolves `STALE` from cache where possible
85-
- in-process mode resolves `STALE` from stored `flag set` rules
85+
- in-process mode resolves `STALE` from stored `flag set` rules
8686
- on stream reconnection:
8787
- emit `PROVIDER_READY` and `PROVIDER_CONFIGURATION_CHANGED`
8888
- in-process providers store the latest `flag set` rules
@@ -126,7 +126,7 @@ stateDiagram-v2
126126
%% ** In-Process providers only
127127
```
128128

129-
```
129+
```pseudo
130130
* RPC providers only
131131
** In-Process providers only
132132
```
@@ -143,7 +143,7 @@ The provider attempts to reconnect indefinitely, with a maximum interval of `ret
143143

144144
RPC providers use the [evaluation protocol](./protos.md#flagdevaluationv1evaluationproto) to connect to flagd, initiate the [event stream](./protos.md#eventstreamresponse), listen for changes in the flag definitions, and evaluate flags remotely by calling flagd.
145145
RPC providers are relatively simple to implement since they essentially call a remote flagd instance with relevant parameters, and then flagd responds with the resolved flag value.
146-
Of course, this means there's latency associated with RPC providers, though this is mitigated somewhat by [caching](#flag-evaluation-caching).
146+
Of course, this means there's latency associated with RPC providers, though this is mitigated somewhat by [caching](#flag-evaluation-caching).
147147

148148
### Flag Evaluation Caching
149149

@@ -189,6 +189,7 @@ Client side flagd providers (used in mobile and front-end web applications) have
189189
These flagd providers only support the RPC resolver mode (so that `flag set` rules, which might contain sensitive information, are never sent to the client).
190190
Instead, these do bulk evaluations of all flags in the `flag set`, and cache the results until they are invalidated.
191191
Bulk evaluations take place when:
192+
192193
- the provider is initialized
193194
- the context is changed
194195
- a change in the definition notifies the provider it should re-evaluate the flags
@@ -203,7 +204,7 @@ This pattern is consistent with OpenFeature's [static context paradigm](https://
203204

204205
flagd supports the OFREP protocol, meaning client-side OFREP providers can also be used for client-side use-cases.
205206

206-
### Provider Metadata
207+
### RPC Mode Provider Metadata
207208

208209
The provider metadata includes properties returned from the [provider_ready event payload](./protos.md#eventstreamresponse) data.
209210

@@ -245,6 +246,6 @@ In-process flagd providers also inject any properties returned by the [sync-meta
245246
This allows for static properties defined in flagd to be added to in-process evaluations.
246247
If only a subset of the sync-metadata response is desired to be injected into the evaluation context, you can use the define a mapping function with the `contextEnricher` option.
247248

248-
### Provider Metadata
249+
### In-Process Mode Provider Metadata
249250

250-
The provider metadata includes the top-level metadata property in the [flag definition](../flag-definitions.md).
251+
The provider metadata includes the top-level metadata property in the [flag definition](../flag-definitions.md).

0 commit comments

Comments
 (0)