add metricbeat benchmark module (#41801)

* add metricbeat benchmark module --------- Co-authored-by: Shaunak Kashyap <[email protected]>
elastic · Dec 4, 2024 · 9c45417 · 9c45417
1 parent 3f51793
commit 9c45417
Show file tree

Hide file tree

Showing 20 changed files with 480 additions and 34 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -408,6 +408,7 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]
 - Add support for location label as an optional configuration parameter in GCP metrics metricset. {issue}41550[41550] {pull}41626[41626]
 
 *Metricbeat*
+- Add benchmark module {pull}41801[41801]
 
 
 *Osquerybeat*

diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -23,6 +23,7 @@ grouped in the following categories:
 * <<exported-fields-azure>>
 * <<exported-fields-beat-common>>
 * <<exported-fields-beat>>
+* <<exported-fields-benchmark>>
 * <<exported-fields-ceph>>
 * <<exported-fields-cloud>>
 * <<exported-fields-cloudfoundry>>
@@ -10472,6 +10473,36 @@ type: long
 
 --
 
+[[exported-fields-benchmark]]
+== Benchmark fields
+
+benchmark module
+
+
+
+[float]
+=== benchmark
+
+
+
+
+[float]
+=== info
+
+info
+
+
+
+*`benchmark.info.counter`*::
++
+--
+The nth info metric emitted by the benchmark module
+
+
+type: keyword
+
+--
+
 [[exported-fields-ceph]]
 == Ceph fields
 

diff --git a/metricbeat/docs/modules/benchmark.asciidoc b/metricbeat/docs/modules/benchmark.asciidoc
@@ -0,0 +1,76 @@
+////
+This file is generated! See scripts/mage/docs_collector.go
+////
+
+:modulename: benchmark
+:edit_url: https://github.com/elastic/beats/edit/main/x-pack/metricbeat/module/benchmark/_meta/docs.asciidoc
+
+
+[[metricbeat-module-benchmark]]
+[role="xpack"]
+== Benchmark module
+
+beta[]
+
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
+
+The `benchmark` module is used to generate synthetic metrics at a predictable rate.  This can be useful when you want to test output settings or test system sizing without using real data.
+
+The `benchmark` module metricset is `info`.
+
+[source,yaml]
+----
+- module: benchmark
+  metricsets:
+    - info
+  enabled: true
+  period: 10s
+----
+
+[float]
+== Metricsets
+
+[float]
+=== `info`
+A metric that includes a `counter` field which is used to keep the metric unique.
+
+[float]
+=== Module-specific configuration notes
+
+`count`:: number, the number of metrics to emit per fetch.
+
+
+
+
+
+:edit_url:
+
+[float]
+=== Example configuration
+
+The Benchmark module supports the standard configuration options that are described
+in <<configuration-metricbeat>>. Here is an example configuration:
+
+[source,yaml]
+----
+metricbeat.modules:
+- module: benchmark
+  metricsets:
+    - info
+  enabled: false
+  period: 10s
+
+----
+
+[float]
+=== Metricsets
+
+The following metricsets are available:
+
+* <<metricbeat-metricset-benchmark-info,info>>
+
+include::benchmark/info.asciidoc[]
+
+:edit_url!:
diff --git a/metricbeat/docs/modules/benchmark/info.asciidoc b/metricbeat/docs/modules/benchmark/info.asciidoc
@@ -0,0 +1,29 @@
+////
+This file is generated! See scripts/mage/docs_collector.go
+////
+:edit_url: https://github.com/elastic/beats/edit/main/x-pack/metricbeat/module/benchmark/info/_meta/docs.asciidoc
+
+
+[[metricbeat-metricset-benchmark-info]]
+[role="xpack"]
+=== Benchmark info metricset
+
+beta[]
+
+include::../../../../x-pack/metricbeat/module/benchmark/info/_meta/docs.asciidoc[]
+
+
+:edit_url:
+
+==== Fields
+
+For a description of each field in the metricset, see the
+<<exported-fields-benchmark,exported fields>> section.
+
+Here is an example document generated by this metricset:
+
+[source,json]
+----
+include::../../../../x-pack/metricbeat/module/benchmark/info/_meta/data.json[]
+----
+:edit_url!:
diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc
@@ -51,6 +51,8 @@ This file is generated! See scripts/mage/docs_collector.go
 |<<metricbeat-module-beat,Beat>>     |image:./images/icon-no.png[No prebuilt dashboards]    |  
 .2+| .2+|  |<<metricbeat-metricset-beat-state,state>>   
 |<<metricbeat-metricset-beat-stats,stats>>   
+|<<metricbeat-module-benchmark,Benchmark>>  beta[]   |image:./images/icon-no.png[No prebuilt dashboards]    |  
+.1+| .1+|  |<<metricbeat-metricset-benchmark-info,info>> beta[]  
 |<<metricbeat-module-ceph,Ceph>>     |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
 .13+| .13+|  |<<metricbeat-metricset-ceph-cluster_disk,cluster_disk>>   
 |<<metricbeat-metricset-ceph-cluster_health,cluster_health>>   
@@ -344,6 +346,7 @@ include::modules/aws.asciidoc[]
 include::modules/awsfargate.asciidoc[]
 include::modules/azure.asciidoc[]
 include::modules/beat.asciidoc[]
+include::modules/benchmark.asciidoc[]
 include::modules/ceph.asciidoc[]
 include::modules/cloudfoundry.asciidoc[]
 include::modules/cockroachdb.asciidoc[]

diff --git a/x-pack/metricbeat/include/list.go b/x-pack/metricbeat/include/list.go
diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml
@@ -404,6 +404,14 @@ metricbeat.modules:
   # Monitoring instead of metricbeat-* indices.
   #xpack.enabled: false
 
+#------------------------------ Benchmark Module ------------------------------
+- module: benchmark
+  metricsets:
+    - info
+  enabled: false
+  period: 10s
+
+
 #--------------------------------- Ceph Module ---------------------------------
 # Metricsets depending on the Ceph REST API (default port: 5000)
 - module: ceph
@@ -1356,9 +1364,11 @@ metricbeat.modules:
   # Password to use when connecting to PostgreSQL. Empty by default.
   #password: pass
 
-#----------------------- Prometheus Typed Metrics Module -----------------------
+#------------------------------ Prometheus Module ------------------------------
+# Metrics collected from a Prometheus endpoint
 - module: prometheus
   period: 10s
+  metricsets: ["collector"]
   hosts: ["localhost:9090"]
   metrics_path: /metrics
   #metrics_filters:
@@ -1367,45 +1377,27 @@ metricbeat.modules:
   #username: "user"
   #password: "secret"
 
+  # Count number of metrics present in Elasticsearch document (default: false)
+  #metrics_count: false
+
   # This can be used for service account based authorization:
   #bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
   #ssl.certificate_authorities:
   #  - /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
 
-  # Count number of metrics present in Elasticsearch document (default: false)
-  #metrics_count: false
-
-  # Use Elasticsearch histogram type to store histograms (beta, default: false)
-  # This will change the default layout and put metric type in the field name
-  #use_types: true
-
-  # Store counter rates instead of original cumulative counters (experimental, default: false)
-  #rate_counters: true
 
 # Metrics sent by a Prometheus server using remote_write option
 #- module: prometheus
 #  metricsets: ["remote_write"]
 #  host: "localhost"
 #  port: "9201"
 
-  # Secure settings for the server using TLS/SSL:
-  #ssl.certificate: "/etc/pki/server/cert.pem"
-  #ssl.key: "/etc/pki/server/cert.key"
-
   # Count number of metrics present in Elasticsearch document (default: false)
   #metrics_count: false
 
-  # Use Elasticsearch histogram type to store histograms (beta, default: false)
-  # This will change the default layout and put metric type in the field name
-  #use_types: true
-
-  # Store counter rates instead of original cumulative counters (experimental, default: false)
-  #rate_counters: true
-
-  # Define patterns for counter and histogram types so as to identify metrics' types according to these patterns
-  #types_patterns:
-  #  counter_patterns: []
-  #  histogram_patterns: []
+  # Secure settings for the server using TLS/SSL:
+  #ssl.certificate: "/etc/pki/server/cert.pem"
+  #ssl.key: "/etc/pki/server/cert.key"
 
 # Metrics that will be collected using a PromQL
 #- module: prometheus
@@ -1433,11 +1425,9 @@ metricbeat.modules:
 #    params:
 #      query: "some_value"
 
-#------------------------------ Prometheus Module ------------------------------
-# Metrics collected from a Prometheus endpoint
+#----------------------- Prometheus Typed Metrics Module -----------------------
 - module: prometheus
   period: 10s
-  metricsets: ["collector"]
   hosts: ["localhost:9090"]
   metrics_path: /metrics
   #metrics_filters:
@@ -1446,28 +1436,46 @@ metricbeat.modules:
   #username: "user"
   #password: "secret"
 
-  # Count number of metrics present in Elasticsearch document (default: false)
-  #metrics_count: false
-
   # This can be used for service account based authorization:
   #bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
   #ssl.certificate_authorities:
   #  - /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
 
+  # Count number of metrics present in Elasticsearch document (default: false)
+  #metrics_count: false
+
+  # Use Elasticsearch histogram type to store histograms (beta, default: false)
+  # This will change the default layout and put metric type in the field name
+  #use_types: true
+
+  # Store counter rates instead of original cumulative counters (experimental, default: false)
+  #rate_counters: true
 
 # Metrics sent by a Prometheus server using remote_write option
 #- module: prometheus
 #  metricsets: ["remote_write"]
 #  host: "localhost"
 #  port: "9201"
 
-  # Count number of metrics present in Elasticsearch document (default: false)
-  #metrics_count: false
-
   # Secure settings for the server using TLS/SSL:
   #ssl.certificate: "/etc/pki/server/cert.pem"
   #ssl.key: "/etc/pki/server/cert.key"
 
+  # Count number of metrics present in Elasticsearch document (default: false)
+  #metrics_count: false
+
+  # Use Elasticsearch histogram type to store histograms (beta, default: false)
+  # This will change the default layout and put metric type in the field name
+  #use_types: true
+
+  # Store counter rates instead of original cumulative counters (experimental, default: false)
+  #rate_counters: true
+
+  # Define patterns for counter and histogram types so as to identify metrics' types according to these patterns
+  #types_patterns:
+  #  counter_patterns: []
+  #  histogram_patterns: []
+
 # Metrics that will be collected using a PromQL
 #- module: prometheus
 #  metricsets: ["query"]

diff --git a/x-pack/metricbeat/module/benchmark/_meta/config.yml b/x-pack/metricbeat/module/benchmark/_meta/config.yml
@@ -0,0 +1,6 @@
+- module: benchmark
+  metricsets:
+    - info
+  enabled: false
+  period: 10s
+
diff --git a/x-pack/metricbeat/module/benchmark/_meta/docs.asciidoc b/x-pack/metricbeat/module/benchmark/_meta/docs.asciidoc
@@ -0,0 +1,31 @@
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
+
+The `benchmark` module is used to generate synthetic metrics at a predictable rate.  This can be useful when you want to test output settings or test system sizing without using real data.
+
+The `benchmark` module metricset is `info`.
+
+[source,yaml]
+----
+- module: benchmark
+  metricsets:
+    - info
+  enabled: true
+  period: 10s
+----
+
+[float]
+== Metricsets
+
+[float]
+=== `info`
+A metric that includes a `counter` field which is used to keep the metric unique.
+
+[float]
+=== Module-specific configuration notes
+
+`count`:: number, the number of metrics to emit per fetch.
+
+
+
diff --git a/x-pack/metricbeat/module/benchmark/_meta/fields.yml b/x-pack/metricbeat/module/benchmark/_meta/fields.yml
@@ -0,0 +1,10 @@
+- key: benchmark
+  title: "Benchmark"
+  release: beta
+  description: >
+    benchmark module
+  fields:
+    - name: benchmark
+      type: group
+      description: >
+      fields:
diff --git a/x-pack/metricbeat/module/benchmark/doc.go b/x-pack/metricbeat/module/benchmark/doc.go
@@ -0,0 +1,6 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License;
+// you may not use this file except in compliance with the Elastic License.
+
+// Package benchmark is a Metricbeat module that contains MetricSets.
+package benchmark