﻿---
title: Add Cloud Foundry metadata
description: The add_cloudfoundry_metadata processor annotates each event with relevant metadata from Cloud Foundry applications. For events to be annotated with Cloud...
url: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4487/reference/fleet/add_cloudfoundry_metadata-processor
products:
  - Elastic Agent
  - Fleet
---

# Add Cloud Foundry metadata
The `add_cloudfoundry_metadata` processor annotates each event with relevant metadata from Cloud Foundry applications.
For events to be annotated with Cloud Foundry metadata, they must have a field called `cloudfoundry.app.id` that contains a reference to a Cloud Foundry application, and the configured Cloud Foundry client must be able to retrieve information for the application.
Each event is annotated with:
- Application Name
- Space ID
- Space Name
- Organization ID
- Organization Name

<note>
  Pivotal Application Service and Tanzu Application Service include this metadata in all events from the firehose since version 2.8. In these cases the metadata in the events is used, and `add_cloudfoundry_metadata` processor doesn’t modify these fields.
</note>

For efficient annotation, application metadata retrieved by the Cloud Foundry client is stored in a persistent cache on the filesystem. This is done so the metadata can persist across restarts of Elastic Agent and its underlying programs. For control over this cache, use the `cache_duration` and `cache_retry_delay` settings.

## Example

```yaml
  - add_cloudfoundry_metadata:
      api_address: https://api.dev.cfdev.sh
      client_id: uaa-filebeat
      client_secret: verysecret
      ssl:
        verification_mode: none
      # To connect to Cloud Foundry over verified TLS you can specify a client and CA certificate.
      #ssl:
      #  certificate_authorities: ["/etc/pki/cf/ca.pem"]
      #  certificate:              "/etc/pki/cf/cert.pem"
      #  key:                      "/etc/pki/cf/cert.key"
```


## Configuration settings

<note>
  Elastic Agent processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to Elasticsearch. For related limitations, refer to [What are some limitations of using processors?](/elastic/docs-content/pull/4487/reference/fleet/agent-processors#limitations)
</note>


| Name                | Required | Default                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|---------------------|----------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `api_address`       | No       | `http://api.bosh-lite.com` | URL of the Cloud Foundry API.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `doppler_address`   | No       | `${api_address}/v2/info`   | URL of the Cloud Foundry Doppler Websocket.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `uaa_address`       | No       | `${api_address}/v2/info`   | URL of the Cloud Foundry UAA API.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `rlp_address`       | No       | `${api_address}/v2/info`   | URL of the Cloud Foundry RLP Gateway.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `client_id`         | Yes      |                            | Client ID to authenticate with Cloud Foundry.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `client_secret`     | Yes      |                            | Client Secret to authenticate with Cloud Foundry.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `cache_duration`    | No       | `120s`                     | Maximum amount of time to cache an application’s metadata.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `cache_retry_delay` | No       | `20s`                      | Time to wait before trying to obtain an application’s metadata again in case of error.                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `ssl`               | No       |                            | SSL configuration to use when connecting to Cloud Foundry. For a list of available settings, refer to [SSL/TLS](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4487/reference/fleet/elastic-agent-ssl-configuration), specifically the settings under [Table 7, Common configuration options](/elastic/docs-content/pull/4487/reference/fleet/elastic-agent-ssl-configuration#common-ssl-options) and [Table 8, Client configuration options](/elastic/docs-content/pull/4487/reference/fleet/elastic-agent-ssl-configuration#client-ssl-options). |