Skip to content

Commit

Permalink
Improve doc references
Browse files Browse the repository at this point in the history
  • Loading branch information
marc-gr committed Jul 6, 2020
1 parent c233fe3 commit e66f25e
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 40 deletions.
20 changes: 10 additions & 10 deletions filebeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23242,24 +23242,24 @@ More information about specific fields can be found at https://developers.google
*`gsuite.actor.key`*::
*`gsuite.actor.type`*::
+
--
Only present when callerType is KEY. Can be the consumer_key of the requestor for OAuth 2LO API requests or an identifier for robot accounts.
The type of actor.
Values can be:
*USER*: Another user in the same domain.
*EXTERNAL_USER*: A user outside the domain.
*KEY*: A non-human actor.
type: keyword
--
*`gsuite.actor.type`*::
*`gsuite.actor.key`*::
+
--
The type of actor.
Values can be:
*USER*: Another user in the same domain.
*EXTERNAL_USER*: A user outside the domain.
*KEY*: A non-human actor.
Only present when `actor.type` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts.
type: keyword
Expand All @@ -23269,7 +23269,7 @@ type: keyword
*`gsuite.event.type`*::
+
--
The type of event.
The type of GSuite event, mapped from `items[].events[].type` in the original payload. Each fileset can have a different set of values for it, more details can be found at https://developers.google.com/admin-sdk/reports/v1/reference/activities/list
type: keyword
Expand All @@ -23281,7 +23281,7 @@ example: audit#activity
*`gsuite.kind`*::
+
--
The type of API resource.
The type of API resource, mapped from `kind` in the original payload. More details can be found at https://developers.google.com/admin-sdk/reports/v1/reference/activities/list
type: keyword
Expand Down
12 changes: 2 additions & 10 deletions filebeat/docs/modules/gsuite.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file is generated! See scripts/docs_collector.py
[role="xpack"]

:modulename: gsuite
:has-dashboards: true
:has-dashboards: false

== GSuite module

Expand All @@ -26,7 +26,7 @@ It is compatible with a subset of applications under the https://developers.goog

=== Configure the module

To allow the filebeat module to ingest data from the Google Reports API, you would need an admin account, and set up a `ServiceAccount` to access `Admin SDK API`. Also notice, https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application in order to work properly.
In order for filebeat to ingest data from the Google Reports API you must set up a `ServiceAccount` that has access to the `Admin SDK API`. Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly.

This module will make use of the following `oauth2 scope`:

Expand Down Expand Up @@ -94,14 +94,6 @@ This is a list of GSuite Reports fields that are mapped to ECS.

These are the common ones to all filesets.

[float]
=== Example dashboard

This module comes with a sample dashboard. For example:

TODO: include an image of a sample dashboard. If you do not include a dashboard,
remove this section and set `:has-dashboards: false` at the top of this file.

:has-dashboards!:

:modulename!:
Expand Down
12 changes: 2 additions & 10 deletions x-pack/filebeat/module/gsuite/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[role="xpack"]

:modulename: gsuite
:has-dashboards: true
:has-dashboards: false

== GSuite module

Expand All @@ -21,7 +21,7 @@ It is compatible with a subset of applications under the https://developers.goog

=== Configure the module

To allow the filebeat module to ingest data from the Google Reports API, you would need an admin account, and set up a `ServiceAccount` to access `Admin SDK API`. Also notice, https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application in order to work properly.
In order for filebeat to ingest data from the Google Reports API you must set up a `ServiceAccount` that has access to the `Admin SDK API`. Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly.

This module will make use of the following `oauth2 scope`:

Expand Down Expand Up @@ -89,14 +89,6 @@ This is a list of GSuite Reports fields that are mapped to ECS.

These are the common ones to all filesets.

[float]
=== Example dashboard

This module comes with a sample dashboard. For example:

TODO: include an image of a sample dashboard. If you do not include a dashboard,
remove this section and set `:has-dashboards: false` at the top of this file.

:has-dashboards!:

:modulename!:
14 changes: 8 additions & 6 deletions x-pack/filebeat/module/gsuite/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@
More information about specific fields can be found at https://developers.google.com/admin-sdk/reports/v1/reference/activities/list
fields:
- name: actor.key
type: keyword
description: >
Only present when callerType is KEY. Can be the consumer_key of the requestor for OAuth 2LO API requests or an identifier for robot accounts.
- name: actor.type
type: keyword
description: >
Expand All @@ -24,15 +20,21 @@
*USER*: Another user in the same domain.
*EXTERNAL_USER*: A user outside the domain.
*KEY*: A non-human actor.
- name: actor.key
type: keyword
description: >
Only present when `actor.type` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts.
- name: event.type
type: keyword
description: >
The type of event.
The type of GSuite event, mapped from `items[].events[].type` in the original payload.
Each fileset can have a different set of values for it, more details can be found at https://developers.google.com/admin-sdk/reports/v1/reference/activities/list
example: audit#activity
- name: kind
type: keyword
description: >
The type of API resource.
The type of API resource, mapped from `kind` in the original payload.
More details can be found at https://developers.google.com/admin-sdk/reports/v1/reference/activities/list
example: audit#activity
- name: organization.domain
type: keyword
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/gsuite/fields.go

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

3 changes: 0 additions & 3 deletions x-pack/filebeat/module/gsuite/module.yml

This file was deleted.

0 comments on commit e66f25e

Please sign in to comment.