Skip to content

Commit 2f286b2

Browse files
committed
Code review
1 parent d68ca07 commit 2f286b2

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/proposals/observability.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To begin, the Observability Policy will include the following NGINX directives (
2929
- [`otel_trace`](https://nginx.org/en/docs/ngx_otel_module.html#otel_trace): enable tracing and set sampler rate
3030
- [`otel_trace_context`](https://nginx.org/en/docs/ngx_otel_module.html#otel_trace_context): export, inject, propagate, ignore.
3131
- [`otel_span_name`](https://nginx.org/en/docs/ngx_otel_module.html#otel_span_name)
32-
- [`otel_span_attr`](https://nginx.org/en/docs/ngx_otel_module.html#otel_span_attr)
32+
- [`otel_span_attr`](https://nginx.org/en/docs/ngx_otel_module.html#otel_span_attr): these span attributes will be merged with any set at the global level in the `GatewaySettings` config.
3333

3434
Tracing will be disabled by default. The Application Developer will be able to use this Policy to enable and configure tracing for their routes. This Policy will only be applied if the OTel endpoint has been set by the Cluster Operator on the [Gateway Settings](gateway-settings.md).
3535

@@ -90,6 +90,7 @@ type Tracing struct {
9090
Context *TraceContext `json:"context,omitempty"`
9191

9292
// SpanName defines the name of the Otel span. By default is the name of the location for a request.
93+
// If specified, applies to all locations that are created for a route.
9394
//
9495
// +optional
9596
SpanName *string `json:"spanName,omitempty"`
@@ -210,7 +211,7 @@ According to the [Policy and Metaresources GEP](https://gateway-api.sigs.k8s.io/
210211

211212
The `Accepted` Condition must be populated on the `ObservabilityPolicy` CRD using the reasons defined in the [PolicyCondition API](https://github.com/kubernetes-sigs/gateway-api/blob/main/apis/v1alpha2/policy_types.go). If these reasons are not sufficient, we can add implementation-specific reasons.
212213

213-
One reason for being `not Accepted` would be the fact that the `GatewaySettings` Policy is not configured, which is a requirement in order for the `ObservabilityPolicy` to work.
214+
One reason for being `not Accepted` would be the fact that the `GatewaySettings` Policy is not configured, which is a requirement in order for the `ObservabilityPolicy` to work. This will be a custom reason `GatewaySettingsNotSet`.
214215

215216
The Condition stanza may need to be namespaced using the `controllerName` if more than one controller could reconcile the Policy.
216217

0 commit comments

Comments
 (0)