From 2e228f0e7788fdcc0f0eb4ca165b8787a76b6653 Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Mon, 28 Oct 2024 14:55:27 -0400 Subject: [PATCH] fixup: md lint Signed-off-by: Todd Baert --- .markdownlint-cli2.yaml | 2 ++ docs/reference/monitoring.md | 2 +- docs/reference/specifications/providers.md | 19 ++++++++++--------- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index c65da98a6..fc2cf0cd1 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -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" diff --git a/docs/reference/monitoring.md b/docs/reference/monitoring.md index 77aef086c..51861def7 100644 --- a/docs/reference/monitoring.md +++ b/docs/reference/monitoring.md @@ -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 diff --git a/docs/reference/specifications/providers.md b/docs/reference/specifications/providers.md index 08d432367..3fab1d9a9 100644 --- a/docs/reference/specifications/providers.md +++ b/docs/reference/specifications/providers.md @@ -2,13 +2,13 @@ description: flagd provider specification --- +# flagd Providers + !!! note This document serves as both a specification and general documentation for flagd providers. For language-specific details, see the `README.md` for the provider in question. -# flagd Providers - flagd providers are as essential as the flagd daemon itself, acting as the "bridge" between the OpenFeature SDK and flagd. In fact, flagd providers may be the most crucial part of the flagd framework, as they can be used without an active flagd instance. This document outlines their behavior and configuration. @@ -73,7 +73,7 @@ The lifecycle is summarized below: - if stream connection fails or exceeds the time specified by `deadline`, abort initialization (SDK will emit `PROVIDER_ERROR`), and attempt to [reconnect](#stream-reconnection) - while connected: - flags are resolved according to resolver mode; either by calling evaluation RPCs, or by evaluating the stored `flag set` rules - - for RPC providers, flags resolved with `reason=STATIC` are [cached](#caching) + - for RPC providers, flags resolved with `reason=STATIC` are [cached](#flag-evaluation-caching) - 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` - if stream disconnects: - [reconnect](#stream-reconnection) with backoff @@ -82,7 +82,7 @@ The lifecycle is summarized below: - if reconnect attempt <= `retryGraceAttempts` - emit `PROVIDER_STALE` - RPC mode resolves `STALE` from cache where possible - - in-process mode resolves `STALE` from stored `flag set` rules + - in-process mode resolves `STALE` from stored `flag set` rules - on stream reconnection: - emit `PROVIDER_READY` and `PROVIDER_CONFIGURATION_CHANGED` - in-process providers store the latest `flag set` rules @@ -126,7 +126,7 @@ stateDiagram-v2 %% ** In-Process providers only ``` -``` +```pseudo * RPC providers only ** In-Process providers only ``` @@ -143,7 +143,7 @@ The provider attempts to reconnect indefinitely, with a maximum interval of `ret 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. 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. -Of course, this means there's latency associated with RPC providers, though this is mitigated somewhat by [caching](#flag-evaluation-caching). +Of course, this means there's latency associated with RPC providers, though this is mitigated somewhat by [caching](#flag-evaluation-caching). ### Flag Evaluation Caching @@ -189,6 +189,7 @@ Client side flagd providers (used in mobile and front-end web applications) have 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). Instead, these do bulk evaluations of all flags in the `flag set`, and cache the results until they are invalidated. Bulk evaluations take place when: + - the provider is initialized - the context is changed - 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:// flagd supports the OFREP protocol, meaning client-side OFREP providers can also be used for client-side use-cases. -### Provider Metadata +### RPC Mode Provider Metadata The provider metadata includes properties returned from the [provider_ready event payload](./protos.md#eventstreamresponse) data. @@ -245,6 +246,6 @@ In-process flagd providers also inject any properties returned by the [sync-meta This allows for static properties defined in flagd to be added to in-process evaluations. 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. -### Provider Metadata +### In-Process Mode Provider Metadata -The provider metadata includes the top-level metadata property in the [flag definition](../flag-definitions.md). \ No newline at end of file +The provider metadata includes the top-level metadata property in the [flag definition](../flag-definitions.md).