Skip to content

Commit

Permalink
fixup: fix readme
Browse files Browse the repository at this point in the history
Signed-off-by: Todd Baert <[email protected]>
  • Loading branch information
toddbaert committed Jul 12, 2023
1 parent bd6596d commit d6f7c97
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions libs/hooks/open-telemetry/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# OpenTelemetry Hook

The OpenTelemetry hooks for OpenFeature provide a [spec compliant][otel-spec] way to automatically add a feature flag evaluation information to traces and metrics. Since feature flags are dynamic and affect runtime behavior, it’s important to collect relevant feature flag telemetry signals. These can be used to determine the impact a feature has on application behavior, enabling enhanced observability use cases, such as A/B testing or progressive feature releases.
The OpenTelemetry hooks for OpenFeature provide a [spec compliant][otel-spec] way to automatically add feature flag evaluation information to traces and metrics.
Since feature flags are dynamic and affect runtime behavior, it’s important to collect relevant feature flag telemetry signals.
These can be used to determine the impact a feature has on application behavior, enabling enhanced observability use cases, such as A/B testing or progressive feature releases.

## Installation

Expand Down Expand Up @@ -33,13 +35,16 @@ This hook performs metric collection by tapping into various hook stages. Below

## Usage

OpenFeature provides various ways to register hooks. The location that a hook is registered affects when the hook is run. It's recommended to register both the `TracingHook` and `MetricsHook` globally in most situations, but it's possible to only enable the hook on specific clients. You should **never** register these hooks both globally and on a client.
OpenFeature provides various ways to register hooks. The location that a hook is registered affects when the hook is run.
It's recommended to register both the `TracingHook` and `MetricsHook` globally in most situations, but it's possible to only enable the hook on specific clients.
You should **never** register these hooks both globally and on a client.

More information on hooks can be found in the [OpenFeature documentation][hook-concept].

### Register Globally

The `TracingHook` and `MetricsHook` can both be set on the OpenFeature singleton. This will ensure that every flag evaluation will always generate the applicable telemetry signals.
The `TracingHook` and `MetricsHook` can both be set on the OpenFeature singleton.
This will ensure that every flag evaluation will always generate the applicable telemetry signals.

```typescript
import { OpenFeature } from '@openfeature/js-sdk';
Expand All @@ -50,7 +55,8 @@ OpenFeature.addHooks(new TracingHook());

### Register Per Client

The `TracingHook` and `MetricsHook` can both be set on an individual client. This should only be done if it wasn't set globally and other clients shouldn't use this hook. Setting the hook on the client will ensure that every flag evaluation performed by this client will always generate the applicable telemetry signals.
The `TracingHook` and `MetricsHook` can both be set on an individual client. This should only be done if it wasn't set globally and other clients shouldn't use this hook.
Setting the hook on the client will ensure that every flag evaluation performed by this client will always generate the applicable telemetry signals.

```typescript
import { OpenFeature } from '@openfeature/js-sdk';
Expand Down

0 comments on commit d6f7c97

Please sign in to comment.