From a2cd1d9e968d3dd4099b7a615bb95e05e3ae24c4 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Thu, 4 Mar 2021 12:17:13 +0530 Subject: [PATCH 1/3] api: Removed duplicate links. Signed-off-by: Manish Kumar --- api/envoy/config/accesslog/v3/accesslog.proto | 4 +--- api/envoy/config/accesslog/v4alpha/accesslog.proto | 4 +--- api/envoy/config/metrics/v3/stats.proto | 6 +----- api/envoy/config/metrics/v4alpha/stats.proto | 6 +----- api/envoy/config/overload/v3/overload.proto | 5 +---- api/envoy/config/trace/v3/http_tracer.proto | 7 +------ api/envoy/config/trace/v4alpha/http_tracer.proto | 7 +------ .../envoy/config/accesslog/v3/accesslog.proto | 4 +--- .../envoy/config/accesslog/v4alpha/accesslog.proto | 4 +--- generated_api_shadow/envoy/config/metrics/v3/stats.proto | 6 +----- .../envoy/config/metrics/v4alpha/stats.proto | 6 +----- .../envoy/config/overload/v3/overload.proto | 5 +---- .../envoy/config/trace/v3/http_tracer.proto | 7 +------ .../envoy/config/trace/v4alpha/http_tracer.proto | 7 +------ 14 files changed, 14 insertions(+), 64 deletions(-) diff --git a/api/envoy/config/accesslog/v3/accesslog.proto b/api/envoy/config/accesslog/v3/accesslog.proto index 6d494be4aea6d..1a9ed38768379 100644 --- a/api/envoy/config/accesslog/v3/accesslog.proto +++ b/api/envoy/config/accesslog/v3/accesslog.proto @@ -32,9 +32,7 @@ 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.access_loggers.file" - // #. "envoy.access_loggers.http_grpc" - // #. "envoy.access_loggers.tcp_grpc" + // See below for list of names in the :ref:`typed_config`. string name = 1; // Filter which is used to determine if the access log needs to be written. diff --git a/api/envoy/config/accesslog/v4alpha/accesslog.proto b/api/envoy/config/accesslog/v4alpha/accesslog.proto index 62bc8af6913bb..1ca8cbd2d49d5 100644 --- a/api/envoy/config/accesslog/v4alpha/accesslog.proto +++ b/api/envoy/config/accesslog/v4alpha/accesslog.proto @@ -32,9 +32,7 @@ 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.access_loggers.file" - // #. "envoy.access_loggers.http_grpc" - // #. "envoy.access_loggers.tcp_grpc" + // See below for list of names in the :ref:`typed_config`. string name = 1; // Filter which is used to determine if the access log needs to be written. diff --git a/api/envoy/config/metrics/v3/stats.proto b/api/envoy/config/metrics/v3/stats.proto index 307805e65ad8e..663bf3c9f517b 100644 --- a/api/envoy/config/metrics/v3/stats.proto +++ b/api/envoy/config/metrics/v3/stats.proto @@ -31,11 +31,7 @@ message StatsSink { // The name of the stats sink to instantiate. The name must match a supported // stats sink. The built-in stats sinks are: // - // * :ref:`envoy.stat_sinks.statsd ` - // * :ref:`envoy.stat_sinks.dog_statsd ` - // * :ref:`envoy.stat_sinks.metrics_service ` - // * :ref:`envoy.stat_sinks.hystrix ` - // + // See below for list of names in the :ref:`typed_config`. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/api/envoy/config/metrics/v4alpha/stats.proto b/api/envoy/config/metrics/v4alpha/stats.proto index 3a351cdd094c6..a6adf3f11d06d 100644 --- a/api/envoy/config/metrics/v4alpha/stats.proto +++ b/api/envoy/config/metrics/v4alpha/stats.proto @@ -31,11 +31,7 @@ message StatsSink { // The name of the stats sink to instantiate. The name must match a supported // stats sink. The built-in stats sinks are: // - // * :ref:`envoy.stat_sinks.statsd ` - // * :ref:`envoy.stat_sinks.dog_statsd ` - // * :ref:`envoy.stat_sinks.metrics_service ` - // * :ref:`envoy.stat_sinks.hystrix ` - // + // See below for list of names in the :ref:`typed_config`. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/api/envoy/config/overload/v3/overload.proto b/api/envoy/config/overload/v3/overload.proto index 8817fe0c291b4..5a30b7fddd9ae 100644 --- a/api/envoy/config/overload/v3/overload.proto +++ b/api/envoy/config/overload/v3/overload.proto @@ -34,10 +34,7 @@ message ResourceMonitor { // The name of the resource monitor to instantiate. Must match a registered // resource monitor type. The built-in resource monitors are: // - // * :ref:`envoy.resource_monitors.fixed_heap - // ` - // * :ref:`envoy.resource_monitors.injected_resource - // ` + // See below for list of names in the :ref:`typed_config`. string name = 1 [(validate.rules).string = {min_len: 1}]; // Configuration for the resource monitor being instantiated. diff --git a/api/envoy/config/trace/v3/http_tracer.proto b/api/envoy/config/trace/v3/http_tracer.proto index d0ba3ba6e4fdb..efd7761f4b861 100644 --- a/api/envoy/config/trace/v3/http_tracer.proto +++ b/api/envoy/config/trace/v3/http_tracer.proto @@ -45,12 +45,7 @@ message Tracing { // The name of the HTTP trace driver to instantiate. The name must match a // supported HTTP trace driver. Built-in trace drivers: // - // - *envoy.tracers.lightstep* - // - *envoy.tracers.zipkin* - // - *envoy.tracers.dynamic_ot* - // - *envoy.tracers.datadog* - // - *envoy.tracers.opencensus* - // - *envoy.tracers.xray* + // See below for list of names in the :ref:`typed_config`. string name = 1 [(validate.rules).string = {min_len: 1}]; // Trace driver specific configuration which depends on the driver being instantiated. diff --git a/api/envoy/config/trace/v4alpha/http_tracer.proto b/api/envoy/config/trace/v4alpha/http_tracer.proto index 4b8c681688425..75af987b26f3b 100644 --- a/api/envoy/config/trace/v4alpha/http_tracer.proto +++ b/api/envoy/config/trace/v4alpha/http_tracer.proto @@ -45,12 +45,7 @@ message Tracing { // The name of the HTTP trace driver to instantiate. The name must match a // supported HTTP trace driver. Built-in trace drivers: // - // - *envoy.tracers.lightstep* - // - *envoy.tracers.zipkin* - // - *envoy.tracers.dynamic_ot* - // - *envoy.tracers.datadog* - // - *envoy.tracers.opencensus* - // - *envoy.tracers.xray* + // See below for list of names in the :ref:`typed_config`. string name = 1 [(validate.rules).string = {min_len: 1}]; // Trace driver specific configuration which depends on the driver being instantiated. diff --git a/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto b/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto index b266ea21b9886..810b50c28558e 100644 --- a/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto +++ b/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto @@ -29,9 +29,7 @@ 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.access_loggers.file" - // #. "envoy.access_loggers.http_grpc" - // #. "envoy.access_loggers.tcp_grpc" + // See below for list of names in the :ref:`typed_config`. string name = 1; // Filter which is used to determine if the access log needs to be written. diff --git a/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto b/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto index 62bc8af6913bb..1ca8cbd2d49d5 100644 --- a/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto +++ b/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto @@ -32,9 +32,7 @@ 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.access_loggers.file" - // #. "envoy.access_loggers.http_grpc" - // #. "envoy.access_loggers.tcp_grpc" + // See below for list of names in the :ref:`typed_config`. string name = 1; // Filter which is used to determine if the access log needs to be written. diff --git a/generated_api_shadow/envoy/config/metrics/v3/stats.proto b/generated_api_shadow/envoy/config/metrics/v3/stats.proto index 77da528d50269..5ad61a9722d02 100644 --- a/generated_api_shadow/envoy/config/metrics/v3/stats.proto +++ b/generated_api_shadow/envoy/config/metrics/v3/stats.proto @@ -28,11 +28,7 @@ message StatsSink { // The name of the stats sink to instantiate. The name must match a supported // stats sink. The built-in stats sinks are: // - // * :ref:`envoy.stat_sinks.statsd ` - // * :ref:`envoy.stat_sinks.dog_statsd ` - // * :ref:`envoy.stat_sinks.metrics_service ` - // * :ref:`envoy.stat_sinks.hystrix ` - // + // See below for list of names in the :ref:`typed_config`. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto b/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto index 3a351cdd094c6..a6adf3f11d06d 100644 --- a/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto +++ b/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto @@ -31,11 +31,7 @@ message StatsSink { // The name of the stats sink to instantiate. The name must match a supported // stats sink. The built-in stats sinks are: // - // * :ref:`envoy.stat_sinks.statsd ` - // * :ref:`envoy.stat_sinks.dog_statsd ` - // * :ref:`envoy.stat_sinks.metrics_service ` - // * :ref:`envoy.stat_sinks.hystrix ` - // + // See below for list of names in the :ref:`typed_config`. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/generated_api_shadow/envoy/config/overload/v3/overload.proto b/generated_api_shadow/envoy/config/overload/v3/overload.proto index ae23dd3c69bb1..52af0c54ee0c6 100644 --- a/generated_api_shadow/envoy/config/overload/v3/overload.proto +++ b/generated_api_shadow/envoy/config/overload/v3/overload.proto @@ -31,10 +31,7 @@ message ResourceMonitor { // The name of the resource monitor to instantiate. Must match a registered // resource monitor type. The built-in resource monitors are: // - // * :ref:`envoy.resource_monitors.fixed_heap - // ` - // * :ref:`envoy.resource_monitors.injected_resource - // ` + // See below for list of names in the :ref:`typed_config`. string name = 1 [(validate.rules).string = {min_len: 1}]; // Configuration for the resource monitor being instantiated. diff --git a/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto b/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto index b679310769a57..cd1dba2816bfc 100644 --- a/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto +++ b/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto @@ -42,12 +42,7 @@ message Tracing { // The name of the HTTP trace driver to instantiate. The name must match a // supported HTTP trace driver. Built-in trace drivers: // - // - *envoy.tracers.lightstep* - // - *envoy.tracers.zipkin* - // - *envoy.tracers.dynamic_ot* - // - *envoy.tracers.datadog* - // - *envoy.tracers.opencensus* - // - *envoy.tracers.xray* + // See below for list of names in the :ref:`typed_config`. string name = 1 [(validate.rules).string = {min_len: 1}]; // Trace driver specific configuration which depends on the driver being instantiated. diff --git a/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto b/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto index 4b8c681688425..75af987b26f3b 100644 --- a/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto +++ b/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto @@ -45,12 +45,7 @@ message Tracing { // The name of the HTTP trace driver to instantiate. The name must match a // supported HTTP trace driver. Built-in trace drivers: // - // - *envoy.tracers.lightstep* - // - *envoy.tracers.zipkin* - // - *envoy.tracers.dynamic_ot* - // - *envoy.tracers.datadog* - // - *envoy.tracers.opencensus* - // - *envoy.tracers.xray* + // See below for list of names in the :ref:`typed_config`. string name = 1 [(validate.rules).string = {min_len: 1}]; // Trace driver specific configuration which depends on the driver being instantiated. From 77aca8c3cad7e99bf4eb2d1ccb577a74309eb30b Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Thu, 4 Mar 2021 15:34:59 +0530 Subject: [PATCH 2/3] Removed extensions list from typed_config. Signed-off-by: Manish Kumar --- api/envoy/config/accesslog/v3/accesslog.proto | 17 ++++------------- .../config/accesslog/v4alpha/accesslog.proto | 17 ++++------------- api/envoy/config/metrics/v3/stats.proto | 5 ++--- api/envoy/config/metrics/v4alpha/stats.proto | 5 ++--- api/envoy/config/overload/v3/overload.proto | 5 ++--- api/envoy/config/trace/v3/http_tracer.proto | 15 +++------------ .../config/trace/v4alpha/http_tracer.proto | 15 +++------------ .../envoy/config/accesslog/v3/accesslog.proto | 17 ++++------------- .../config/accesslog/v4alpha/accesslog.proto | 17 ++++------------- .../envoy/config/metrics/v3/stats.proto | 5 ++--- .../envoy/config/metrics/v4alpha/stats.proto | 5 ++--- .../envoy/config/overload/v3/overload.proto | 5 ++--- .../envoy/config/trace/v3/http_tracer.proto | 15 +++------------ .../config/trace/v4alpha/http_tracer.proto | 15 +++------------ 14 files changed, 40 insertions(+), 118 deletions(-) diff --git a/api/envoy/config/accesslog/v3/accesslog.proto b/api/envoy/config/accesslog/v3/accesslog.proto index 1a9ed38768379..ca7438c82910b 100644 --- a/api/envoy/config/accesslog/v3/accesslog.proto +++ b/api/envoy/config/accesslog/v3/accesslog.proto @@ -29,24 +29,15 @@ message AccessLog { reserved "config"; - // The name of the access log implementation to instantiate. The name must - // match a statically registered access log. Current built-in loggers include: - // - // See below for list of names in the :ref:`typed_config`. + // The name of the access log extension to instantiate. + // The name must match one of the compiled in loggers. + // See the :ref:`extensions listed in typed_config below ` for the default list of available loggers. string name = 1; // Filter which is used to determine if the access log needs to be written. AccessLogFilter filter = 2; - // Custom configuration that depends on the access log being instantiated. - // Built-in configurations include: - // - // #. "envoy.access_loggers.file": :ref:`FileAccessLog - // ` - // #. "envoy.access_loggers.http_grpc": :ref:`HttpGrpcAccessLogConfig - // ` - // #. "envoy.access_loggers.tcp_grpc": :ref:`TcpGrpcAccessLogConfig - // ` + // Custom configuration that must be set according to the access logger extension being instantiated. // [#extension-category: envoy.access_loggers] oneof config_type { google.protobuf.Any typed_config = 4; diff --git a/api/envoy/config/accesslog/v4alpha/accesslog.proto b/api/envoy/config/accesslog/v4alpha/accesslog.proto index 1ca8cbd2d49d5..bed654ccbbc98 100644 --- a/api/envoy/config/accesslog/v4alpha/accesslog.proto +++ b/api/envoy/config/accesslog/v4alpha/accesslog.proto @@ -29,24 +29,15 @@ message AccessLog { reserved "config"; - // The name of the access log implementation to instantiate. The name must - // match a statically registered access log. Current built-in loggers include: - // - // See below for list of names in the :ref:`typed_config`. + // The name of the access log extension to instantiate. + // The name must match one of the compiled in loggers. + // See the :ref:`extensions listed in typed_config below ` for the default list of available loggers. string name = 1; // Filter which is used to determine if the access log needs to be written. AccessLogFilter filter = 2; - // Custom configuration that depends on the access log being instantiated. - // Built-in configurations include: - // - // #. "envoy.access_loggers.file": :ref:`FileAccessLog - // ` - // #. "envoy.access_loggers.http_grpc": :ref:`HttpGrpcAccessLogConfig - // ` - // #. "envoy.access_loggers.tcp_grpc": :ref:`TcpGrpcAccessLogConfig - // ` + // Custom configuration that must be set according to the access logger extension being instantiated. // [#extension-category: envoy.access_loggers] oneof config_type { google.protobuf.Any typed_config = 4; diff --git a/api/envoy/config/metrics/v3/stats.proto b/api/envoy/config/metrics/v3/stats.proto index 663bf3c9f517b..4893b5504ac18 100644 --- a/api/envoy/config/metrics/v3/stats.proto +++ b/api/envoy/config/metrics/v3/stats.proto @@ -29,9 +29,8 @@ message StatsSink { reserved "config"; // The name of the stats sink to instantiate. The name must match a supported - // stats sink. The built-in stats sinks are: - // - // See below for list of names in the :ref:`typed_config`. + // stats sink. + // See the :ref:`extensions listed in typed_config below ` for the default list of available stats sink. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/api/envoy/config/metrics/v4alpha/stats.proto b/api/envoy/config/metrics/v4alpha/stats.proto index a6adf3f11d06d..e3f10f1da4f61 100644 --- a/api/envoy/config/metrics/v4alpha/stats.proto +++ b/api/envoy/config/metrics/v4alpha/stats.proto @@ -29,9 +29,8 @@ message StatsSink { reserved "config"; // The name of the stats sink to instantiate. The name must match a supported - // stats sink. The built-in stats sinks are: - // - // See below for list of names in the :ref:`typed_config`. + // stats sink. + // See the :ref:`extensions listed in typed_config below ` for the default list of available stats sink. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/api/envoy/config/overload/v3/overload.proto b/api/envoy/config/overload/v3/overload.proto index 5a30b7fddd9ae..4445af6321137 100644 --- a/api/envoy/config/overload/v3/overload.proto +++ b/api/envoy/config/overload/v3/overload.proto @@ -32,9 +32,8 @@ message ResourceMonitor { reserved "config"; // The name of the resource monitor to instantiate. Must match a registered - // resource monitor type. The built-in resource monitors are: - // - // See below for list of names in the :ref:`typed_config`. + // resource monitor type. + // See the :ref:`extensions listed in typed_config below ` for the default list of available resource monitor. string name = 1 [(validate.rules).string = {min_len: 1}]; // Configuration for the resource monitor being instantiated. diff --git a/api/envoy/config/trace/v3/http_tracer.proto b/api/envoy/config/trace/v3/http_tracer.proto index efd7761f4b861..8a3e452db5644 100644 --- a/api/envoy/config/trace/v3/http_tracer.proto +++ b/api/envoy/config/trace/v3/http_tracer.proto @@ -43,20 +43,11 @@ message Tracing { reserved "config"; // The name of the HTTP trace driver to instantiate. The name must match a - // supported HTTP trace driver. Built-in trace drivers: - // - // See below for list of names in the :ref:`typed_config`. + // supported HTTP trace driver. + // See the :ref:`extensions listed in typed_config below ` for the default list of the HTTP trace driver. string name = 1 [(validate.rules).string = {min_len: 1}]; - // Trace driver specific configuration which depends on the driver being instantiated. - // See the trace drivers for examples: - // - // - :ref:`LightstepConfig ` - // - :ref:`ZipkinConfig ` - // - :ref:`DynamicOtConfig ` - // - :ref:`DatadogConfig ` - // - :ref:`OpenCensusConfig ` - // - :ref:`AWS X-Ray ` + // Trace driver specific configuration which must be set according to the driver being instantiated. // [#extension-category: envoy.tracers] oneof config_type { google.protobuf.Any typed_config = 3; diff --git a/api/envoy/config/trace/v4alpha/http_tracer.proto b/api/envoy/config/trace/v4alpha/http_tracer.proto index 75af987b26f3b..3e896902c99f2 100644 --- a/api/envoy/config/trace/v4alpha/http_tracer.proto +++ b/api/envoy/config/trace/v4alpha/http_tracer.proto @@ -43,20 +43,11 @@ message Tracing { reserved "config"; // The name of the HTTP trace driver to instantiate. The name must match a - // supported HTTP trace driver. Built-in trace drivers: - // - // See below for list of names in the :ref:`typed_config`. + // supported HTTP trace driver. + // See the :ref:`extensions listed in typed_config below ` for the default list of the HTTP trace driver. string name = 1 [(validate.rules).string = {min_len: 1}]; - // Trace driver specific configuration which depends on the driver being instantiated. - // See the trace drivers for examples: - // - // - :ref:`LightstepConfig ` - // - :ref:`ZipkinConfig ` - // - :ref:`DynamicOtConfig ` - // - :ref:`DatadogConfig ` - // - :ref:`OpenCensusConfig ` - // - :ref:`AWS X-Ray ` + // Trace driver specific configuration which must be set according to the driver being instantiated. // [#extension-category: envoy.tracers] oneof config_type { google.protobuf.Any typed_config = 3; diff --git a/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto b/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto index 810b50c28558e..04d6cdd2fd852 100644 --- a/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto +++ b/generated_api_shadow/envoy/config/accesslog/v3/accesslog.proto @@ -26,24 +26,15 @@ message AccessLog { option (udpa.annotations.versioning).previous_message_type = "envoy.config.filter.accesslog.v2.AccessLog"; - // The name of the access log implementation to instantiate. The name must - // match a statically registered access log. Current built-in loggers include: - // - // See below for list of names in the :ref:`typed_config`. + // The name of the access log extension to instantiate. + // The name must match one of the compiled in loggers. + // See the :ref:`extensions listed in typed_config below ` for the default list of available loggers. string name = 1; // Filter which is used to determine if the access log needs to be written. AccessLogFilter filter = 2; - // Custom configuration that depends on the access log being instantiated. - // Built-in configurations include: - // - // #. "envoy.access_loggers.file": :ref:`FileAccessLog - // ` - // #. "envoy.access_loggers.http_grpc": :ref:`HttpGrpcAccessLogConfig - // ` - // #. "envoy.access_loggers.tcp_grpc": :ref:`TcpGrpcAccessLogConfig - // ` + // Custom configuration that must be set according to the access logger extension being instantiated. // [#extension-category: envoy.access_loggers] oneof config_type { google.protobuf.Any typed_config = 4; diff --git a/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto b/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto index 1ca8cbd2d49d5..bed654ccbbc98 100644 --- a/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto +++ b/generated_api_shadow/envoy/config/accesslog/v4alpha/accesslog.proto @@ -29,24 +29,15 @@ message AccessLog { reserved "config"; - // The name of the access log implementation to instantiate. The name must - // match a statically registered access log. Current built-in loggers include: - // - // See below for list of names in the :ref:`typed_config`. + // The name of the access log extension to instantiate. + // The name must match one of the compiled in loggers. + // See the :ref:`extensions listed in typed_config below ` for the default list of available loggers. string name = 1; // Filter which is used to determine if the access log needs to be written. AccessLogFilter filter = 2; - // Custom configuration that depends on the access log being instantiated. - // Built-in configurations include: - // - // #. "envoy.access_loggers.file": :ref:`FileAccessLog - // ` - // #. "envoy.access_loggers.http_grpc": :ref:`HttpGrpcAccessLogConfig - // ` - // #. "envoy.access_loggers.tcp_grpc": :ref:`TcpGrpcAccessLogConfig - // ` + // Custom configuration that must be set according to the access logger extension being instantiated. // [#extension-category: envoy.access_loggers] oneof config_type { google.protobuf.Any typed_config = 4; diff --git a/generated_api_shadow/envoy/config/metrics/v3/stats.proto b/generated_api_shadow/envoy/config/metrics/v3/stats.proto index 5ad61a9722d02..cc0e6d4ce24dd 100644 --- a/generated_api_shadow/envoy/config/metrics/v3/stats.proto +++ b/generated_api_shadow/envoy/config/metrics/v3/stats.proto @@ -26,9 +26,8 @@ message StatsSink { option (udpa.annotations.versioning).previous_message_type = "envoy.config.metrics.v2.StatsSink"; // The name of the stats sink to instantiate. The name must match a supported - // stats sink. The built-in stats sinks are: - // - // See below for list of names in the :ref:`typed_config`. + // stats sink. + // See the :ref:`extensions listed in typed_config below ` for the default list of available stats sink. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto b/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto index a6adf3f11d06d..e3f10f1da4f61 100644 --- a/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto +++ b/generated_api_shadow/envoy/config/metrics/v4alpha/stats.proto @@ -29,9 +29,8 @@ message StatsSink { reserved "config"; // The name of the stats sink to instantiate. The name must match a supported - // stats sink. The built-in stats sinks are: - // - // See below for list of names in the :ref:`typed_config`. + // stats sink. + // See the :ref:`extensions listed in typed_config below ` for the default list of available stats sink. // Sinks optionally support tagged/multiple dimensional metrics. string name = 1; diff --git a/generated_api_shadow/envoy/config/overload/v3/overload.proto b/generated_api_shadow/envoy/config/overload/v3/overload.proto index 52af0c54ee0c6..4b88b27def09e 100644 --- a/generated_api_shadow/envoy/config/overload/v3/overload.proto +++ b/generated_api_shadow/envoy/config/overload/v3/overload.proto @@ -29,9 +29,8 @@ message ResourceMonitor { "envoy.config.overload.v2alpha.ResourceMonitor"; // The name of the resource monitor to instantiate. Must match a registered - // resource monitor type. The built-in resource monitors are: - // - // See below for list of names in the :ref:`typed_config`. + // resource monitor type. + // See the :ref:`extensions listed in typed_config below ` for the default list of available resource monitor. string name = 1 [(validate.rules).string = {min_len: 1}]; // Configuration for the resource monitor being instantiated. diff --git a/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto b/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto index cd1dba2816bfc..80bd8a8ec4a9e 100644 --- a/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto +++ b/generated_api_shadow/envoy/config/trace/v3/http_tracer.proto @@ -40,20 +40,11 @@ message Tracing { "envoy.config.trace.v2.Tracing.Http"; // The name of the HTTP trace driver to instantiate. The name must match a - // supported HTTP trace driver. Built-in trace drivers: - // - // See below for list of names in the :ref:`typed_config`. + // supported HTTP trace driver. + // See the :ref:`extensions listed in typed_config below ` for the default list of the HTTP trace driver. string name = 1 [(validate.rules).string = {min_len: 1}]; - // Trace driver specific configuration which depends on the driver being instantiated. - // See the trace drivers for examples: - // - // - :ref:`LightstepConfig ` - // - :ref:`ZipkinConfig ` - // - :ref:`DynamicOtConfig ` - // - :ref:`DatadogConfig ` - // - :ref:`OpenCensusConfig ` - // - :ref:`AWS X-Ray ` + // Trace driver specific configuration which must be set according to the driver being instantiated. // [#extension-category: envoy.tracers] oneof config_type { google.protobuf.Any typed_config = 3; diff --git a/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto b/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto index 75af987b26f3b..3e896902c99f2 100644 --- a/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto +++ b/generated_api_shadow/envoy/config/trace/v4alpha/http_tracer.proto @@ -43,20 +43,11 @@ message Tracing { reserved "config"; // The name of the HTTP trace driver to instantiate. The name must match a - // supported HTTP trace driver. Built-in trace drivers: - // - // See below for list of names in the :ref:`typed_config`. + // supported HTTP trace driver. + // See the :ref:`extensions listed in typed_config below ` for the default list of the HTTP trace driver. string name = 1 [(validate.rules).string = {min_len: 1}]; - // Trace driver specific configuration which depends on the driver being instantiated. - // See the trace drivers for examples: - // - // - :ref:`LightstepConfig ` - // - :ref:`ZipkinConfig ` - // - :ref:`DynamicOtConfig ` - // - :ref:`DatadogConfig ` - // - :ref:`OpenCensusConfig ` - // - :ref:`AWS X-Ray ` + // Trace driver specific configuration which must be set according to the driver being instantiated. // [#extension-category: envoy.tracers] oneof config_type { google.protobuf.Any typed_config = 3; From 75068a544df60cddc7f90c4aa1218c2fa63a1968 Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Fri, 5 Mar 2021 10:24:15 +0000 Subject: [PATCH 3/3] add extension category docs tracer Signed-off-by: Ryan Northey --- tools/protodoc/protodoc.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tools/protodoc/protodoc.py b/tools/protodoc/protodoc.py index 7911d33e89426..364f96d5a8751 100755 --- a/tools/protodoc/protodoc.py +++ b/tools/protodoc/protodoc.py @@ -76,8 +76,12 @@ EXTENSION_CATEGORY_TEMPLATE = string.Template("""$anchor .. tip:: + EXTENSION_CATEGORY_TRACER + This extension category has the following known extensions: + + $extensions """)