Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: logging requirements and logging hook #269

Merged
merged 2 commits into from
Sep 4, 2024
Merged

feat: logging requirements and logging hook #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd59837
feat!: change logging requirements, logging hook
toddbaert Aug 29, 2024
8191b21
fixup: use underscores
toddbaert Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions specification.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@
{
"id": "Requirement 1.4.11",
"machine_id": "requirement_1_4_11",
"content": "In the case of abnormal execution, the client SHOULD log an informative error message.",
"RFC 2119 keyword": "SHOULD",
"content": "Methods, functions, or operations on the client SHOULD NOT write log messages.",
"RFC 2119 keyword": "SHOULD NOT",
"children": []
},
{
Expand Down
23 changes: 22 additions & 1 deletion specification/appendix-a-included-utilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document contains requirements for auxiliary utilities provided by the SDK,

## In-memory provider

> Language-specific OpenFeature SDK implementations **SHOULD** expose an in-memory provider built into the SDK.
> OpenFeature SDK implementations **SHOULD** provide an `in-memory provider`.

The in-memory provider is intended to be used for testing; SDK consumers may use it for their use cases.
Hence, the packaging, naming, and access modifiers must be set appropriately.
Expand Down Expand Up @@ -360,3 +360,24 @@ Providers can contain metadata. The Multi-Provider will make that metadata avail
},
}
```

## Logging Hook

> OpenFeature SDK implementations **SHOULD** provide a `logging hook`.

The logging hook is a hook which logs messages during the flag evaluation life-cycle as described below:

| Stage | Logged data |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| before | `stage`, `domain`, `provider_name`, `flag_key`, `default_value` and `evaluation_context` (serialized, opt-in) |
| after | `stage`, `domain`, `provider_name`, `flag_key`, `default_value`, `evaluation_context` (serialized, opt-in), `reason`, `variant` and `value` |
| error | `stage`, `domain`, `provider_name`, `flag_key`, `default_value`, `evaluation_context` (serialized, opt-in), `error code`, and `error_message` |
| finally | N/A |

> The evaluation context **SHOULD** only be logged if an associated option indicates so.

The can be a constructor option or similar, for example: `boolean printContext`.

> If logging the evaluation context is enabled, it **MUST** be printed in such a way that it's human readable.

> If the logger abstraction in the SDK supports a log level concept, the appropriate log level **SHOULD** be used for each stage (before/after: info, error: error).
10 changes: 8 additions & 2 deletions specification/sections/01-flag-evaluation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,9 +353,15 @@ Configuration code includes code to set the provider, instantiate providers, and

#### Requirement 1.4.11

> In the case of abnormal execution, the client **SHOULD** log an informative error message.
> Methods, functions, or operations on the client **SHOULD NOT** write log messages.
lukas-reining marked this conversation as resolved.
Show resolved Hide resolved

Implementations may define a standard logging interface that can be supplied as an optional argument to the client creation function, which may wrap standard logging functionality of the implementation language.
The client methods (particularly the evaluation methods) run in hot code paths.
Logging (even at error level) can cause a huge volume of log entries.
For example, in a circumstance in which an application expecting a particular flag to exist is deployed in advance of that flag's being defined in the management system, logs can become inundated with `FLAG_NOT_FOUND` messages and related stack traces.
Logging in these code paths is highly discouraged.
Application authors can attach a [logging hook](../appendix-a-included-utilities.md#logging-hook) or author their own custom logging hook(s) to help with debugging or satisfy their particular logging needs.

Logging is encouraged in functions to do with configuration, initialization, shutdown, etc.

#### Requirement 1.4.12

Expand Down
Loading