https://github.com/cloudfoundry/cf_exporter
Cloud Foundry Prometheus Exporter
https://github.com/cloudfoundry/cf_exporter
cloud-foundry metrics prometheus
Last synced: 6 months ago
JSON representation
Cloud Foundry Prometheus Exporter
- Host: GitHub
- URL: https://github.com/cloudfoundry/cf_exporter
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2016-11-09T09:54:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-12T19:07:06.000Z (8 months ago)
- Last Synced: 2025-04-15T03:54:42.151Z (6 months ago)
- Topics: cloud-foundry, metrics, prometheus
- Language: Go
- Size: 26.2 MB
- Stars: 22
- Watchers: 44
- Forks: 25
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cloud Foundry Prometheus 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
## Installation
### Binaries
Download the already existing [binaries][binaries] for your platform:
```bash
$ ./cf_exporter
```
### From source
Using the standard `go install` (you must have [Go][golang] already installed in your local machine):
```bash
$ go install github.com/cloudfoundry/cf_exporter
$ cf_exporter
```
### Docker
To run the cf exporter as a Docker container, run:
```bash
$ docker run -p 9193:9193 boshprometheus/cf-exporter
```
### Cloud Foundry
The exporter can be deployed to an already existing [Cloud Foundry][cloudfoundry] environment:
```bash
$ git clone https://github.com/cloudfoundry/cf_exporter.git
$ cd cf_exporter
```
Modify the included [application manifest file][manifest] to include your Cloud Foundry properties.
Then you can push the exporter to your Cloud Foundry environment:
```bash
$ cf push cf_exporter -f ./packages/cf/manifest.yml
```
### BOSH
This exporter can be deployed using the [Prometheus BOSH Release][prometheus-boshrelease].
## Usage
### UAA Client
In order to connect to the [Cloud Foundry API][cf_api] a `client-id` and `client-secret` must be provided. The `client-id` must have the `cloud_controller.admin` authority.
For example, to create a new `client-id` and `client-secret` with the right permissions:
```bash
uaac target https:// --skip-ssl-validation
uaac token client get -s
uaac client add prometheus-cf \
--name prometheus-cf \
--secret prometheus-cf-client-secret \
--authorized_grant_types client_credentials,refresh_token \
--authorities cloud_controller.admin
```
### Flags
```
usage: cf_exporter --cf.api_url=CF.API_URL --cf.deployment-name=CF.DEPLOYMENT-NAME --metrics.environment=METRICS.ENVIRON MENT []
Flags:
-h, --help Show context-sensitive help (also try --help-long and --help-man).
--cf.api_url=CF.API_URL Cloud Foundry API URL ($CF_EXPORTER_CF_API_URL)
--cf.username=CF.USERNAME Cloud Foundry Username ($CF_EXPORTER_CF_USERNAME)
--cf.password=CF.PASSWORD Cloud Foundry Password ($CF_EXPORTER_CF_PASSWORD)
--cf.client-id=CF.CLIENT-ID
Cloud Foundry Client ID ($CF_EXPORTER_CF_CLIENT_ID)
--cf.client-secret=CF.CLIENT-SECRET
Cloud Foundry Client Secret ($CF_EXPORTER_CF_CLIENT_SECRET)
--cf.deployment-name=CF.DEPLOYMENT-NAME
Cloud Foundry Deployment Name to be reported as a metric label
($CF_EXPORTER_CF_DEPLOYMENT_NAME)
--events.query="" When the Events filter is enabled and this value is set, this query is sent to the
CloudController to limit the number of results returned. Syntax is exactly as
documented at the Cloud Foundry API ($CF_EXPORTER_EVENTS_QUERY)
--filter.collectors="" Comma separated collectors to filter
(Applications,Buildpacks,Events,IsolationSegments,Organizations,Routes,
SecurityGroups,ServiceBindings,ServiceInstances,ServicePlans,Services,Spaces,Stacks).
If not set, all collectors except Events is enabled ($CF_EXPORTER_FILTER_COLLECTORS)
--metrics.namespace="cf" Metrics Namespace ($CF_EXPORTER_METRICS_NAMESPACE)
--metrics.environment=METRICS.ENVIRONMENT
Environment label to be attached to metrics ($CF_EXPORTER_METRICS_ENVIRONMENT)
--skip-ssl-verify Disable SSL Verify ($CF_EXPORTER_SKIP_SSL_VERIFY)
--web.listen-address=":9193"
Address to listen on for web interface and telemetry ($CF_EXPORTER_WEB_LISTEN_ADDRESS)
--web.telemetry-path="/metrics"
Path under which to expose Prometheus metrics ($CF_EXPORTER_WEB_TELEMETRY_PATH)
--web.auth.username=WEB.AUTH.USERNAME
Username for web interface basic auth ($CF_EXPORTER_WEB_AUTH_USERNAME)
--web.auth.password=WEB.AUTH.PASSWORD
Password for web interface basic auth ($CF_EXPORTER_WEB_AUTH_PASSWORD)
--web.tls.cert_file=WEB.TLS.CERT_FILE
Path to a file that contains the TLS certificate (PEM format). If the certificate is
signed by a certificate authority, the file should be the concatenation of the server's
certificate, any intermediates, and the CA's certificate
($CF_EXPORTER_WEB_TLS_CERTFILE)
--web.tls.key_file=WEB.TLS.KEY_FILE
Path to a file that contains the TLS private key (PEM format)
($CF_EXPORTER_WEB_TLS_KEYFILE)
--log.level="error" Only log messages with the given severity or above. Valid levels: [debug, info, warn,
error, fatal]
--log.format="stdout" Set output stream for log. Valid outputs: [stderr, stdout]
--log.json Output logs with JSON format
--collector.workers=10 Number of requests threads for collector
--version Show application version.
```
Either `--cf.username` and `--cf.password` or `--cf.client-id` and `--cf.client-secret` must be provided.
### Metrics
The exporter returns the following `Applications` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_application_info | Labeled Cloud Foundry Application information with a constant `1` value | `environment`, `deployment`, `application_id`, `application_name`, `detected_buildpack`, `buildpack`, `organization_id`, `organization_name`, `space_id`, `space_name`, `stack_id`, `state` |
| *metrics.namespace*_application_instances | Number of desired Cloud Foundry Application Instances | `environment`, `deployment`, `application_id`, `application_name`, `organization_id`, `organization_name`, `space_id`, `space_name`, `state` |
| *metrics.namespace*_application_instances_running | Number of running Cloud Foundry Application Instances | `environment`, `deployment`, `application_id`, `application_name`, `organization_id`, `organization_name`, `space_id`, `space_name`, `state` |
| *metrics.namespace*_application_memory_mb | Cloud Foundry Application Memory (Mb) | `environment`, `deployment`, `application_id`, `application_name`, `organization_id`, `organization_name`, `space_id`, `space_name` |
| *metrics.namespace*_application_disk_quota_mb | Cloud Foundry Application Disk Quota (Mb) | `environment`, `deployment`, `application_id`, `application_name`, `organization_id`, `organization_name`, `space_id`, `space_name` |
| *metrics.namespace*_application_buildpack | All the buildpacks used by an Application. | `environment`, `deployment`, `application_id`, `application_name`, `buildpack_name`
| *metrics.namespace*_applications_scrapes_total | Total number of scrapes for Cloud Foundry Applications | `environment`, `deployment` |
| *metrics.namespace*_applications_scrape_errors_total | Total number of scrape errors of Cloud Foundry Applications | `environment`, `deployment` |
| *metrics.namespace*_last_applications_scrape_error | Whether the last scrape of Applications metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_applications_scrape_timestamp | Number of seconds since 1970 since last scrape of Applications metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_applications_scrape_duration_seconds | Duration of the last scrape of Applications metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Buildpacks` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_buildpack_info | Labeled Cloud Foundry Buildpacks information with a constant `1` value | `environment`, `deployment`, `buildpack_id`, `buildpack_name`, `buildpack_stack`, `buildpack_filename` |
| *metrics.namespace*_buildpacks_scrapes_total | Total number of scrapes for Cloud Foundry Buildpacks | `environment`, `deployment` |
| *metrics.namespace*_buildpacks_scrape_errors_total | Total number of scrape errors of Cloud Foundry Buildpacks | `environment`, `deployment` |
| *metrics.namespace*_last_buildpacks_scrape_error | Whether the last scrape of Buildpacks metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_buildpacks_scrape_timestamp | Number of seconds since 1970 since last scrape of Buildpacks metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_buildpacks_scrape_duration_seconds | Duration of the last scrape of Buildpacks metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Domain` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_domain_info | Cloud Foundry domains, labeled by domain ID, name, whether it is internal, and supported protocol. Metric value is set to 1. | `environment`, `deployment`, `domain_id`, `domain_name`, `internal`, `protocol` |
| *metrics.namespace*_domain_scrapes_total | Total number of scrapes for Cloud Foundry Domains | `environment`, `deployment` |
| *metrics.namespace*_domain_scrape_errors_total | Total number of scrape errors of Cloud Foundry Domains | `environment`, `deployment` |
| *metrics.namespace*_last_domains_scrape_error | Whether the last scrape of Domain metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_domains_scrape_timestamp | Number of seconds since 1970 since last scrape of Domain metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_domains_scrape_duration_seconds | Duration of the last scrape of Domain metrics from Cloud Foundry | `environment`, `deployment`
The exporter returns the following `Events` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_events_info | Labeled Cloud Foundry Events information with a constant `1` value | `environment`, `deployment`, `type`, `actor`, `actor_type`, `actor_name`, `actor_username`, `actee`, `actee_type`, `actee_name`, `space_id`, `organization_id` |
| *metrics.namespace*_events_scrapes_total | Total number of scrapes for Cloud Foundry Events | `environment`, `deployment` |
| *metrics.namespace*_events_scrape_errors_total | Total number of scrape errors of Cloud Foundry Events | `environment`, `deployment` |
| *metrics.namespace*_last_events_scrape_error | Whether the last scrape of Events metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_events_scrape_timestamp | Number of seconds since 1970 since last scrape of Events metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_events_scrape_duration_seconds | Duration of the last scrape of Events metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `IsolationSegments` metrics (requires `cf.api-v3-enabled` enabled):
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_isolation_segment_info | Labeled Cloud Foundry Isolation Segment information with a constant `1` value | `environment`, `deployment`, `isolation_segment_id`, `isolation_segment_name` |
| *metrics.namespace*_isolation_segments_scrapes_total | Total number of scrapes for Cloud Foundry Isolation Segments | `environment`, `deployment` |
| *metrics.namespace*_isolation_segments_scrape_errors_total | Total number of scrape errors of Cloud Foundry Isolation Segments | `environment`, `deployment` |
| *metrics.namespace*_last_isolation_segments_scrape_error | Whether the last scrape of Isolation Segments metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_isolation_segments_scrape_timestamp | Number of seconds since 1970 since last scrape of Isolation Segments metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_isolation_segments_scrape_duration_seconds | Duration of the last scrape of Isolation Segments metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Organizations` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_organization_info | Labeled Cloud Foundry Organization information with a constant `1` value | `environment`, `deployment`, `organization_id`, `organization_name`, `quota_name` |
| *metrics.namespace*_organization_non_basic_services_allowed | A Cloud Foundry Organization can provision instances of paid service plans? (`1` for `true`, `0` for `false`) | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_instance_memory_mb_limit | Maximum amount of memory (Mb) an application instance can have in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_app_instances_quota | Total number of application instances that may be created in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_app_tasks_quota | Total number of application tasks that may be created in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_memory_mb_quota | Total amount of memory (Mb) a Cloud Foundry Organization can have | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_private_domains_quota | Total number of private domains that may be created in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_reserved_route_ports_quota | Total number of routes that may be created with reserved ports in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_routes_quota | Total number of routes that may be created in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_service_keys_quota | Total number of service keys that may be created in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organization_total_services_quota | Total number of service instances that may be created in a Cloud Foundry Organization | `environment`, `deployment`, `organization_id`, `organization_name` |
| *metrics.namespace*_organizations_scrapes_total | Total number of scrapes for Cloud Foundry Organizations | `environment`, `deployment` |
| *metrics.namespace*_organizations_scrape_errors_total | Total number of scrape errors of Cloud Foundry Organizations | `environment`, `deployment` |
| *metrics.namespace*_last_organizations_scrape_error | Whether the last scrape of Organizations metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_organizations_scrape_timestamp | Number of seconds since 1970 since last scrape of Organizations metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_organizations_scrape_duration_seconds | Duration of the last scrape of Organizations metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Routes` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_route_info | Labeled Cloud Foundry Route information with a constant `1` value | `environment`, `deployment`, `route_id`, `route_host`, `route_path`, `domain_id`, `space_id`, `service_instance_id` |
| *metrics.namespace*_routes_scrapes_total | Total number of scrapes for Cloud Foundry Routes | `environment`, `deployment` |
| *metrics.namespace*_routes_scrape_errors_total | Total number of scrape errors of Cloud Foundry Routes | `environment`, `deployment` |
| *metrics.namespace*_last_routes_scrape_error | Whether the last scrape of Routes metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_routes_scrape_timestamp | Number of seconds since 1970 since last scrape of Routes metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_routes_scrape_duration_seconds | Duration of the last scrape of Routes metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Security Groups` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_security_group_info | Labeled Cloud Foundry Security Group information with a constant `1` value | `environment`, `deployment`, `security_group_id`, `security_group_name` |
| *metrics.namespace*_security_groups_scrapes_total | Total number of scrapes for Cloud Foundry Security Groups | `environment`, `deployment` |
| *metrics.namespace*_security_groups_scrape_errors_total | Total number of scrape errors of Cloud Foundry Security Groups | `environment`, `deployment` |
| *metrics.namespace*_last_security_groups_scrape_error | Whether the last scrape of Security Groups metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_security_groups_scrape_timestamp | Number of seconds since 1970 since last scrape of Security Groups metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_security_groups_scrape_duration_seconds | Duration of the last scrape of Security Groups metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Services` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_service_info | Labeled Cloud Foundry Service information with a constant `1` value | `environment`, `deployment`, `service_id`, `service_label` |
| *metrics.namespace*_services_scrapes_total | Total number of scrapes for Cloud Foundry Services | `environment`, `deployment` |
| *metrics.namespace*_services_scrape_errors_total | Total number of scrape errors of Cloud Foundry Services | `environment`, `deployment` |
| *metrics.namespace*_last_services_scrape_error | Whether the last scrape of Services metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_services_scrape_timestamp | Number of seconds since 1970 since last scrape of Services metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_services_scrape_duration_seconds | Duration of the last scrape of Services metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Service Bindings` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_service_binding_info | Labeled Cloud Foundry Service Binding information with a constant `1` value | `environment`, `deployment`, `service_binding_id`, `application_id`, `service_instance_id`, `route_binding_id` |
| *metrics.namespace*_service_bindings_scrapes_total | Total number of scrapes for Cloud Foundry Service Bindings | `environment`, `deployment` |
| *metrics.namespace*_service_bindings_scrape_errors_total | Total number of scrape errors of Cloud Foundry Service Bindings | `environment`, `deployment` |
| *metrics.namespace*_last_service_bindings_scrape_error | Whether the last scrape of Service Bindings metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_service_bindings_scrape_timestamp | Number of seconds since 1970 since last scrape of Service Bindings metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_service_bindings_scrape_duration_seconds | Duration of the last scrape of Service Bindings metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Service Route Bindings` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_service_route_binding_info | Labeled Cloud Foundry Service Route Binding information with a constant `1` value | `environment`, `deployment`, `route_id`, `route_service_url`, `service_instance_id`, `service_route_binding_id` |
| *metrics.namespace*_service_route_bindings_scrapes_total | Total number of scrapes for Cloud Foundry Service Bindings | `environment`, `deployment` |
| *metrics.namespace*_service_route_bindings_scrape_errors_total | Total number of scrape errors of Cloud Foundry Service Bindings | `environment`, `deployment` |
| *metrics.namespace*_last_service_route_bindings_scrape_error | Whether the last scrape of Service Bindings metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_service_route_bindings_scrape_timestamp | Number of seconds since 1970 since last scrape of Service Bindings metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_service_route_bindings_scrape_duration_seconds | Duration of the last scrape of Service Bindings metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Service Instances` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_service_instance_info | Labeled Cloud Foundry Service Instance information with a constant `1` value | `environment`, `deployment`, `service_instance_id`, `service_instance_name`, `service_plan_id`, `space_id`, `type`, `last_operation_type`, `last_operation_state` |
| *metrics.namespace*_service_instances_scrapes_total | Total number of scrapes for Cloud Foundry Service Instances | `environment`, `deployment` |
| *metrics.namespace*_service_instances_scrape_errors_total | Total number of scrape errors of Cloud Foundry Service Instances | `environment`, `deployment` |
| *metrics.namespace*_last_service_instances_scrape_error | Whether the last scrape of Service Instances metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_service_instances_scrape_timestamp | Number of seconds since 1970 since last scrape of Service Instances metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_service_instances_scrape_duration_seconds | Duration of the last scrape of Service Instances metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Service Plans` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_service_plan_info | Labeled Cloud Foundry Service Plan information with a constant `1` value | `environment`, `deployment`, `service_plan_id`, `service_plane_name`, `service_id` |
| *metrics.namespace*_service_plans_scrapes_total | Total number of scrapes for Cloud Foundry Service Plans | `environment`, `deployment` |
| *metrics.namespace*_service_plans_scrape_errors_total | Total number of scrape errors of Cloud Foundry Service Plans | `environment`, `deployment` |
| *metrics.namespace*_last_service_plans_scrape_error | Whether the last scrape of Service Plans metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_service_plans_scrape_timestamp | Number of seconds since 1970 since last scrape of Service Plans metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_service_plans_scrape_duration_seconds | Duration of the last scrape of Service Plans metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Spaces` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_space_info | Labeled Cloud Foundry Space information with a constant `1` value | `environment`, `deployment`, `space_id`, `space_name`, `organization_id`, `quota_name` |
| *metrics.namespace*_space_non_basic_services_allowed | A Cloud Foundry Space can provision instances of paid service plans? (`1` for `true`, `0` for `false`) | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_instance_memory_mb_limit | Maximum amount of memory (Mb) an application instance can have in a Cloud Foundry Space | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_total_app_instances_quota | Total number of application instances that may be created in a Cloud Foundry Space | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_total_app_tasks_quota | Total number of application tasks that may be created in a Cloud Foundry Space | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_total_memory_mb_quota | Total amount of memory (Mb) a Cloud Foundry Space can have | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_total_reserved_route_ports_quota | Total number of routes that may be created with reserved ports in a Cloud Foundry Space | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_total_routes_quota | Total number of routes that may be created in a Cloud Foundry Space | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_total_service_keys_quota | Total number of service keys that may be created in a Cloud Foundry Space | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_space_total_services_quota | Total number of service instances that may be created in a Cloud Foundry Space | `environment`, `deployment`, `space_id`, `space_name`, `organization_id` |
| *metrics.namespace*_spaces_scrapes_total | Total number of scrapes for Cloud Foundry Spaces | `environment`, `deployment` |
| *metrics.namespace*_spaces_scrape_errors_total | Total number of scrape errors of Cloud Foundry Spaces | `environment`, `deployment` |
| *metrics.namespace*_last_spaces_scrape_error | Whether the last scrape of Spaces metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_spaces_scrape_timestamp | Number of seconds since 1970 since last scrape of Spaces metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_spaces_scrape_duration_seconds | Duration of the last scrape of Spaces metrics from Cloud Foundry | `environment`, `deployment` |
The exporter returns the following `Stacks` metrics:
| Metric | Description | Labels |
| ------ | ----------- | ------ |
| *metrics.namespace*_stack_info | Labeled Cloud Foundry Stack information with a constant `1` value | `environment`, `deployment`, `stack_id`, `stack_name` |
| *metrics.namespace*_stacks_scrapes_total | Total number of scrapes for Cloud Foundry Stacks | `environment`, `deployment` |
| *metrics.namespace*_stacks_scrape_errors_total | Total number of scrape errors of Cloud Foundry Stacks | `environment`, `deployment` |
| *metrics.namespace*_last_stacks_scrape_error | Whether the last scrape of Stacks metrics from Cloud Foundry resulted in an error (`1` for error, `0` for success) | `environment`, `deployment` |
| *metrics.namespace*_last_stacks_scrape_timestamp | Number of seconds since 1970 since last scrape of Stacks metrics from Cloud Foundry | `environment`, `deployment` |
| *metrics.namespace*_last_stacks_scrape_duration_seconds | Duration of the last scrape of Stacks metrics from Cloud Foundry | `environment`, `deployment` |
## Contributing
Refer to the [contributing guidelines][contributing].
## License
Apache License 2.0, see [LICENSE][license].
[binaries]: https://github.com/cloudfoundry/cf_exporter/releases
[cf_api_v2]: https://v2-apidocs.cloudfoundry.org/
[cf_api_v3]: https://v3-apidocs.cloudfoundry.org/
[cloudfoundry]: https://www.cloudfoundry.org/
[contributing]: ./CONTRIBUTING.md
[faq]: ./FAQ.md
[golang]: https://golang.org/
[license]: ./LICENSE
[manifest]: ./packages/cf/manifest.yml
[prometheus]: https://prometheus.io/
[prometheus-boshrelease]: https://github.com/cloudfoundry/prometheus-boshrelease