Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Metricbeat] Add Couchbase's Sync Gateway module #25599

Merged
merged 20 commits into from
Jun 29, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Final touches
  • Loading branch information
sayden committed Jun 2, 2021
commit 825c00c2d7c4879cd54e6b4a647d3e5e9f021adc
511 changes: 144 additions & 367 deletions metricbeat/docs/fields.asciidoc

Large diffs are not rendered by default.

4 changes: 0 additions & 4 deletions metricbeat/docs/modules/couchbase.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,9 @@ The following metricsets are available:

* <<metricbeat-metricset-couchbase-node,node>>

* <<metricbeat-metricset-couchbase-syncgateway,syncgateway>>

include::couchbase/bucket.asciidoc[]

include::couchbase/cluster.asciidoc[]

include::couchbase/node.asciidoc[]

include::couchbase/syncgateway.asciidoc[]

42 changes: 42 additions & 0 deletions metricbeat/docs/modules/syncgateway.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-module-syncgateway]]
== SyncGateway module

Sync Gateway is the synchronization server in a Couchbase for Mobile and Edge deployment. This metricset allows to monitor a Sync Gateway instance by using its REST API.

Sync Gateway access `[host]:[port]/_expvar` on Sync Gateway nodes to fetch metrics data, ensure that the URL is accessible from the host where Metricbeat is running.


[float]
=== Example configuration

The SyncGateway module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
metricbeat.modules:
- module: syncgateway
# metricsets:
# - db
# - memory
# - replication
# - resources
period: 10s

# SyncGateway hosts
hosts: ["127.0.0.1:4985"]
----

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-syncgateway-db,db>>

include::syncgateway/db.asciidoc[]

Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-couchbase-syncgateway]]
=== Couchbase syncgateway metricset
[[metricbeat-metricset-syncgateway-db]]
=== SyncGateway db metricset

include::../../../module/couchbase/syncgateway/_meta/docs.asciidoc[]
include::../../../module/syncgateway/db/_meta/docs.asciidoc[]

This is a default metricset. If the host module is unconfigured, this metricset is enabled by default.

==== Fields

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

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/couchbase/syncgateway/_meta/data.json[]
include::../../../module/syncgateway/db/_meta/data.json[]
----
6 changes: 4 additions & 2 deletions metricbeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,9 @@ This file is generated! See scripts/mage/docs_collector.go
|<<metricbeat-module-coredns,Coredns>> |image:./images/icon-yes.png[Prebuilt dashboards are available] |
.1+| .1+| |<<metricbeat-metricset-coredns-stats,stats>>
|<<metricbeat-module-couchbase,Couchbase>> |image:./images/icon-yes.png[Prebuilt dashboards are available] |
.4+| .4+| |<<metricbeat-metricset-couchbase-bucket,bucket>>
.3+| .3+| |<<metricbeat-metricset-couchbase-bucket,bucket>>
|<<metricbeat-metricset-couchbase-cluster,cluster>>
|<<metricbeat-metricset-couchbase-node,node>>
|<<metricbeat-metricset-couchbase-syncgateway,syncgateway>>
|<<metricbeat-module-couchdb,CouchDB>> |image:./images/icon-yes.png[Prebuilt dashboards are available] |
.1+| .1+| |<<metricbeat-metricset-couchdb-server,server>>
|<<metricbeat-module-docker,Docker>> |image:./images/icon-yes.png[Prebuilt dashboards are available] |
Expand Down Expand Up @@ -255,6 +254,8 @@ This file is generated! See scripts/mage/docs_collector.go
|<<metricbeat-metricset-stan-subscriptions,subscriptions>>
|<<metricbeat-module-statsd,Statsd>> |image:./images/icon-no.png[No prebuilt dashboards] |
.1+| .1+| |<<metricbeat-metricset-statsd-server,server>>
|<<metricbeat-module-syncgateway,SyncGateway>> |image:./images/icon-no.png[No prebuilt dashboards] |
.1+| .1+| |<<metricbeat-metricset-syncgateway-db,db>>
|<<metricbeat-module-system,System>> |image:./images/icon-yes.png[Prebuilt dashboards are available] |
.18+| .18+| |<<metricbeat-metricset-system-core,core>>
|<<metricbeat-metricset-system-cpu,cpu>>
Expand Down Expand Up @@ -351,6 +352,7 @@ include::modules/redisenterprise.asciidoc[]
include::modules/sql.asciidoc[]
include::modules/stan.asciidoc[]
include::modules/statsd.asciidoc[]
include::modules/syncgateway.asciidoc[]
include::modules/system.asciidoc[]
include::modules/tomcat.asciidoc[]
include::modules/traefik.asciidoc[]
Expand Down
6 changes: 5 additions & 1 deletion metricbeat/include/list_common.go

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

7 changes: 5 additions & 2 deletions metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -860,8 +860,11 @@ metricbeat.modules:

#----------------------------- SyncGateway Module -----------------------------
- module: syncgateway
#metricsets:
# - db
# metricsets:
# - db
# - memory
# - replication
# - resources
period: 10s

# SyncGateway hosts
Expand Down
7 changes: 5 additions & 2 deletions metricbeat/module/syncgateway/_meta/config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
- module: syncgateway
#metricsets:
# - db
# metricsets:
# - db
# - memory
# - replication
# - resources
period: 10s

# SyncGateway hosts
Expand Down
Loading