Skip to content

Commit

Permalink
Update README & FAQ with some warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
frodenas committed Jan 3, 2017
1 parent 6e46cd4 commit 285baf0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,13 @@ The Cloud Foundry Prometheus Exporter gets information from the [Cloud Foundry A
* Space information (id, name)
* Total number of spaces

### Known issues
### What are the caveats when using this exporter?

This exporter is known to require quite some resources on the `cloud_controller` since the queries include an `inline-relations-depth=2` API call, which basically dumps the `ccdb` and transforms it into `json` response. This may result in a very poor `cloud_controller` API performance. To prevent this, consider setting a reasonable `scrape_interval`.
There are several collectors that require quite some resources on the `cloud_controller` and may result in a very poor CF API performance. To prevent this, consider setting a reasonable `scrape_interval` when using this exporter.

* `Applications` collector: the query to get all applications includes an `inline-relations-depth=2` API call, which basically dumps the `ccdb` and transforms it into `json` response.

* `ApplicationEvents` collector: the query fetches all events for ALL applications, and this may require sending some long queries.

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

Expand All @@ -47,7 +51,7 @@ The *on* specifies the matching label, in this case, the *application_id*. The *

### 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`, `ApplicationEvents`, `Organizations`, `SecurityGroups`, `Services`, `Spaces` (or a combination of them).
The `filter.collectors` command flag allows you to filter what collectors will be enabled (if not set, all collectors will be enabled by default). Possible values are `Applications`, `ApplicationEvents`, `Organizations`, `SecurityGroups`, `Services`, `Spaces` (or a combination of them).

### Can I target multiple Cloud Foundry API endpoints with a single exporter instance?

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ This exporter can be deployed using the [Prometheus BOSH Release][prometheus-bos
| `cf.password`<br />`CF_EXPORTER_CF_PASSWORD` | *[1]* | | Cloud Foundry Password |
| `cf.client-id`<br />`CF_EXPORTER_CF_CLIENT_ID` | *[1]* | | Cloud Foundry Client ID (must have the `cloud_controller.admin` or `cloud_controller.admin_read_only` scope) |
| `cf.client-secret`<br />`CF_EXPORTER_CF_CLIENT_SECRET` | *[1]* | | Cloud Foundry Client Secret |
| `filter.collectors`<br />`CF_EXPORTER_FILTER_COLLECTORS` | No | | Comma separated collectors to filter (`Applications`, `ApplicationEvents`, `Organizations`, `SecurityGroups`, `Services`, `Spaces`) |
| `filter.collectors`<br />`CF_EXPORTER_FILTER_COLLECTORS` | No | | Comma separated collectors to filter. If not set, all collectors will be enabled (`Applications`, `ApplicationEvents`, `Organizations`, `SecurityGroups`, `Services`, `Spaces`) |
| `metrics.namespace`<br />`CF_EXPORTER_METRICS_NAMESPACE` | No | `cf` | Metrics Namespace |
| `skip-ssl-verify`<br />`CF_EXPORTER_SKIP_SSL_VERIFY` | No | `false` | Disable SSL Verify |
| `web.listen-address`<br />`CF_EXPORTER_WEB_LISTEN_ADDRESS` | No | `:9193` | Address to listen on for web interface and telemetry |
Expand Down

0 comments on commit 285baf0

Please sign in to comment.