Skip to content

Commit

Permalink
Add more FAQs
Browse files Browse the repository at this point in the history
  • Loading branch information
frodenas committed Nov 9, 2016
1 parent da8f6c2 commit 1e6448e
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
21 changes: 20 additions & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### What metrics does this exporter report?

The Cloud Foundry Prometheus Exporter gets the metrics from the [Cloud Foundry API][cf_api]. The metrics that are being [reported][cf_exporter_metrics] are enumerations of administrative information, and include:
The Cloud Foundry Prometheus Exporter gets information from the [Cloud Foundry API][cf_api]. The metrics that are being [reported][cf_exporter_metrics] are enumerations of administrative information, and include:

* Applications information:
* Application information (id, name, space id and name, organization id and name)
Expand All @@ -17,6 +17,25 @@ The Cloud Foundry Prometheus Exporter gets the metrics from the [Cloud Foundry A
* Space information (id, name)
* Total number of spaces

### How can I get detailed application metrics like CPU & Memory?

The goal of this exporter is just to provide administrative information about your Cloud Foundry environment. If you want to get detailed runtime application metrics, then you will need to use a different exporter, specifically, the [Firehose exporter][firehose_exporter], who will get `Container Metrics` from the [Cloud Foundry Firehose][firehose].

### Can I combine labels from a different exporter to get readable names?

Yes. You can combine this exporter with another exporter as far as there is a metric matching label.

For example, if you want to combine the `Container Metrics` from the [Firehose exporter][firehose_exporter] with this exporter you can run a query like:

```
firehose_container_metric_cpu_percentage
* on(application_id)
group_left(application_name, organization_name, space_name)
cf_application_info
```

The *on* specifies the matching label, in this case, the *application_id*. The *group_left* specifies what labels (*application_name*, *organization_name*, *space_name*) from the right metric (*cf_application_info*) should be merged into the left metric (*firehose_container_metric_cpu_percentage*).

### How can I enable only a particular collector?

The *filter.collectors* command flag allows you to filter what collectors will be enabled. Possible values are `Applications`, `Organizations`, `Services`, `Spaces` (or a combination of them).
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cloud Foundry Prometheus Exporter [![Build Status](https://travis-ci.org/cloudfoundry-community/cf_exporter.png)](https://travis-ci.org/cloudfoundry-community/cf_exporter)

A [Prometheus][prometheus] exporter for [Cloud Foundry][cloudfoundry] metrics. Please refer to the [FAQ][faq] for general questions about this exporter.
A [Prometheus][prometheus] exporter for [Cloud Foundry][cloudfoundry] administrative information. Please refer to the [FAQ][faq] for general questions about this exporter.

## Architecture overview

Expand Down

0 comments on commit 1e6448e

Please sign in to comment.