diff --git a/hooks/open-telemetry/README.md b/hooks/open-telemetry/README.md index 31cc6ad86..949caab80 100644 --- a/hooks/open-telemetry/README.md +++ b/hooks/open-telemetry/README.md @@ -1,7 +1,7 @@ # OpenTelemetry Hook The OpenTelemetry hook for OpenFeature provides -a [spec compliant] (https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/feature-flags.md) +a [spec compliant](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/feature-flags.md) way to automatically add a feature flag evaluation to a span as a span event. This can be used to determine the impact a feature has on a request, enabling enhanced observability use cases, such as A/B testing or progressive feature releases. @@ -19,11 +19,11 @@ enabling enhanced observability use cases, such as A/B testing or progressive fe ## Usage -OpenFeature provider various ways to register hooks. The location that a hook is registered affects when the hook is +OpenFeature provides various ways to register hooks. The location where a hook is registered affects when the hook is run. It's recommended to register the `OpenTelemetryHook` globally in most situations, but it's possible to only enable the hook on specific clients. You should **never** register the `OpenTelemetryHook` both globally and on a client. -Consider following code example for usage, +Consider the following code example for usage, ```java final Tracer tracer = ... // derive Tracer from OpenTelemetry