Extract stats sink proto

taiki45 · taiki45 · commit 2acb78bf0b8c · 2017-12-06T05:39:09.000+09:00
Signed-off-by: Taiki Ono &lt;taiks.4559@gmail.com&gt;
diff --git a/api/BUILD b/api/BUILD
@@ -28,6 +28,7 @@ api_proto_library(
         ":cds",
         ":lds",
         ":sds",
+        ":stats",
     ],
 )
 
@@ -135,6 +136,14 @@ api_proto_library(
     ],
 )
 
+api_proto_library(
+    name = "stats",
+    srcs = ["stats.proto"],
+    deps = [
+        ":address",
+    ],
+)
+
 # TODO(htuch): Grow this to cover everything we want to generate docs for, so we can just invoke
 # bazel build //api --aspects tools/protodoc/protodoc.bzl%proto_doc_aspect  --output_groups=rst
 proto_library(
diff --git a/api/bootstrap.proto b/api/bootstrap.proto
@@ -12,6 +12,7 @@ import "api/base.proto";
 import "api/cds.proto";
 import "api/lds.proto";
 import "api/sds.proto";
+import "api/stats.proto";
 
 import "google/protobuf/duration.proto";
 import "google/protobuf/struct.proto";
@@ -203,38 +204,12 @@ message ClusterManager {
   ApiConfigSource load_stats_config = 4;
 }
 
-// Stats configuration proto schema for built-in *envoy.statsd* sink.
-message StatsdSink {
-  oneof statsd_specifier {
-    option (validate.required) = true;
-
-    // The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
-    // compliant listener. If specified, statistics will be flushed to this
-    // address.
-    Address address = 1;
-
-    // The name of a cluster that is running a TCP `statsd
-    // <https://github.com/etsy/statsd>`_ compliant listener. If specified,
-    // Envoy will connect to this cluster to flush statistics.
-    string tcp_cluster_name = 2;
-  }
-}
-
-// Stats configuration proto schema for built-in *envoy.dog_statsd* sink.
-// The sink emits stats with `DogStatsD <https://docs.datadoghq.com/guides/dogstatsd/>`_
-// compatible tags. Tags are configurable via :ref:`StatsConfig <envoy_api_msg_StatsConfig>`.
-message DogStatsdSink {
-  // The UDP address of a running DogStatsD compliant listener. If specified,
-  // statistics will be flushed to this address.
-  Address address = 1 [(validate.rules).message.required = true];
-}
-
 // Configuration for pluggable stats sinks.
 message StatsSink {
   // The name of the stats sink to instantiate. The name must match a supported
   // stats sink. *envoy.statsd* is a built-in sink suitable for emitting to
   // `statsd <https://github.com/etsy/statsd>`_. Any other built-in stats sink
-  // can be found in
+  // can be found in :ref:`Stats sinks<envoy_api_file_api/stats.proto>` or
   // `well_known_names.h
   // <https://github.com/envoyproxy/envoy/blob/master/source/common/config/well_known_names.h>`_
   // in the Envoy repository.
diff --git a/api/stats.proto b/api/stats.proto
@@ -0,0 +1,36 @@
+// [#protodoc-title: Stats sinks]
+// Protos for each pluggable stats sink configuration.
+
+syntax = "proto3";
+
+package envoy.api.v2;
+
+import "api/address.proto";
+
+import "validate/validate.proto";
+
+// Stats configuration proto schema for built-in *envoy.statsd* sink.
+message StatsdSink {
+  oneof statsd_specifier {
+    option (validate.required) = true;
+
+    // The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
+    // compliant listener. If specified, statistics will be flushed to this
+    // address.
+    Address address = 1;
+
+    // The name of a cluster that is running a TCP `statsd
+    // <https://github.com/etsy/statsd>`_ compliant listener. If specified,
+    // Envoy will connect to this cluster to flush statistics.
+    string tcp_cluster_name = 2;
+  }
+}
+
+// Stats configuration proto schema for built-in *envoy.dog_statsd* sink.
+// The sink emits stats with `DogStatsD <https://docs.datadoghq.com/guides/dogstatsd/>`_
+// compatible tags. Tags are configurable via :ref:`StatsConfig <envoy_api_msg_StatsConfig>`.
+message DogStatsdSink {
+  // The UDP address of a running DogStatsD compliant listener. If specified,
+  // statistics will be flushed to this address.
+  Address address = 1 [(validate.rules).message.required = true];
+}
diff --git a/docs/build.sh b/docs/build.sh
@@ -37,6 +37,7 @@ PROTO_RST="
   /api/rds/api/rds.proto.rst
   /api/rls/api/rls.proto.rst
   /api/sds/api/sds.proto.rst
+  /api/stats/api/stats.proto.rst
   /api/filter/accesslog/accesslog/api/filter/accesslog/accesslog.proto.rst
   /api/filter/fault/api/filter/fault.proto.rst
   /api/filter/http/buffer/api/filter/http/buffer.proto.rst
diff --git a/docs/root/api-v2/api.rst b/docs/root/api-v2/api.rst
@@ -14,6 +14,7 @@ v2 API reference
   health_check.proto
   rds.proto
   sds.proto
+  stats.proto
   base.proto
   address.proto
   protocol.proto
