Using Log Management Services
Page last updated:
This page assumes you are using cf CLI v6.
This topic describes how to drain logs from Cloud Foundry to a third party log management service.
Cloud Foundry aggregates logs for all instances of your applications as well as for requests made to your applications through internal components of Cloud Foundry. For example, when the Cloud Foundry Router forwards a request to an application, the Router records that event in the log stream for that app. Run the following command to access the log stream for an app in the terminal:
cf logs YOUR-APP-NAME
If you want to persist more than the limited amount of logging information that Cloud Foundry can buffer, drain these logs to a log management service.
For more information about the systems responsible for log aggregation and streaming in Cloud Foundry, see Application Logging in Cloud Foundry.
The Cloud Foundry marketplace offers several log management services. To use one of these services, create an instance of the service and bind it to your application. See the following topics for more information:
- Service-Specific Instructions for Streaming Application Logs to learn how to stream application logs to specific services including Papertrail, Splunk, and SumoLogic.
- Managing Service Instances to learn about creating and binding service instances.
Note: Not all marketplace services support syslog drains. Some services implement an integration with Cloud Foundry that enables automated streaming of application syslogs. If you are interested in building Services for Cloud Foundry and making them available to end users, see the Custom Services documentation.
If a compatible log management service is not available in your Cloud Foundry marketplace, use the following procedure to stream your logs to a service of your choice.
Note: Only use this procedure if the service that you want to use is not covered in the Service-Specific Instructions for Streaming Application Logs topic.
Step 1: Configure the Log Management Service
Complete the following steps to set up a communication channel between the log management service and your Cloud Foundry deployment:
Obtain the external IP addresses that your Cloud Foundry administrator assigns to outbound traffic.
Provide these IP addresses to the log management service. The specific steps to configure a third-party log management service depend on the service. See the Service-Specific Instructions for Streaming Application Logs topic for more information.
Whitelist these IP addresses to ensure unrestricted log routing to your log management service.
Record the syslog URL provided by the third-party service. Third-party services typically provide a syslog URL to use as an endpoint for incoming log data. You use this syslog URL in Step 2: Create a User-provided Service Instance.
Cloud Foundry uses the syslog URL to route messages to the service. The syslog URL has a scheme of
https, and can include a port number. For example:
Note: Cloud Foundry does not support using
syslog-tlswith self-signed certificates. If you are running your own syslog server and want to use
syslog-tls, you must have an SSL certificate signed by a well-known certificate authority.
Step 2: Create a User-provided Service Instance
Create a user-provided service instance using the cf CLI
create-user-provided-service command with the
-l flag and the syslog URL that you obtained in Step 1: Configure the Log Management Service.
-l flag configures the syslog drain.
$ cf create-user-provided-service SERVICE-INSTANCE -l SYSLOG-URL
Refer to User-Provided Service Instances for more information.
Step 3: Bind the Service Instance
You have two options for binding the service instance to an application:
cf pushwith a manifest. The services block in the manifest must specify the service instance that you want to bind.
cf bind-service. After a short delay, logs begin to flow automatically.
Refer to Delivering Service Credentials to an Application for more information.
Step 4: Verify Logs are Draining
To verify that logs are draining correctly to a third-party log management service:
Take actions that produce log messages, such as making requests of your app.
Compare the logs displayed in the CLI against those displayed by the log management service.
For example, if your application serves web pages, you can send HTTP requests to the application. In Cloud Foundry, these generate Router log messages, which you can view in the CLI. Your third-party log management service should display corresponding messages.
Note: For security reasons, Cloud Foundry applications do not respond to
ping. You cannot use
ping to generate log entries.