[Metricbeat] Add a system/users metricset

metricbeat/docs/fields.asciidoc

@@ -35921,6 +35921,113 @@ format: duration
 
 --
 
+[float]
+=== users
+
+Logged-in user session data
+
+
+
+*`system.users.id`*::
++
+--
+The ID of the session
+
+
+type: keyword
+
+--
+
+*`system.users.seat`*::
++
+--
+An associated logind seat
+
+
+type: keyword
+
+--
+
+*`system.users.path`*::
++
+--
+The DBus object path of the session
+
+
+type: keyword
+
+--
+
+*`system.users.type`*::
++
+--
+The type of the user session
+
+
+type: keyword
+
+--
+
+*`system.users.service`*::
++
+--
+A session associated with the service
+
+
+type: keyword
+
+--
+
+*`system.users.remote`*::
++
+--
+A bool indicating a remote session
+
+
+type: boolean
+
+--
+
+*`system.users.state`*::
++
+--
+The current state of the session
+
+
+type: keyword
+
+--
+
+*`system.users.scope`*::
++
+--
+The associated systemd scope
+
+
+type: keyword
+
+--
+
+*`system.users.leader`*::
++
+--
+The root PID of the session
+
+
+type: long
+
+--
+
+*`system.users.remote_host`*::
++
+--
+A remote host address for the session
+
+
+type: keyword
+
+--
+
 [[exported-fields-tomcat]]
 == Tomcat fields
 

metricbeat/docs/modules/system.asciidoc

@@ -274,6 +274,8 @@ The following metricsets are available:
 
 * <<metricbeat-metricset-system-uptime,uptime>>
 
+* <<metricbeat-metricset-system-users,users>>
+
 include::system/core.asciidoc[]
 
 include::system/cpu.asciidoc[]
@@ -308,3 +310,5 @@ include::system/socket_summary.asciidoc[]
 
 include::system/uptime.asciidoc[]
 
+include::system/users.asciidoc[]
+

metricbeat/docs/modules/system/users.asciidoc

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

metricbeat/docs/modules_list.asciidoc

@@ -202,7 +202,7 @@ This file is generated! See scripts/mage/docs_collector.go
 |<<metricbeat-module-statsd,Statsd>>  beta[]   |image:./images/icon-no.png[No prebuilt dashboards]    |  
 .1+| .1+|  |<<metricbeat-metricset-statsd-server,server>> beta[]  
 |<<metricbeat-module-system,System>>     |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
-.17+| .17+|  |<<metricbeat-metricset-system-core,core>>   
+.18+| .18+|  |<<metricbeat-metricset-system-core,core>>   
 |<<metricbeat-metricset-system-cpu,cpu>>   
 |<<metricbeat-metricset-system-diskio,diskio>>   
 |<<metricbeat-metricset-system-entropy,entropy>>   
@@ -219,6 +219,7 @@ This file is generated! See scripts/mage/docs_collector.go
 |<<metricbeat-metricset-system-socket,socket>>   
 |<<metricbeat-metricset-system-socket_summary,socket_summary>>   
 |<<metricbeat-metricset-system-uptime,uptime>>   
+|<<metricbeat-metricset-system-users,users>> beta[]  
 |<<metricbeat-module-tomcat,Tomcat>>  beta[]   |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
 .4+| .4+|  |<<metricbeat-metricset-tomcat-cache,cache>> beta[]  
 |<<metricbeat-metricset-tomcat-memory,memory>> beta[]  

metricbeat/module/system/users/_meta/data.json

@@ -0,0 +1,39 @@
+{
+    "@timestamp": "2017-10-12T08:05:34.853Z",
+    "event": {
+        "dataset": "system.users",
+        "duration": 115000,
+        "module": "system"
+    },
+    "metricset": {
+        "name": "users",
+        "period": 10000
+    },
+    "process": {
+        "pid": 10786
+    },
+    "service": {
+        "type": "system"
+    },
+    "source": {
+        "ip": "192.168.1.86"
+    },
+    "system": {
+        "users": {
+            "id": 6,
+            "leader": 10786,
+            "path": "/org/freedesktop/login1/session/_36",
+            "remote": true,
+            "remote_host": "192.168.1.86",
+            "scope": "session-6.scope",
+            "seat": "",
+            "service": "sshd",
+            "state": "active",
+            "type": "tty"
+        }
+    },
+    "user": {
+        "id": 1000,
+        "name": "alexk"
+    }
+}

metricbeat/module/system/users/_meta/docs.asciidoc

@@ -0,0 +1,11 @@
+The system/users metricset reports logged in users and associated sessions via dbus and logind, which is a systemd component. By default, the metricset will look in `/var/run/dbus/` for a system socket, although a new path can be selected with `DBUS_SYSTEM_BUS_ADDRESS`.
+
+This metricset is available on:
+
+- Linux
+
+
+[float]
+=== Configuration
+
+There are no configuration options for this metricset.

metricbeat/module/system/users/_meta/fields.yml

@@ -0,0 +1,48 @@
+- name: users
+  type: group
+  release: beta
+  description: >
+    Logged-in user session data
+  fields:
+    - name: id
+      type: keyword
+      description: >
+        The ID of the session
+    - name: seat
+      type: keyword
+      description: >
+        An associated logind seat
+    - name: path
+      type: keyword
+      description: >
+        The DBus object path of the session
+    - name: type
+      type: keyword
+      description: >
+        The type of the user session
+    - name: service
+      type: keyword
+      description: >
+        A session associated with the service
+    - name: remote
+      type: boolean
+      description: >
+        A bool indicating a remote session
+    - name: state
+      type: keyword
+      description: >
+        The current state of the session
+    - name: scope
+      type: keyword
+      description: >
+        The associated systemd scope
+    - name: leader
+      type: long
+      description: >
+        The root PID of the session
+    - name: remote_host
+      type: keyword
+      description: >
+          A remote host address for the session
+
+