You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/prometheus_input/docs/README.md
+14-18Lines changed: 14 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,23 @@
1
1
# Prometheus Input Package
2
2
3
-
This input package can collect metrics from [Prometheus Exporters (Collectors)](https://prometheus.io/docs/instrumenting/exporters/). It gives users the flexibility to add custom mappings and ingest pipelines.
3
+
The Prometheus Input package allows you to collect metrics from [Prometheus Exporters (Collectors)](https://prometheus.io/docs/instrumenting/exporters/) and gives you the flexibility to add custom mappings and ingest pipelines.
4
4
5
5
## Metrics
6
6
7
-
#### Scraping from a Prometheus exporter
7
+
#### Collect metrics from a Prometheus exporter
8
8
9
-
To scrape metrics from a Prometheus exporter, configure the `hosts` setting to it. The path
10
-
to retrieve the metrics from (`/metrics` by default) is appended to the hostname as below:
9
+
To collect metrics from a Prometheus exporter, configure the `hosts` setting to it and append the <metrics_path> from which you are collecting your metrics (`/metrics` by default), by using the following format:
Example Host Configuration: `http://localhost:9090/metrics`
12
+
This is an example of host configuration: `http://localhost:9090/metrics`
14
13
15
14
#### Histograms and types
16
15
17
-
`Use Types` parameter (default: `true`) enables a different layout for metrics storage, leveraging Elasticsearch
18
-
types, including [histograms](https://www.elastic.co/guide/en/elasticsearch/reference/current/histogram.html)
16
+
The parameter `Use Types` (default: `true`) enables a different layout for metrics storage, leveraging Elasticsearch types, including [histograms](https://www.elastic.co/guide/en/elasticsearch/reference/current/histogram.html).
19
17
20
-
`Rate Counters` parameter (default: `true`) enables calculating a rate out of Prometheus counters. When enabled, integration stores
21
-
the counter increment since the last collection. This metric provides better aggregation.
22
-
This parameter can only be enabled in combination with `Use Types`.
18
+
The parameter `Rate Counters` (default: `true`) allows you to calculate a rate out of Prometheus counters. When enabled, integration stores the counter increment since the last collection. This metric provides better aggregation. This parameter can only be enabled in combination with the parameter `Use Types`.
23
19
24
-
When `Use Types` and `Rate Counters` are enabled, metrics are stored like this:
20
+
When `Use Types` and `Rate Counters` are enabled, metrics are stored as follows:
25
21
26
22
```json
27
23
{
@@ -51,7 +47,7 @@ When `Use Types` and `Rate Counters` are enabled, metrics are stored like this:
51
47
52
48
#### Filtering metrics
53
49
54
-
In order to filter out/in metrics one can make use of `Metrics Filters Include`, `Metrics Filters Exclude` settings:
50
+
To filter out/in metrics, you can use the following settings:
The users of the Prometheus Input Package have the option of adding their own dataset name, to which the events get added. Prometheus Metrics from different services can be collected by adding multiple instances of Input package. The metrics can be filtered on the basis of dataset name.
68
+
### Datastream dataset name
69
+
70
+
By using the Prometheus Input Package, you can add your own dataset name, to which the events get added. You can collect Prometheus metrics from different services by adding multiple instances of the Input package. Metrics can be filtered based on the dataset name.
0 commit comments