access_loggers: use new-style names (#9921)

Modifies the well-known-names of the built-in access loggers to
use the same name as the extension build system.

Risk Level: low, previous name is still accepted
Testing: existing tests
Docs Changes: updated names
Release Notes: updated
Deprecated: old names are logged as deprecated

Signed-off-by: Stephan Zuercher <[email protected]>

api/envoy/config/accesslog/v2/als.proto

@@ -17,7 +17,7 @@ option (udpa.annotations.file_migrate).move_to_package = "envoy.extensions.acces
 
 // [#protodoc-title: gRPC Access Log Service (ALS)]
 
-// Configuration for the built-in *envoy.http_grpc_access_log*
+// Configuration for the built-in *envoy.access_loggers.http_grpc*
 // :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.AccessLog>`. This configuration will
 // populate :ref:`StreamAccessLogsMessage.http_logs
 // <envoy_api_field_service.accesslog.v2.StreamAccessLogsMessage.http_logs>`.
@@ -38,7 +38,7 @@ message HttpGrpcAccessLogConfig {
   repeated string additional_response_trailers_to_log = 4;
 }
 
-// Configuration for the built-in *envoy.tcp_grpc_access_log* type. This configuration will
+// Configuration for the built-in *envoy.access_loggers.tcp_grpc* type. This configuration will
 // populate *StreamAccessLogsMessage.tcp_logs*.
 // [#extension: envoy.access_loggers.tcp_grpc]
 message TcpGrpcAccessLogConfig {

api/envoy/config/accesslog/v2/file.proto

@@ -16,7 +16,7 @@ option (udpa.annotations.file_migrate).move_to_package = "envoy.extensions.acces
 // [#extension: envoy.access_loggers.file]
 
 // Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.AccessLog>`
-// that writes log entries directly to a file. Configures the built-in *envoy.file_access_log*
+// that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file*
 // AccessLog.
 message FileAccessLog {
   // A path to a local file to which to write the access log entries.

api/envoy/config/accesslog/v3/accesslog.proto

@@ -30,9 +30,9 @@ message AccessLog {
   // The name of the access log implementation to instantiate. The name must
   // match a statically registered access log. Current built-in loggers include:
   //
-  // #. "envoy.file_access_log"
-  // #. "envoy.http_grpc_access_log"
-  // #. "envoy.tcp_grpc_access_log"
+  // #. "envoy.access_loggers.file"
+  // #. "envoy.access_loggers.http_grpc"
+  // #. "envoy.access_loggers.tcp_grpc"
   string name = 1;
 
   // Filter which is used to determine if the access log needs to be written.
@@ -41,11 +41,11 @@ message AccessLog {
   // Custom configuration that depends on the access log being instantiated. Built-in
   // configurations include:
   //
-  // #. "envoy.file_access_log": :ref:`FileAccessLog
+  // #. "envoy.access_loggers.file": :ref:`FileAccessLog
   //    <envoy_api_msg_extensions.access_loggers.file.v3.FileAccessLog>`
-  // #. "envoy.http_grpc_access_log": :ref:`HttpGrpcAccessLogConfig
+  // #. "envoy.access_loggers.http_grpc": :ref:`HttpGrpcAccessLogConfig
   //    <envoy_api_msg_extensions.access_loggers.grpc.v3.HttpGrpcAccessLogConfig>`
-  // #. "envoy.tcp_grpc_access_log": :ref:`TcpGrpcAccessLogConfig
+  // #. "envoy.access_loggers.tcp_grpc": :ref:`TcpGrpcAccessLogConfig
   //    <envoy_api_msg_extensions.access_loggers.grpc.v3.TcpGrpcAccessLogConfig>`
   oneof config_type {
     google.protobuf.Any typed_config = 4;

api/envoy/config/filter/accesslog/v2/accesslog.proto

@@ -23,9 +23,9 @@ message AccessLog {
   // The name of the access log implementation to instantiate. The name must
   // match a statically registered access log. Current built-in loggers include:
   //
-  // #. "envoy.file_access_log"
-  // #. "envoy.http_grpc_access_log"
-  // #. "envoy.tcp_grpc_access_log"
+  // #. "envoy.access_loggers.file"
+  // #. "envoy.access_loggers.http_grpc"
+  // #. "envoy.access_loggers.tcp_grpc"
   string name = 1;
 
   // Filter which is used to determine if the access log needs to be written.
@@ -34,11 +34,11 @@ message AccessLog {
   // Custom configuration that depends on the access log being instantiated. Built-in
   // configurations include:
   //
-  // #. "envoy.file_access_log": :ref:`FileAccessLog
+  // #. "envoy.access_loggers.file": :ref:`FileAccessLog
   //    <envoy_api_msg_config.accesslog.v2.FileAccessLog>`
-  // #. "envoy.http_grpc_access_log": :ref:`HttpGrpcAccessLogConfig
+  // #. "envoy.access_loggers.http_grpc": :ref:`HttpGrpcAccessLogConfig
   //    <envoy_api_msg_config.accesslog.v2.HttpGrpcAccessLogConfig>`
-  // #. "envoy.tcp_grpc_access_log": :ref:`TcpGrpcAccessLogConfig
+  // #. "envoy.access_loggers.tcp_grpc": :ref:`TcpGrpcAccessLogConfig
   //    <envoy_api_msg_config.accesslog.v2.TcpGrpcAccessLogConfig>`
   oneof config_type {
     google.protobuf.Struct config = 3 [deprecated = true];

api/envoy/extensions/access_loggers/file/v3/file.proto

@@ -16,7 +16,7 @@ option java_multiple_files = true;
 // [#extension: envoy.access_loggers.file]
 
 // Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.accesslog.v3.AccessLog>`
-// that writes log entries directly to a file. Configures the built-in *envoy.file_access_log*
+// that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file*
 // AccessLog.
 message FileAccessLog {
   option (udpa.annotations.versioning).previous_message_type =

api/envoy/extensions/access_loggers/grpc/v3/als.proto

@@ -17,7 +17,7 @@ option java_multiple_files = true;
 
 // [#protodoc-title: gRPC Access Log Service (ALS)]
 
-// Configuration for the built-in *envoy.http_grpc_access_log*
+// Configuration for the built-in *envoy.access_loggers.http_grpc*
 // :ref:`AccessLog <envoy_api_msg_config.accesslog.v3.AccessLog>`. This configuration will
 // populate :ref:`StreamAccessLogsMessage.http_logs
 // <envoy_api_field_service.accesslog.v3.StreamAccessLogsMessage.http_logs>`.
@@ -41,7 +41,7 @@ message HttpGrpcAccessLogConfig {
   repeated string additional_response_trailers_to_log = 4;
 }
 
-// Configuration for the built-in *envoy.tcp_grpc_access_log* type. This configuration will
+// Configuration for the built-in *envoy.access_loggers.tcp_grpc* type. This configuration will
 // populate *StreamAccessLogsMessage.tcp_logs*.
 // [#extension: envoy.access_loggers.tcp_grpc]
 message TcpGrpcAccessLogConfig {

configs/envoy_double_proxy_v2.template.yaml

@@ -63,7 +63,7 @@
         common_http_protocol_options:
           idle_timeout: 840s
         access_log:
-        - name: envoy.file_access_log
+        - name: envoy.access_loggers.file
           filter:
             or_filter:
               filters:

configs/envoy_front_proxy_v2.template.yaml

@@ -73,7 +73,7 @@
         common_http_protocol_options:
           idle_timeout: 840s
         access_log:
-        - name: envoy.file_access_log
+        - name: envoy.access_loggers.file
           filter:
             or_filter:
               filters:

configs/envoy_service_to_service_v2.template.yaml

@@ -48,14 +48,14 @@
         - name: envoy.router
           typed_config: {}
         access_log:
-        - name: envoy.file_access_log
+        - name: envoy.access_loggers.file
           filter:
             not_health_check_filter:  {}
           typed_config:
             "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
             path: "/var/log/envoy/ingress_http.log"
             {{ access_log_helper.ingress_full()|indent(10)}}
-        - name: envoy.file_access_log
+        - name: envoy.access_loggers.file
           filter:
             and_filter:
               filters:
@@ -84,7 +84,7 @@
             "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
             path: "/var/log/envoy/ingress_http_error.log"
             {{ access_log_helper.ingress_sampled_log()|indent(10)}}
-        - name: envoy.file_access_log
+        - name: envoy.access_loggers.file
           filter:
             and_filter:
               filters:
@@ -131,7 +131,7 @@ static_resources:
           common_http_protocol_options:
             idle_timeout: 840s
           access_log:
-          - name: envoy.file_access_log
+          - name: envoy.access_loggers.file
             filter:
               or_filter:
                 filters:
@@ -192,7 +192,7 @@ static_resources:
           common_http_protocol_options:
             idle_timeout: 840s
           access_log:
-          - name: envoy.file_access_log
+          - name: envoy.access_loggers.file
             filter:
               or_filter:
                 filters:
@@ -270,7 +270,7 @@ static_resources:
           - name: envoy.router
             typed_config: {}
           access_log:
-          - name: envoy.file_access_log
+          - name: envoy.access_loggers.file
             filter:
               or_filter:
                 filters:

docs/root/configuration/http/http_filters/grpc_http1_reverse_bridge_filter.rst

@@ -63,7 +63,7 @@ How to disable HTTP/1.1 reverse bridge filter per route
           typed_config:
             "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
             access_log:
-            - name: envoy.file_access_log
+            - name: envoy.access_loggers.file
               typed_config:
                 "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
                 path: /dev/stdout

docs/root/intro/deprecated.rst

@@ -15,6 +15,16 @@ Deprecated items below are listed in chronological order.
 * The previous behavior for upstream connection pool circuit breaking described
   `here <https://www.envoyproxy.io/docs/envoy/v1.13.0/intro/arch_overview/upstream/circuit_breaking>`_ has
   been deprecated in favor of the new behavior described :ref:`here <arch_overview_circuit_break>`.
+* Access Logger names have been deprecated in favor of the extension name from the envoy build
+  system.
+
+  .. csv-table::
+    :header: Canonical Names, Deprecated Names
+    :widths: 1, 1
+
+    envoy.access_loggers.file, envoy.file_access_log
+    envoy.access_loggers.http_grpc, envoy.http_grpc_access_log
+    envoy.access_loggers.tcp_grpc, envoy.tcp_grpc_access_log
 
 1.13.0 (January 20, 2020)
 =========================

docs/root/intro/version_history.rst

@@ -3,6 +3,8 @@ Version history
 
 1.14.0 (Pending)
 ================
+* access loggers: access logger extensions use the "envoy.access_loggers" name space. A mapping
+  of extension names is available in the :ref:`deprecated <deprecated>` documentation.
 * config: use type URL to select an extension whenever the config type URL (or its previous versions) uniquely identify a typed extension, see :ref:`extension configuration <config_overview_extension_configuration>`.
 * http: fixing a bug in HTTP/1.0 responses where Connection: keep-alive was not appended for connections which were kept alive.
 * retry: added a retry predicate that :ref:`rejects hosts based on metadata. <envoy_api_field_route.RetryPolicy.retry_host_predicate>`
@@ -17,7 +19,7 @@ Version history
   "envoy.reloadable_features.new_http2_connection_pool_behavior" and then re-configure your clusters or
   restart Envoy. The behavior will not switch until the connection pools are recreated. The new
   circuit breaker behavior is described :ref:`here <arch_overview_circuit_break>`.
-* upstream: changed load distribution algorithm when all priorities enter :ref:`panic mode<arch_overview_load_balancing_panic_threshold>`. 
+* upstream: changed load distribution algorithm when all priorities enter :ref:`panic mode<arch_overview_load_balancing_panic_threshold>`.
 
 1.13.0 (January 20, 2020)
 =========================

examples/cors/backend/front-envoy.yaml

@@ -12,7 +12,7 @@ static_resources:
           codec_type: auto
           stat_prefix: ingress_http
           access_log:
-            - name: envoy.file_access_log
+            - name: envoy.access_loggers.file
               typed_config:
                 "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
                 path: "/var/log/access.log"

examples/cors/frontend/front-envoy.yaml

@@ -12,7 +12,7 @@ static_resources:
           codec_type: auto
           stat_prefix: ingress_http
           access_log:
-            - name: envoy.file_access_log
+            - name: envoy.access_loggers.file
               typed_config:
                 "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
                 path: "/var/log/access.log"

examples/csrf/crosssite/front-envoy.yaml

@@ -12,7 +12,7 @@ static_resources:
           codec_type: auto
           stat_prefix: ingress_http
           access_log:
-            - name: envoy.file_access_log
+            - name: envoy.access_loggers.file
               typed_config:
                 "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
                 path: "/var/log/access.log"

examples/csrf/samesite/front-envoy.yaml

@@ -12,7 +12,7 @@ static_resources:
           codec_type: auto
           stat_prefix: ingress_http
           access_log:
-            - name: envoy.file_access_log
+            - name: envoy.access_loggers.file
               typed_config:
                 "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
                 path: "/var/log/access.log"

examples/fault-injection/envoy.yaml

@@ -12,7 +12,7 @@ static_resources:
           codec_type: auto
           stat_prefix: ingress_http
           access_log:
-            name: envoy.file_access_log
+            name: envoy.access_loggers.file
             typed_config:
               "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
               path: /dev/stdout

examples/grpc-bridge/client/envoy-proxy.yaml

@@ -12,7 +12,7 @@ static_resources:
           codec_type: auto
           add_user_agent: true
           access_log:
-          - name: envoy.file_access_log
+          - name: envoy.access_loggers.file
             typed_config:
               "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
               path: "/dev/stdout"

examples/grpc-bridge/server/envoy-proxy.yaml

@@ -12,7 +12,7 @@ static_resources:
           codec_type: auto
           stat_prefix: ingress_http
           access_log:
-          - name: envoy.file_access_log
+          - name: envoy.access_loggers.file
             typed_config:
               "@type": type.googleapis.com/envoy.config.accesslog.v2.FileAccessLog
               path: "/dev/stdout"