Skip to content

Commit

Permalink
Add edits for prometheus module docs (elastic#3520)
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton authored and ruflin committed Feb 8, 2017
1 parent 60e7999 commit f006365
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 26 deletions.
14 changes: 7 additions & 7 deletions metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4708,7 +4708,7 @@ Time at which these statistics were last reset.
== Prometheus Fields
beta[]
Prometheus Module
Stats collected from Prometheus.
Expand All @@ -4721,14 +4721,14 @@ Prometheus Module
[float]
== stats Fields
stats
Stats about the Prometheus server.
[float]
== notifications Fields
Notification stats
Notification stats.
Expand All @@ -4737,31 +4737,31 @@ Notification stats
type: long
Current queue length
Current queue length.
[float]
=== prometheus.stats.notifications.dropped
type: long
Dropped queue events
Number of dropped queue events.
[float]
=== prometheus.stats.processes.open_fds
type: long
Open file descriptors gauge
Number of open file descriptors.
[float]
=== prometheus.stats.storage.chunks_to_persist
type: long
Gauge on chunks which are not persisted to disk yet
Number of memory chunks that are not yet persisted to disk.
[[exported-fields-redis]]
Expand Down
6 changes: 3 additions & 3 deletions metricbeat/docs/modules/prometheus.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ This file is generated! See scripts/docs_collector.py
////

[[metricbeat-module-prometheus]]
== prometheus Module
== Prometheus Module

beta[]

This is the prometheus Module.

This module periodically fetches metrics from
https://prometheus.io/docs/[Prometheus].


[float]
Expand Down
6 changes: 3 additions & 3 deletions metricbeat/module/prometheus/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== prometheus Module
== Prometheus Module

beta[]

This is the prometheus Module.

This module periodically fetches metrics from
https://prometheus.io/docs/[Prometheus].
4 changes: 2 additions & 2 deletions metricbeat/module/prometheus/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "Prometheus"
description: >
beta[]
Prometheus Module
Stats collected from Prometheus.
short_config: false
fields:
- name: prometheus
Expand Down
8 changes: 5 additions & 3 deletions metricbeat/module/prometheus/collector/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
=== prometheus collector MetricSet
=== Prometheus Collector Metricset

This is the collector metricset of the module prometheus. It allows to fetch data from https://prometheus.io/docs/instrumenting/exporters/[prometheus exporters].
The Prometheus `collector` metricset fetches data from https://prometheus.io/docs/instrumenting/exporters/[prometheus exporters].

All events with the same labels are grouped together as one event.
All events with the same labels are grouped together as one event. The fields
exported by this metricset vary depending on the Prometheus exporter that you're
using.
5 changes: 3 additions & 2 deletions metricbeat/module/prometheus/stats/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
=== prometheus stats MetricSet
=== Prometheus Stats Metricset

This is the stats metricset of the module prometheus.
The Prometheus `stats` metricset collects statistics about the Prometheus
server.
12 changes: 6 additions & 6 deletions metricbeat/module/prometheus/stats/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
- name: stats
type: group
description: >
stats
Stats about the Prometheus server.
fields:
- name: notifications
type: group
description: >
Notification stats
Notification stats.
fields:
- name: queue_length
type: long
description: >
Current queue length
Current queue length.
- name: dropped
type: long
description: >
Dropped queue events
Number of dropped queue events.
- name: processes.open_fds
type: long
description: >
Open file descriptors gauge
Number of open file descriptors.
- name: storage.chunks_to_persist
type: long
description: >
Gauge on chunks which are not persisted to disk yet
Number of memory chunks that are not yet persisted to disk.

0 comments on commit f006365

Please sign in to comment.