Cherry-pick #26561 to 7.x: Move openmetrics module to oss (#26639)

CHANGELOG.next.asciidoc

@@ -695,6 +695,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 - Collect linked account information in AWS billing. {pull}26285[26285]
 - Add total CPU to vSphere virtual machine metrics. {pull}26167[26167]
 - Add AWS Kinesis metricset. {pull}25989[25989]
+- Move openmetrics module to oss. {pull}26561[26561]
 
 *Packetbeat*
 

Jenkinsfile

@@ -743,6 +743,9 @@ def getCommonModuleInTheChangeSet(String directory) {
   def exclude = "^(${directoryExclussion}|((?!\\/module\\/).)*\$|.*\\.asciidoc|.*\\.png)"
   dir("${env.BASE_DIR}") {
     module = getGitMatchingGroup(pattern: pattern, exclude: exclude)
+    if(!fileExists("${directory}/module/${module}")) {
+      module = ''
+    }
   }
   return module
 }

metricbeat/docs/modules/openmetrics.asciidoc

@@ -3,7 +3,6 @@ This file is generated! See scripts/mage/docs_collector.go
 ////
 
 [[metricbeat-module-openmetrics]]
-[role="xpack"]
 == Openmetrics module
 
 beta[]

metricbeat/docs/modules/openmetrics/collector.asciidoc

@@ -3,12 +3,11 @@ This file is generated! See scripts/mage/docs_collector.go
 ////
 
 [[metricbeat-metricset-openmetrics-collector]]
-[role="xpack"]
 === Openmetrics collector metricset
 
 beta[]
 
-include::../../../../x-pack/metricbeat/module/openmetrics/collector/_meta/docs.asciidoc[]
+include::../../../module/openmetrics/collector/_meta/docs.asciidoc[]
 
 
 ==== Fields
@@ -20,5 +19,5 @@ Here is an example document generated by this metricset:
 
 [source,json]
 ----
-include::../../../../x-pack/metricbeat/module/openmetrics/collector/_meta/data.json[]
+include::../../../module/openmetrics/collector/_meta/data.json[]
 ----

metricbeat/metricbeat.reference.yml

@@ -716,6 +716,19 @@ metricbeat.modules:
   # Path to server status. Default nginx_status
   server_status_path: "nginx_status"
 
+#----------------------------- Openmetrics Module -----------------------------
+- module: openmetrics
+  metricsets: ['collector']
+  period: 10s
+  hosts: ['localhost:9090']
+
+  # This module uses the Prometheus collector metricset, all
+  # the options for this metricset are also available here.
+  metrics_path: /metrics
+  metrics_filters:
+    include: []
+    exclude: []
+
 #------------------------------- PHP_FPM Module -------------------------------
 - module: php_fpm
   metricsets:

metricbeat/module/openmetrics/collector/collector.go

@@ -0,0 +1,42 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package collector
+
+import (
+	"github.com/elastic/beats/v7/metricbeat/mb"
+	"github.com/elastic/beats/v7/metricbeat/mb/parse"
+	"github.com/elastic/beats/v7/metricbeat/module/prometheus/collector"
+)
+
+const (
+	defaultScheme = "http"
+	defaultPath   = "/metrics"
+)
+
+var (
+	hostParser = parse.URLHostParserBuilder{
+		DefaultScheme: defaultScheme,
+		DefaultPath:   defaultPath,
+	}.Build()
+)
+
+func init() {
+	mb.Registry.MustAddMetricSet("openmetrics", "collector",
+		collector.MetricSetBuilder("openmetrics", collector.DefaultPromEventsGeneratorFactory),
+		mb.WithHostParser(hostParser))
+}

metricbeat/module/openmetrics/collector/collector_test.go

@@ -0,0 +1,32 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// +build !integration
+
+package collector
+
+import (
+	"testing"
+
+	mbtest "github.com/elastic/beats/v7/metricbeat/mb/testing"
+
+	_ "github.com/elastic/beats/v7/metricbeat/module/openmetrics"
+)
+
+func TestData(t *testing.T) {
+	mbtest.TestDataFiles(t, "openmetrics", "collector")
+}

x-pack/metricbeat/module/openmetrics/test_openmetrics.py → metricbeat/module/openmetrics/test_openmetrics.py

@@ -1,10 +1,10 @@
+import metricbeat
 import os
 import sys
 import unittest
-from xpack_metricbeat import XPackTest, metricbeat
 
 
-class Test(XPackTest):
+class Test(metricbeat.BaseTest):
 
     COMPOSE_SERVICES = ['openmetrics-node_exporter']
 
@@ -19,7 +19,7 @@ def test_openmetrics(self):
             "hosts": self.get_hosts(),
             "period": "5s",
         }])
-        proc = self.start_beat(home=self.beat_path)
+        proc = self.start_beat()
         self.wait_until(lambda: self.output_lines() > 0, 60)
         proc.check_kill_and_wait()
         self.assert_no_logged_warnings()

x-pack/metricbeat/metricbeat.reference.yml

@@ -1144,9 +1144,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:
@@ -1160,12 +1162,6 @@ metricbeat.modules:
   #ssl.certificate_authorities:
   #  - /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
 
-  # 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
@@ -1177,18 +1173,6 @@ metricbeat.modules:
   #ssl.certificate: "/etc/pki/server/cert.pem"
   #ssl.key: "/etc/pki/server/cert.key"
 
-  # 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"]
@@ -1215,11 +1199,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:
@@ -1233,6 +1215,12 @@ metricbeat.modules:
   #ssl.certificate_authorities:
   #  - /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
 
+  # 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
@@ -1244,6 +1232,18 @@ metricbeat.modules:
   #ssl.certificate: "/etc/pki/server/cert.pem"
   #ssl.key: "/etc/pki/server/cert.key"
 
+  # 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"]