Skip to content

Commit

Permalink
Make system module beta. (elastic#10800)
Browse files Browse the repository at this point in the history
The System module has been marked as `experimental` so far. With 7.0 we're moving it to `beta`.
  • Loading branch information
Christoph Wurm authored Feb 22, 2019
1 parent e5af019 commit cf45635
Show file tree
Hide file tree
Showing 20 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion x-pack/auditbeat/docs/modules/system.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This file is generated! See scripts/docs_collector.py

== System Module

experimental[]
beta[]

The `system` module collects various security related information about
a system. All datasets send both periodic state information (e.g. all currently
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

== System Module

experimental[]
beta[]

The `system` module collects various security related information about
a system. All datasets send both periodic state information (e.g. all currently
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "System"
description: >
These are the fields generated by the system module.
release: experimental
release: beta
fields:

- name: event
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/fields.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/host/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]

experimental[]
beta[]

This is the `host` dataset of the system module.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/host/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
type: group
description: >
`host` contains general host information.
release: experimental
release: beta
fields:
- name: uptime
type: long
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/host/host.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ type MetricSet struct {

// New constructs a new MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
cfgwarn.Experimental("The %v/%v dataset is experimental", moduleName, metricsetName)
cfgwarn.Beta("The %v/%v dataset is beta", moduleName, metricsetName)

config := defaultConfig()
if err := base.Module().UnpackConfig(&config); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/login/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]

experimental[]
beta[]

This is the `login` dataset of the system module.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/login/login.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ type MetricSet struct {

// New constructs a new MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
cfgwarn.Experimental("The %v/%v dataset is experimental", moduleName, metricsetName)
cfgwarn.Beta("The %v/%v dataset is beta", moduleName, metricsetName)

config := defaultConfig()
if err := base.Module().UnpackConfig(&config); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/package/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]

experimental[]
beta[]

This is the `package` dataset of the system module.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/package/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
type: group
description: >
`package` contains information about an installed or removed package.
release: experimental
release: beta
fields:
- name: entity_id
type: keyword
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/package/package.go
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ func getOS() (*types.OSInfo, error) {

// New constructs a new MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
cfgwarn.Experimental("The %v/%v dataset is experimental", moduleName, metricsetName)
cfgwarn.Beta("The %v/%v dataset is beta", moduleName, metricsetName)

config := defaultConfig()
if err := base.Module().UnpackConfig(&config); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/process/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]

experimental[]
beta[]

This is the `process` dataset of the system module.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/process/process.go
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ func (p Process) entityID(hostID string) string {

// New constructs a new MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
cfgwarn.Experimental("The %v/%v dataset is experimental", moduleName, metricsetName)
cfgwarn.Beta("The %v/%v dataset is beta", moduleName, metricsetName)

config := defaultConfig
if err := base.Module().UnpackConfig(&config); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/socket/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]

experimental[]
beta[]

This is the `socket` dataset of the system module.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/socket/socket.go
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ func (s Socket) entityID(hostID string) string {

// New constructs a new MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
cfgwarn.Experimental("The %v/%v dataset is experimental", moduleName, metricsetName)
cfgwarn.Beta("The %v/%v dataset is beta", moduleName, metricsetName)

config := defaultConfig
if err := base.Module().UnpackConfig(&config); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/user/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]

experimental[]
beta[]

This is the `user` dataset of the system module.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/user/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
type: group
description: >
`user` contains information about the users on a system.
release: experimental
release: beta
fields:
- name: name
type: keyword
Expand Down
2 changes: 1 addition & 1 deletion x-pack/auditbeat/module/system/user/user.go
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ type MetricSet struct {

// New constructs a new MetricSet.
func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
cfgwarn.Experimental("The %v/%v dataset is experimental", moduleName, metricsetName)
cfgwarn.Beta("The %v/%v dataset is beta", moduleName, metricsetName)
if runtime.GOOS != "linux" {
return nil, fmt.Errorf("the %v/%v dataset is only supported on Linux", moduleName, metricsetName)
}
Expand Down
12 changes: 6 additions & 6 deletions x-pack/auditbeat/tests/system/test_metricsets.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def test_metricset_host(self):
fields = ["system.audit.host.id", "system.audit.host.uptime", "system.audit.host.ip",
"system.audit.host.os.name"]

# Metricset is experimental and that generates a warning, TODO: remove later
# Metricset is beta and that generates a warning, TODO: remove later
self.check_metricset("system", "host", COMMON_FIELDS + fields, warnings_allowed=True)

@unittest.skipUnless(sys.platform == "linux2", "Only implemented for Linux")
Expand All @@ -38,7 +38,7 @@ def test_metricset_login(self):
"login.btmp_file_pattern": "-1"
}

# Metricset is experimental and that generates a warning, TODO: remove later
# Metricset is beta and that generates a warning, TODO: remove later
self.check_metricset("system", "login", COMMON_FIELDS + fields, config, warnings_allowed=True)

@unittest.skipIf(sys.platform == "win32", "Not implemented for Windows")
Expand All @@ -51,7 +51,7 @@ def test_metricset_package(self):

fields = ["system.audit.package.entity_id", "system.audit.package.name", "system.audit.package.version"]

# Metricset is experimental and that generates a warning, TODO: remove later
# Metricset is beta and that generates a warning, TODO: remove later
self.check_metricset("system", "package", COMMON_FIELDS + fields, warnings_allowed=True)

def test_metricset_process(self):
Expand All @@ -67,7 +67,7 @@ def test_metricset_process(self):
fields.extend(["user.effective.id", "user.saved.id", "user.effective.group.id", "user.saved.group.id",
"user.name", "user.group.name"])

# Metricset is experimental and that generates a warning, TODO: remove later
# Metricset is beta and that generates a warning, TODO: remove later
self.check_metricset("system", "process", COMMON_FIELDS + fields, warnings_allowed=True)

@unittest.skipUnless(sys.platform == "linux2", "Only implemented for Linux")
Expand All @@ -80,7 +80,7 @@ def test_metricset_socket(self):

# errors_allowed=True - The socket metricset fills the `error` field if the process enrichment fails
# (e.g. process has exited). This should not fail the test.
# warnings_allowed=True - Metricset is experimental and that generates a warning, TODO: remove later
# warnings_allowed=True - Metricset is beta and that generates a warning, TODO: remove later
self.check_metricset("system", "socket", COMMON_FIELDS + fields, errors_allowed=True, warnings_allowed=True)

@unittest.skipUnless(sys.platform == "linux2", "Only implemented for Linux")
Expand All @@ -91,5 +91,5 @@ def test_metricset_user(self):

fields = ["user.entity_id", "system.audit.user.name"]

# Metricset is experimental and that generates a warning, TODO: remove later
# Metricset is beta and that generates a warning, TODO: remove later
self.check_metricset("system", "user", COMMON_FIELDS + fields, warnings_allowed=True)

0 comments on commit cf45635

Please sign in to comment.