Skip to content

Commit

Permalink
Fix update target in metricbeat magefile.go to include collectDocs ta…
Browse files Browse the repository at this point in the history
…rget (#18062)

* Fix update target in metricbeat magefile.go to include collectDocs target.

* Add make doc to makefile shim, use collectall instead of collectdocs in update target.
  • Loading branch information
blakerouse authored Apr 28, 2020
1 parent 2b686e5 commit 7d16a0f
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
8 changes: 8 additions & 0 deletions dev-tools/make/mage.mk
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,11 @@ update: mage
.PHONY: crosscompile
crosscompile: mage
mage crossBuild

.PHONY: docs
docs:
mage docs

.PHONY: docs-preview
docs-preview:
PREVIEW=1 $(MAKE) docs
15 changes: 9 additions & 6 deletions metricbeat/docs/modules/googlecloud.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,28 @@ Note: extra GCP charges on Stackdriver Monitoring API requests will be generated
This is a list of the possible module parameters you can tune:

* *zone*: A single string with the zone you want to monitor like `us-central1-a`.
Or you can specific a partial zone name like `us-central1-`, which will monitor
all zones start with `us-central1-`: `us-central1-a`, `us-central1-b`,
`us-central1-c` and `us-central1-f`.
Or you can specific a partial zone name like `us-central1-` or `us-central1-*`,
which will monitor all zones start with `us-central1-`: `us-central1-a`,
`us-central1-b`, `us-central1-c` and `us-central1-f`.
Please see https://cloud.google.com/compute/docs/regions-zones#available[GCP zones]
for zones that are available in GCP.

* *region*: A single string with the region you want to monitor like `us-central1`.
This will enable monitoring for all zones under this region. Or you can specific
a partial region name like `us-east`, which will monitor all regions start with
a partial region name like `us-east` or `us-east*`, which will monitor all regions start with
`us-east`: `us-east1` and `us-east4`. If both region and zone are configured,
only region will be used.
Please see https://cloud.google.com/compute/docs/regions-zones#available[GCP regions]
for regions that are available in GCP.

* *project_id*: A single string with your GCP Project ID

* *credentials_file_path*: A single string pointing to the JSON file path reachable by Metricbeat that you have created using IAM.
* *credentials_file_path*: A single string pointing to the JSON file path
reachable by Metricbeat that you have created using IAM.

* *exclude_labels*: (`true`/`false` default `false`) Do not extract extra labels and metadata information from Metricsets and fetch metrics onlly. At the moment, *labels and metadata extraction is only supported* in Compute Metricset.
* *exclude_labels*: (`true`/`false` default `false`) Do not extract extra labels
and metadata information from metricsets and fetch metrics only. At the moment,
*labels and metadata extraction is only supported* in `compute` metricset.

* *period*: A single time duration specified for this module collection frequency.

Expand Down
3 changes: 2 additions & 1 deletion metricbeat/magefile.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ func moduleFieldsGo() error {

// Update is an alias for running fields, dashboards, config.
func Update() {
mg.SerialDeps(Fields, Dashboards, Config,
mg.SerialDeps(
Fields, Dashboards, Config, CollectAll,
metricbeat.PrepareModulePackagingOSS,
metricbeat.GenerateOSSMetricbeatModuleIncludeListGo)
}
Expand Down

0 comments on commit 7d16a0f

Please sign in to comment.