Add Cloud Foundry metadata
editAdd Cloud Foundry metadata
editThe 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
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.
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
edit- 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
editElastic 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?
Name | Required | Default | Description |
---|---|---|---|
|
No |
|
URL of the Cloud Foundry API. |
|
No |
|
URL of the Cloud Foundry Doppler Websocket. |
|
No |
|
URL of the Cloud Foundry UAA API. |
|
No |
|
URL of the Cloud Foundry RLP Gateway. |
|
Yes |
Client ID to authenticate with Cloud Foundry. |
|
|
Yes |
Client Secret to authenticate with Cloud Foundry. |
|
|
No |
|
Maximum amount of time to cache an application’s metadata. |
|
No |
|
Time to wait before trying to obtain an application’s metadata again in case of error. |
|
No |
SSL configuration to use when connecting to Cloud Foundry. For a list of available settings, refer to SSL/TLS, specifically the settings under Table 4, “Common configuration options” and Table 5, “Client configuration options”. |