Cherry-pick #22445 to 7.x: Nats module improvements (#22614)

* Nats module improvements (#22445)


(cherry picked from commit 70ff0a7)

* Update CHANGELOG.next.asciidoc

CHANGELOG.next.asciidoc

@@ -593,6 +593,7 @@ same journal. {pull}18467[18467]
 - Expand unsupported option from namespace to metrics in the azure module. {pull}21486[21486]
 - Move s3_daily_storage and s3_request metricsets to use cloudwatch input. {pull}21703[21703]
 - Duplicate system.process.cmdline field with process.command_line ECS field name. {pull}22325[22325]
+- Add connection and route metricsets for nats metricbeat module to collect metrics per connection/route. {pull}22445[22445]
 - Add unit file states to system/service {pull}22557[22557]
 
 *Packetbeat*

metricbeat/docs/fields.asciidoc

@@ -35503,13 +35503,137 @@ type: keyword
 *`nats.server.time`*::
 +
 --
+
+deprecated:[8.0.0]
+
 Server time of metric creation
 
 
 type: date
 
 --
 
+[float]
+=== connection
+
+Contains nats connection related metrics
+
+
+
+*`nats.connection.name`*::
++
+--
+The name of the connection
+
+
+type: keyword
+
+--
+
+*`nats.connection.subscriptions`*::
++
+--
+The number of subscriptions in this connection
+
+
+type: integer
+
+--
+
+*`nats.connection.pending_bytes`*::
++
+--
+The number of pending bytes of this connection
+
+
+type: long
+
+format: bytes
+
+--
+
+*`nats.connection.uptime`*::
++
+--
+The period the connection is up (sec)
+
+
+type: long
+
+format: duration
+
+--
+
+*`nats.connection.idle_time`*::
++
+--
+The period the connection is idle (sec)
+
+
+type: long
+
+format: duration
+
+--
+
+[float]
+=== in
+
+The amount of incoming data
+
+
+
+*`nats.connection.in.messages`*::
++
+--
+The amount of incoming messages
+
+
+type: long
+
+--
+
+*`nats.connection.in.bytes`*::
++
+--
+The amount of incoming bytes
+
+
+type: long
+
+format: bytes
+
+--
+
+[float]
+=== out
+
+The amount of outgoing data
+
+
+
+*`nats.connection.out.messages`*::
++
+--
+The amount of outgoing messages
+
+
+type: long
+
+--
+
+*`nats.connection.out.bytes`*::
++
+--
+The amount of outgoing bytes
+
+
+type: long
+
+format: bytes
+
+--
+
 [float]
 === connections
 
@@ -35527,6 +35651,121 @@ type: integer
 
 --
 
+[float]
+=== route
+
+Contains nats route related metrics
+
+
+
+*`nats.route.subscriptions`*::
++
+--
+The number of subscriptions in this connection
+
+
+type: integer
+
+--
+
+*`nats.route.remote_id`*::
++
+--
+The remote id on which the route is connected to
+
+
+type: keyword
+
+--
+
+*`nats.route.pending_size`*::
++
+--
+The number of pending routes
+
+
+type: long
+
+--
+
+*`nats.route.port`*::
++
+--
+The port of the route
+
+
+type: integer
+
+--
+
+*`nats.route.ip`*::
++
+--
+The ip of the route
+
+
+type: ip
+
+--
+
+[float]
+=== in
+
+The amount of incoming data
+
+
+
+*`nats.route.in.messages`*::
++
+--
+The amount of incoming messages
+
+
+type: long
+
+--
+
+*`nats.route.in.bytes`*::
++
+--
+The amount of incoming bytes
+
+
+type: long
+
+format: bytes
+
+--
+
+[float]
+=== out
+
+The amount of outgoing data
+
+
+
+*`nats.route.out.messages`*::
++
+--
+The amount of outgoing messages
+
+
+type: long
+
+--
+
+*`nats.route.out.bytes`*::
++
+--
+The amount of outgoing bytes
+
+
+type: long
+
+format: bytes
+
+--
+
 [float]
 === routes
 

metricbeat/docs/modules/nats.asciidoc

@@ -7,7 +7,8 @@ This file is generated! See scripts/mage/docs_collector.go
 
 This is the Nats module. The Nats module uses https://nats.io/documentation/managing_the_server/monitoring/[Nats monitoring server APIs] to collect metrics.
 
-The default metricsets are `stats`, `connections`, `routes` and `subscriptions`.
+The default metricsets are `stats`, `connections`, `routes` and `subscriptions` while `connection` and `route`
+metricsets can be enabled to collect detailed metrics per connection/route.
 
 [float]
 === Compatibility
@@ -33,30 +34,46 @@ in <<configuration-metricbeat>>. Here is an example configuration:
 ----
 metricbeat.modules:
 - module: nats
-  metricsets: ["connections", "routes", "stats", "subscriptions"]
+  metricsets:
+    - "connections"
+    - "routes"
+    - "stats"
+    - "subscriptions"
+    #- "connection"
+    #- "route"
   period: 10s
   hosts: ["localhost:8222"]
   #stats.metrics_path: "/varz"
   #connections.metrics_path: "/connz"
   #routes.metrics_path: "/routez"
   #subscriptions.metrics_path: "/subsz"
+  #connection.metrics_path: "/connz"
+  #route.metrics_path: "/routez"
 ----
 
 [float]
 === Metricsets
 
 The following metricsets are available:
 
+* <<metricbeat-metricset-nats-connection,connection>>
+
 * <<metricbeat-metricset-nats-connections,connections>>
 
+* <<metricbeat-metricset-nats-route,route>>
+
 * <<metricbeat-metricset-nats-routes,routes>>
 
 * <<metricbeat-metricset-nats-stats,stats>>
 
 * <<metricbeat-metricset-nats-subscriptions,subscriptions>>
 
+include::nats/connection.asciidoc[]
+
 include::nats/connections.asciidoc[]
 
+include::nats/route.asciidoc[]
+
 include::nats/routes.asciidoc[]
 
 include::nats/stats.asciidoc[]

metricbeat/docs/modules/nats/connection.asciidoc

@@ -0,0 +1,21 @@
+////
+This file is generated! See scripts/mage/docs_collector.go
+////
+
+[[metricbeat-metricset-nats-connection]]
+=== NATS connection metricset
+
+include::../../../module/nats/connection/_meta/docs.asciidoc[]
+
+
+==== Fields
+
+For a description of each field in the metricset, see the
+<<exported-fields-nats,exported fields>> section.
+
+Here is an example document generated by this metricset:
+
+[source,json]
+----
+include::../../../module/nats/connection/_meta/data.json[]
+----

metricbeat/docs/modules/nats/route.asciidoc

@@ -0,0 +1,21 @@
+////
+This file is generated! See scripts/mage/docs_collector.go
+////
+
+[[metricbeat-metricset-nats-route]]
+=== NATS route metricset
+
+include::../../../module/nats/route/_meta/docs.asciidoc[]
+
+
+==== Fields
+
+For a description of each field in the metricset, see the
+<<exported-fields-nats,exported fields>> section.
+
+Here is an example document generated by this metricset:
+
+[source,json]
+----
+include::../../../module/nats/route/_meta/data.json[]
+----

metricbeat/docs/modules_list.asciidoc

@@ -205,7 +205,9 @@ This file is generated! See scripts/mage/docs_collector.go
 |<<metricbeat-metricset-mysql-query,query>> beta[]  
 |<<metricbeat-metricset-mysql-status,status>>   
 |<<metricbeat-module-nats,NATS>>     |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
-.4+| .4+|  |<<metricbeat-metricset-nats-connections,connections>>   
+.6+| .6+|  |<<metricbeat-metricset-nats-connection,connection>>   
+|<<metricbeat-metricset-nats-connections,connections>>   
+|<<metricbeat-metricset-nats-route,route>>   
 |<<metricbeat-metricset-nats-routes,routes>>   
 |<<metricbeat-metricset-nats-stats,stats>>   
 |<<metricbeat-metricset-nats-subscriptions,subscriptions>>