Containerd metricbeat module

metricbeat/docs/fields.asciidoc

@@ -27,6 +27,7 @@ grouped in the following categories:
 * <<exported-fields-cockroachdb>>
 * <<exported-fields-common>>
 * <<exported-fields-consul>>
+* <<exported-fields-containerd>>
 * <<exported-fields-coredns>>
 * <<exported-fields-couchbase>>
 * <<exported-fields-couchdb>>
@@ -10253,6 +10254,107 @@ type: long
 
 --
 
+[[exported-fields-containerd]]
+== Containerd fields
+
+Containerd stats collected from containerd
+
+
+
+[float]
+=== containerd
+
+Information and statistics about containerd's running containers.
+
+
+
+[float]
+=== cpu
+
+Containerd Runtime CPU metrics.
+
+
+
+
+
+*`containerd.cpu.usage.kernel.ns`*::
++
+--
+CPU Kernel usage nanoseconds
+
+
+type: double
+
+--
+
+
+*`containerd.cpu.usage.user.ns`*::
++
+--
+CPU User usage nanoseconds
+
+
+type: double
+
+--
+
+
+*`containerd.cpu.usage.total.ns`*::
++
+--
+CPU total usage nanoseconds
+
+
+type: double
+
+--
+
+*`containerd.cpu.usage.total.pct`*::
++
+--
+Percentage of total CPU time normalized by the number of CPU cores
+
+
+type: scaled_float
+
+format: percent
+
+--
+
+*`containerd.cpu.usage.kernel.pct`*::
++
+--
+Percentage of time in kernel space normalized by the number of CPU cores.
+
+
+type: scaled_float
+
+format: percent
+
+--
+
+*`containerd.cpu.usage.user.pct`*::
++
+--
+Percentage of time in user space normalized by the number of CPU cores.
+
+
+type: scaled_float
+
+format: percent
+
+--
+
+*`containerd.cpu.usage.cpu.*.ns`*::
++
+--
+CPU usage nanoseconds in this cpu.
+
+
+type: object
+
+--
+
 [[exported-fields-coredns]]
 == Coredns fields
 

metricbeat/docs/modules/containerd.asciidoc

@@ -0,0 +1,42 @@
+////
+This file is generated! See scripts/mage/docs_collector.go
+////
+
+:modulename: containerd
+
+[[metricbeat-module-containerd]]
+[role="xpack"]
+== Containerd module
+
+beta[]
+
+This is the containerd module.
+
+
+
+[float]
+=== Example configuration
+
+The Containerd module supports the standard configuration options that are described
+in <<configuration-metricbeat>>. Here is an example configuration:
+
+[source,yaml]
+----
+metricbeat.modules:
+- module: containerd
+  metricsets: ["cpu"]
+  enabled: false
+  period: 10s
+  hosts: ["localhost:1338"]
+
+----
+
+[float]
+=== Metricsets
+
+The following metricsets are available:
+
+* <<metricbeat-metricset-containerd-cpu,cpu>>
+
+include::containerd/cpu.asciidoc[]
+

metricbeat/docs/modules/containerd/cpu.asciidoc

@@ -0,0 +1,24 @@
+////
+This file is generated! See scripts/mage/docs_collector.go
+////
+
+[[metricbeat-metricset-containerd-cpu]]
+[role="xpack"]
+=== Containerd cpu metricset
+
+beta[]
+
+include::../../../../x-pack/metricbeat/module/containerd/cpu/_meta/docs.asciidoc[]
+
+
+==== Fields
+
+For a description of each field in the metricset, see the
+<<exported-fields-containerd,exported fields>> section.
+
+Here is an example document generated by this metricset:
+
+[source,json]
+----
+include::../../../../x-pack/metricbeat/module/containerd/cpu/_meta/data.json[]
+----

metricbeat/docs/modules_list.asciidoc

@@ -72,6 +72,8 @@ This file is generated! See scripts/mage/docs_collector.go
 .1+| .1+|  |<<metricbeat-metricset-cockroachdb-status,status>> beta[]  
 |<<metricbeat-module-consul,Consul>>  beta[]   |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
 .1+| .1+|  |<<metricbeat-metricset-consul-agent,agent>> beta[]  
+|<<metricbeat-module-containerd,Containerd>>  beta[]   |image:./images/icon-no.png[No prebuilt dashboards]    |  
+.1+| .1+|  |<<metricbeat-metricset-containerd-cpu,cpu>> beta[]  
 |<<metricbeat-module-coredns,Coredns>>     |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
 .1+| .1+|  |<<metricbeat-metricset-coredns-stats,stats>>   
 |<<metricbeat-module-couchbase,Couchbase>>     |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
@@ -322,6 +324,7 @@ include::modules/ceph.asciidoc[]
 include::modules/cloudfoundry.asciidoc[]
 include::modules/cockroachdb.asciidoc[]
 include::modules/consul.asciidoc[]
+include::modules/containerd.asciidoc[]
 include::modules/coredns.asciidoc[]
 include::modules/couchbase.asciidoc[]
 include::modules/couchdb.asciidoc[]

x-pack/metricbeat/metricbeat.reference.yml

@@ -427,6 +427,14 @@ metricbeat.modules:
   hosts: ["localhost:8500"]
 
 
+#------------------------------ Containerd Module ------------------------------
+- module: containerd
+  metricsets: ["cpu"]
+  enabled: false
+  period: 10s
+  hosts: ["localhost:1338"]
+
+
 #------------------------------- Coredns Module -------------------------------
 - module: coredns
   metricsets: ["stats"]

x-pack/metricbeat/module/containerd/_meta/config.yml

@@ -0,0 +1,7 @@
+- module: containerd
+  metricsets: ["cpu", "memory"]
+  enabled: false
+  period: 10s
+  hosts: ["localhost:1338"]
+  calcpct: true
+

x-pack/metricbeat/module/containerd/_meta/docs.asciidoc

@@ -0,0 +1,2 @@
+This is the containerd module.
+

x-pack/metricbeat/module/containerd/_meta/fields.yml

@@ -0,0 +1,11 @@
+- key: containerd
+  title: "Containerd"
+  release: beta
+  description: >
+    Containerd stats collected from containerd
+  fields:
+    - name: containerd
+      type: group
+      description: >
+        Information and statistics about containerd's running containers.
+      fields:

x-pack/metricbeat/module/containerd/config.go

@@ -0,0 +1,17 @@
+// 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 containerd
+
+// Config contains the config needed for containerd
+type Config struct {
+	CalculatePct bool `config:"calcpct"`
+}
+
+// DefaultConfig returns default module config
+func DefaultConfig() Config {
+	return Config{
+		CalculatePct: true,
+	}
+}

x-pack/metricbeat/module/containerd/cpu/_meta/data.json

@@ -0,0 +1,19 @@
+{
+    "@timestamp":"2016-05-23T08:05:34.853Z",
+    "beat":{
+        "hostname":"beathost",
+        "name":"beathost"
+    },
+    "metricset":{
+        "host":"localhost",
+        "module":"containerd",
+        "name":"cpu",
+        "rtt":44269
+    },
+    "containerd":{
+        "cpu":{
+            "example": "cpu"
+        }
+    },
+    "type":"metricsets"
+}

x-pack/metricbeat/module/containerd/cpu/_meta/docs.asciidoc

@@ -0,0 +1 @@
+This is the cpu metricset of the module containerd.

x-pack/metricbeat/module/containerd/cpu/_meta/fields.yml

@@ -0,0 +1,50 @@
+- name: cpu
+  type: group
+  description: >
+    Containerd Runtime CPU metrics.
+  release: beta
+  fields:
+    - name: usage
+      type: group
+      fields:
+        - name: kernel
+          type: group
+          fields:
+            - name: ns
+              type: double
+              description: >
+                CPU Kernel usage nanoseconds
+        - name: user
+          type: group
+          fields:
+            - name: ns
+              type: double
+              description: >
+                CPU User usage nanoseconds
+        - name: total
+          type: group
+          fields:
+            - name: ns
+              type: double
+              description: >
+                CPU total usage nanoseconds
+        - name: total.pct
+          type: scaled_float
+          format: percent
+          description: >
+            Percentage of total CPU time normalized by the number of CPU cores
+        - name: kernel.pct
+          type: scaled_float
+          format: percent
+          description: >
+            Percentage of time in kernel space normalized by the number of CPU cores.
+        - name: user.pct
+          type: scaled_float
+          format: percent
+          description: >
+            Percentage of time in user space normalized by the number of CPU cores.
+        - name: cpu.*.ns
+          type: object
+          object_type: double
+          description: >
+            CPU usage nanoseconds in this cpu.

x-pack/metricbeat/module/containerd/cpu/cpu.go

@@ -0,0 +1,48 @@
+// 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 cpu
+
+import (
+	"github.com/elastic/beats/v7/metricbeat/helper/prometheus"
+	"github.com/elastic/beats/v7/metricbeat/mb"
+	"github.com/elastic/beats/v7/metricbeat/mb/parse"
+)
+
+const (
+	defaultScheme = "http"
+	defaultPath   = "/v1/metrics"
+)
+
+var (
+	// HostParser validates Prometheus URLs
+	hostParser = parse.URLHostParserBuilder{
+		DefaultScheme: defaultScheme,
+		DefaultPath:   defaultPath,
+	}.Build()
+)
+
+// init registers the MetricSet with the central registry.
+// The New method will be called after the setup of the module and before starting to fetch data
+func init() {
+	// Mapping of state metrics
+	mapping := &prometheus.MetricsMapping{
+		Metrics: map[string]prometheus.MetricMap{
+			"container_cpu_total_nanoseconds":  prometheus.Metric("usage.total.ns"),
+			"container_cpu_user_nanoseconds":   prometheus.Metric("usage.user.ns"),
+			"container_cpu_kernel_nanoseconds": prometheus.Metric("usage.kernel.ns"),
+			"container_per_cpu_nanoseconds":    prometheus.Metric("usage.percpu.ns"),
+			"process_cpu_seconds_total":        prometheus.Metric("system.total"),
+		},
+		Labels: map[string]prometheus.LabelMap{
+			"container_id": prometheus.KeyLabel("id"),
+			"cpu":          prometheus.KeyLabel("cpu"),
+		},
+	}
+
+	mb.Registry.MustAddMetricSet("containerd", "cpu",
+		getMetricsetFactory(mapping),
+		mb.WithHostParser(hostParser),
+	)
+}