[GCP] Update fields docs and fix inconsistencies after #27974 #33006

endorama · 2022-09-07T09:33:22Z

What does this PR do?

Update the wording in different GCP metricsets about metrics name not being changed from their original GCP counterparts, as they have been updated in #27974 to align them with Beats naming conventions.

Remove fields names and description as they are available through exported fields section, which is automatically updated from fields definitions and don't risk being outdated.

Why is it important?

Documentation was confusing and not helping users.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

[ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

After we aligned metrics with Beats naming convention (elastic#27974) the docs has not been adequately updated.

elasticmachine · 2022-09-07T09:41:20Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-09-09T08:09:01.002+0000
Duration: 7 min 21 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

dedemorton

Suggested some fixes to the asciidoc tagging. Let me know if you need help with the list formatting. There are some other tricks I know that aren't covered in the readme.

dedemorton · 2022-09-07T18:39:03Z

x-pack/metricbeat/module/gcp/compute/_meta/docs.asciidoc

@@ -1,96 +1,30 @@
 Compute metricset to fetch metrics from https://cloud.google.com/compute/[Compute Engine] Virtual Machines in Google Cloud Platform. No Monitoring or Logging agent is required in your instances to use this metricset.

-The `compute` metricset contains all metrics exported from the https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute[Stackdriver API]. The field names have been left untouched for people already familiar with them.
+The `compute` metricset contains all metrics exported from the https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute[Stackdriver API]. The field names are aligned to https://www.elastic.co/guide/en/beats/devguide/current/event-conventions.html[Beats naming conventions] with minor modifications to their GCP metrics name counterpart.


Suggested change

The `compute` metricset contains all metrics exported from the https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute[Stackdriver API]. The field names are aligned to https://www.elastic.co/guide/en/beats/devguide/current/event-conventions.html[Beats naming conventions] with minor modifications to their GCP metrics name counterpart.

The `compute` metricset contains all metrics exported from the https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute[Stackdriver API]. The field names are aligned to {beats-devguide}/event-conventions.html[Beats naming conventions] with minor modifications to their GCP metrics name counterpart.

avoid hard coding doc paths. Note that the path attributes you can use are defined here: https://github.com/elastic/docs/blob/master/shared/attributes.asciidoc

dedemorton · 2022-09-07T18:40:32Z

x-pack/metricbeat/module/gcp/compute/_meta/docs.asciidoc

-=== Metrics and labels
-Here is a list of metrics collected by `compute` metricset:
+=== Labels
+Here is a list of labels collected by `compute` metricset depending on the type of metric being collected:


Suggested change

Here is a list of labels collected by `compute` metricset depending on the type of metric being collected:

Here is a list of labels collected by the `compute` metricset depending on the type of metric being collected:

x-pack/metricbeat/module/gcp/dataproc/_meta/docs.asciidoc

x-pack/metricbeat/module/gcp/firestore/_meta/docs.asciidoc

x-pack/metricbeat/module/gcp/gke/_meta/docs.asciidoc

x-pack/metricbeat/module/gcp/storage/_meta/docs.asciidoc

x-pack/metricbeat/module/gcp/compute/_meta/docs.asciidoc

x-pack/metricbeat/module/gcp/loadbalancing/_meta/docs.asciidoc

x-pack/metricbeat/module/gcp/dataproc/_meta/docs.asciidoc

x-pack/metricbeat/module/gcp/firestore/_meta/docs.asciidoc

Co-authored-by: DeDe Morton <[email protected]>

dedemorton

LGTM

Co-authored-by: DeDe Morton <[email protected]> (cherry picked from commit 923e11f) # Conflicts: # x-pack/metricbeat/module/gcp/dataproc/_meta/docs.asciidoc # x-pack/metricbeat/module/gcp/firestore/_meta/docs.asciidoc

Co-authored-by: DeDe Morton <[email protected]> (cherry picked from commit 923e11f)

…es after #27974 (#33080) Co-authored-by: DeDe Morton <[email protected]> Co-authored-by: Edoardo Tenani <[email protected]>

…ies after #27974 (#33079) Co-authored-by: DeDe Morton <[email protected]> Co-authored-by: Edoardo Tenani <[email protected]> Co-authored-by: Edoardo Tenani <[email protected]>

Co-authored-by: DeDe Morton <[email protected]>

change wording for metricset metrics names

0d1959f

After we aligned metrics with Beats naming convention (elastic#27974) the docs has not been adequately updated.

endorama requested a review from a team as a code owner September 7, 2022 09:33

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Sep 7, 2022

endorama added backport-7.17 Automated backport to the 7.17 branch with mergify Team:Cloud-Monitoring Label for the Cloud Monitoring team backport-v8.4.0 Automated backport with mergify labels Sep 7, 2022

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Sep 7, 2022

mergify bot assigned endorama Sep 7, 2022

endorama added 6 commits September 7, 2022 12:20

remove metrics list in compute, reword labels

42235ee

remove metrics from data proc

6b0aeb1

remove metrics from firestore

e184a30

remove metrics from loadbalancing

d6d4cf2

remove metrics from pubsub

f75200c

remove metrics from storage

f771e0c

endorama force-pushed the gcp-fields-docs-fixes branch from b7d5a33 to f771e0c Compare September 7, 2022 10:21

girodav approved these changes Sep 7, 2022

View reviewed changes

kaiyan-sheng approved these changes Sep 7, 2022

View reviewed changes

dedemorton reviewed Sep 7, 2022

View reviewed changes

x-pack/metricbeat/module/gcp/dataproc/_meta/docs.asciidoc Outdated Show resolved Hide resolved

dedemorton reviewed Sep 7, 2022

View reviewed changes

x-pack/metricbeat/module/gcp/firestore/_meta/docs.asciidoc Outdated Show resolved Hide resolved

endorama and others added 3 commits September 8, 2022 09:50

replace hardcoded link to beats docs

d05b88f

Co-authored-by: DeDe Morton <[email protected]>

use passive voice

073f491

Co-authored-by: DeDe Morton <[email protected]>

update list formatting

7bfe982

endorama requested a review from dedemorton September 9, 2022 08:39

dedemorton approved these changes Sep 12, 2022

View reviewed changes

endorama merged commit 923e11f into elastic:main Sep 14, 2022

endorama deleted the gcp-fields-docs-fixes branch September 14, 2022 12:40

mergify bot mentioned this pull request Sep 14, 2022

[7.17](backport #33006) [GCP] Update fields docs and fix inconsistencies after #27974 #33079

Merged

mergify bot pushed a commit that referenced this pull request Sep 14, 2022

[GCP] Update fields docs and fix inconsistencies after #27974 (#33006)

0a30bd9

Co-authored-by: DeDe Morton <[email protected]> (cherry picked from commit 923e11f)

mergify bot mentioned this pull request Sep 14, 2022

[8.4](backport #33006) [GCP] Update fields docs and fix inconsistencies after #27974 #33080

Merged

endorama added a commit that referenced this pull request Sep 15, 2022

[8.4](backport #33006) [GCP] Update fields docs and fix inconsistenci…

982f1f0

…es after #27974 (#33080) Co-authored-by: DeDe Morton <[email protected]> Co-authored-by: Edoardo Tenani <[email protected]>

chrisberkhout pushed a commit that referenced this pull request Jun 1, 2023

[GCP] Update fields docs and fix inconsistencies after #27974 (#33006)

1275704

Co-authored-by: DeDe Morton <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GCP] Update fields docs and fix inconsistencies after #27974 #33006

[GCP] Update fields docs and fix inconsistencies after #27974 #33006

endorama commented Sep 7, 2022 •

edited

Loading

elasticmachine commented Sep 7, 2022 •

edited by jenkins-beats-ci bot

Loading

Build stats

dedemorton left a comment

dedemorton Sep 7, 2022

dedemorton Sep 7, 2022

dedemorton Sep 7, 2022

dedemorton left a comment

	The `compute` metricset contains all metrics exported from the https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute[Stackdriver API]. The field names are aligned to https://www.elastic.co/guide/en/beats/devguide/current/event-conventions.html[Beats naming conventions] with minor modifications to their GCP metrics name counterpart.
	The `compute` metricset contains all metrics exported from the https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute[Stackdriver API]. The field names are aligned to {beats-devguide}/event-conventions.html[Beats naming conventions] with minor modifications to their GCP metrics name counterpart.

	Here is a list of labels collected by `compute` metricset depending on the type of metric being collected:
	Here is a list of labels collected by the `compute` metricset depending on the type of metric being collected:

[GCP] Update fields docs and fix inconsistencies after #27974 #33006

[GCP] Update fields docs and fix inconsistencies after #27974 #33006

Conversation

endorama commented Sep 7, 2022 • edited Loading

What does this PR do?

Why is it important?

Checklist

Author's Checklist

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

elasticmachine commented Sep 7, 2022 • edited by jenkins-beats-ci bot Loading

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

dedemorton left a comment

Choose a reason for hiding this comment

dedemorton Sep 7, 2022

Choose a reason for hiding this comment

dedemorton Sep 7, 2022

Choose a reason for hiding this comment

dedemorton Sep 7, 2022

Choose a reason for hiding this comment

dedemorton left a comment

Choose a reason for hiding this comment

endorama commented Sep 7, 2022 •

edited

Loading

elasticmachine commented Sep 7, 2022 •

edited by jenkins-beats-ci bot

Loading