-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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.
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
[cluster] Use alt_stat_name
for general observability purposes (access log, tracing, admin)
#15139
Conversation
Signed-off-by: Asra Ali <[email protected]>
Signed-off-by: Asra Ali <[email protected]>
Signed-off-by: Asra Ali <[email protected]>
Signed-off-by: Asra Ali <[email protected]>
Signed-off-by: Asra Ali <[email protected]>
Signed-off-by: Asra Ali <[email protected]>
Signed-off-by: Asra Ali <[email protected]>
Signed-off-by: Asra Ali <[email protected]>
@zuercher could you please take a look or assign to someone else? Also happy to split this up (although there is not too much complexity) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Signed-off-by: Asra Ali <[email protected]>
@envoyproxy/api-shepherds could you PTAL for API changes? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
API LGTM modulo one typo I found (I think).
@@ -46,6 +48,7 @@ Minor Behavior Changes | |||
* oauth filter: added the optional parameter :ref:`auth_scopes <envoy_v3_api_field_extensions.filters.http.oauth2.v3alpha.OAuth2Config.auth_scopes>` with default value of 'user' if not provided. Enables this value to be overridden in the Authorization request to the OAuth provider. | |||
* perf: allow reading more bytes per operation from raw sockets to improve performance. | |||
* router: extended custom date formatting to DOWNSTREAM_PEER_CERT_V_START and DOWNSTREAM_PEER_CERT_V_END when using :ref:`custom request/response header formats <config_http_conn_man_headers_custom_request_headers>`. | |||
* tracing: added `upstream_address.name` tag that resolves to resolve to :ref:`alt_stat_name <envoy_v3_api_field_config.cluster.v3.Cluster.alt_stat_name>` if provided (and otherwise the cluster name). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* tracing: added `upstream_address.name` tag that resolves to resolve to :ref:`alt_stat_name <envoy_v3_api_field_config.cluster.v3.Cluster.alt_stat_name>` if provided (and otherwise the cluster name). | |
* tracing: added `upstream_cluster.name` tag that resolves to resolve to :ref:`alt_stat_name <envoy_v3_api_field_config.cluster.v3.Cluster.alt_stat_name>` if provided (and otherwise the cluster name). |
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! Thanks. Fixed
Signed-off-by: Asra Ali <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
API LGTM!
@zuercher sorry for the re-ping, the typo-fix dropped the LGTM but I think this is ready to merge! |
#19475) See #15139 ([cluster] Use alt_stat_name for general observability purposes (access log, tracing, admin)), which introduced a runtime guarded feature, which has been enabled by default for 6 months, so remove the old code path. Risk Level: Low Testing: n/a Docs Changes: updated Release Notes: Deprecate envoy.reloadable_features.use_observable_cluster_name. Platform Specific Features: n/a Signed-off-by: Loong <[email protected]>
envoyproxy#19475) See envoyproxy#15139 ([cluster] Use alt_stat_name for general observability purposes (access log, tracing, admin)), which introduced a runtime guarded feature, which has been enabled by default for 6 months, so remove the old code path. Risk Level: Low Testing: n/a Docs Changes: updated Release Notes: Deprecate envoy.reloadable_features.use_observable_cluster_name. Platform Specific Features: n/a Signed-off-by: Loong <[email protected]> Signed-off-by: Josh Perry <[email protected]>
Commit Message: Re-purpose
alt_stat_name
for other observability use-cases: access logging, tracing, and admin dumps.Additional Description:
ClusterInfo
is added,observabilityName()
that is thealt_stat_name
if provided, and otherwise the Cluster name.%UPSTREAM_CLUSTER%
resolves toobservabilityName()
.upstream_cluster.name
is added to referenceobservabilityName()
.config_dump
in the cluster configuration. TheClusterStatus
adds theobservability_name
field.Risk Level: Low, just adds observability.
Testing: Added tests for access logging with/without runtime feature enabled.
Docs Changes: Added doc changes to Access Log page, Tracing page.
Release Notes: Added release notes for all three new uses cases.
Fixes: #14309
Runtime guard: Added runtime guard
envoy.reloadable_features.use_observable_cluster_name
that controls whether formatter%UPSTREAM_CLUSTER% resolves to original cluster name or
alt_stat_name.API considerations: Tagged
alt_stat_name
for general purpose renameobservability_name
.