Skip to content

Commit

Permalink
Update metricbeat docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gpop63 committed Feb 3, 2022
1 parent 485eea1 commit 86541f9
Show file tree
Hide file tree
Showing 4 changed files with 235 additions and 1 deletion.
204 changes: 204 additions & 0 deletions metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34857,6 +34857,210 @@ type: long

--

[float]
=== dataproc

Google Cloud Dataproc metrics


*`gcp.dataproc.batch.spark.executors.count`*::
+
--
Indicates the number of Batch Spark executors.

type: long

--

*`gcp.dataproc.cluster.hdfs.datanodes.count`*::
+
--
Indicates the number of HDFS DataNodes that are running inside a cluster.

type: long

--

*`gcp.dataproc.cluster.hdfs.storage_capacity.value`*::
+
--
Indicates capacity of HDFS system running on cluster in GB.

type: double

--

*`gcp.dataproc.cluster.hdfs.storage_utilization.value`*::
+
--
The percentage of HDFS storage currently used.

type: double

--

*`gcp.dataproc.cluster.hdfs.unhealthy_blocks.count`*::
+
--
Indicates the number of unhealthy blocks inside the cluster.

type: long

--

*`gcp.dataproc.cluster.job.completion_time.value`*::
+
--
The time jobs took to complete from the time the user submits a job to the time Dataproc reports it is completed.

type: long

--

*`gcp.dataproc.cluster.job.duration.value`*::
+
--
The time jobs have spent in a given state.

type: long

--

*`gcp.dataproc.cluster.job.failed.count`*::
+
--
Indicates the number of jobs that have failed on a cluster.

type: long

--

*`gcp.dataproc.cluster.job.running.count`*::
+
--
Indicates the number of jobs that are running on a cluster.

type: long

--

*`gcp.dataproc.cluster.job.submitted.count`*::
+
--
Indicates the number of jobs that have been submitted to a cluster.

type: long

--

*`gcp.dataproc.cluster.operation.completion_time.value`*::
+
--
The time operations took to complete from the time the user submits a operation to the time Dataproc reports it is completed.

type: long

--

*`gcp.dataproc.cluster.operation.duration.value`*::
+
--
The time operations have spent in a given state.

type: long

--

*`gcp.dataproc.cluster.operation.failed.count`*::
+
--
Indicates the number of operations that have failed on a cluster.

type: long

--

*`gcp.dataproc.cluster.operation.running.count`*::
+
--
Indicates the number of operations that are running on a cluster.

type: long

--

*`gcp.dataproc.cluster.operation.submitted.count`*::
+
--
Indicates the number of operations that have been submitted to a cluster.

type: long

--

*`gcp.dataproc.cluster.yarn.allocated_memory_percentage.value`*::
+
--
The percentage of YARN memory is allocated.

type: double

--

*`gcp.dataproc.cluster.yarn.apps.count`*::
+
--
Indicates the number of active YARN applications.

type: long

--

*`gcp.dataproc.cluster.yarn.containers.count`*::
+
--
Indicates the number of YARN containers.

type: long

--

*`gcp.dataproc.cluster.yarn.memory_size.value`*::
+
--
Indicates the YARN memory size in GB.

type: double

--

*`gcp.dataproc.cluster.yarn.nodemanagers.count`*::
+
--
Indicates the number of YARN NodeManagers running inside cluster.

type: long

--

*`gcp.dataproc.cluster.yarn.pending_memory_size.value`*::
+
--
The current memory request, in GB, that is pending to be fulfilled by the scheduler.

type: double

--

*`gcp.dataproc.cluster.yarn.virtual_cores.count`*::
+
--
Indicates the number of virtual cores in YARN.

type: long

--

[float]
=== firestore

Expand Down
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/gcp.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ metricbeat.modules:
- pubsub
- loadbalancing
- firestore
- dataproc
zone: "us-central1-a"
project_id: "your project id"
credentials_file_path: "your JSON credentials file path"
Expand Down Expand Up @@ -340,6 +341,8 @@ The following metricsets are available:

* <<metricbeat-metricset-gcp-compute,compute>>

* <<metricbeat-metricset-gcp-dataproc,dataproc>>

* <<metricbeat-metricset-gcp-firestore,firestore>>

* <<metricbeat-metricset-gcp-gke,gke>>
Expand All @@ -356,6 +359,8 @@ include::gcp/billing.asciidoc[]

include::gcp/compute.asciidoc[]

include::gcp/dataproc.asciidoc[]

include::gcp/firestore.asciidoc[]

include::gcp/gke.asciidoc[]
Expand Down
24 changes: 24 additions & 0 deletions metricbeat/docs/modules/gcp/dataproc.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-gcp-dataproc]]
[role="xpack"]
=== Google Cloud Platform dataproc metricset

beta[]

include::../../../../x-pack/metricbeat/module/gcp/dataproc/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-gcp,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../../x-pack/metricbeat/module/gcp/dataproc/_meta/data.json[]
----
3 changes: 2 additions & 1 deletion metricbeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,9 @@ This file is generated! See scripts/mage/docs_collector.go
|<<metricbeat-metricset-etcd-self,self>>
|<<metricbeat-metricset-etcd-store,store>>
|<<metricbeat-module-gcp,Google Cloud Platform>> beta[] |image:./images/icon-yes.png[Prebuilt dashboards are available] |
.8+| .8+| |<<metricbeat-metricset-gcp-billing,billing>> beta[]
.9+| .9+| |<<metricbeat-metricset-gcp-billing,billing>> beta[]
|<<metricbeat-metricset-gcp-compute,compute>> beta[]
|<<metricbeat-metricset-gcp-dataproc,dataproc>> beta[]
|<<metricbeat-metricset-gcp-firestore,firestore>> beta[]
|<<metricbeat-metricset-gcp-gke,gke>> beta[]
|<<metricbeat-metricset-gcp-loadbalancing,loadbalancing>> beta[]
Expand Down

0 comments on commit 86541f9

Please sign in to comment.