Access logs for your Network Load Balancer
Elastic Load Balancing provides access logs that capture detailed information about the TLS requests sent to your Network Load Balancer. You can use these access logs to analyze traffic patterns and troubleshoot issues.
Important
Access logs are created only if the load balancer has a TLS listener and they contain information only about TLS requests.
Access logging is an optional feature of Elastic Load Balancing that is disabled by default. After you enable access logging for your load balancer, Elastic Load Balancing captures the logs as compressed files and stores them in the Amazon S3 bucket that you specify. You can disable access logging at any time.
You can enable server-side encryption with Amazon S3-managed encryption keys (SSE-S3), or using Key Management Service with Customer Managed Keys (SSE-KMS CMK) for your S3 bucket. Each access log file is automatically encrypted before it is stored in your S3 bucket and decrypted when you access it. You do not need to take any action as there is no difference in the way you access encrypted or unencrypted log files. Each log file is encrypted with a unique key, which is itself encrypted with a KMS key that is regularly rotated. For more information, see Specifying Amazon S3 encryption (SSE-S3) and Specifying server-side encryption with AWS KMS (SSE-KMS) in the Amazon S3 User Guide.
There is no additional charge for access logs. You are charged storage costs for Amazon S3,
but not charged for the bandwidth used by Elastic Load Balancing to send log files to Amazon S3. For more
information about storage costs, see Amazon S3
Pricing
Access log files
Elastic Load Balancing publishes a log file for each load balancer node every 5 minutes. Log delivery is eventually consistent. The load balancer can deliver multiple logs for the same period. This usually happens if the site has high traffic.
The file names of the access logs use the following format:
bucket
[/prefix
]/AWSLogs/aws-account-id
/elasticloadbalancing/region
/yyyy
/mm
/dd
/aws-account-id
_elasticloadbalancing_region
_net.load-balancer-id
_end-time
_random-string
.log.gz
- bucket
-
The name of the S3 bucket.
- prefix
-
The prefix (logical hierarchy) in the bucket. If you don't specify a prefix, the logs are placed at the root level of the bucket.
- aws-account-id
-
The AWS account ID of the owner.
- region
-
The Region for your load balancer and S3 bucket.
- yyyy/mm/dd
-
The date that the log was delivered.
- load-balancer-id
-
The resource ID of the load balancer. If the resource ID contains any forward slashes (/), they are replaced with periods (.).
- end-time
-
The date and time that the logging interval ended. For example, an end time of 20181220T2340Z contains entries for requests made between 23:35 and 23:40.
- random-string
-
A system-generated random string.
The following is an example log file name:
s3://my-bucket/prefix/AWSLogs/123456789012/elasticloadbalancing/us-east-2/2020/05/01/123456789012_elasticloadbalancing_us-east-2_net.my-loadbalancer.1234567890abcdef_20200501T0000Z_20sg8hgm.log.gz
You can store your log files in your bucket for as long as you want, but you can also define Amazon S3 lifecycle rules to archive or delete log files automatically. For more information, see Manage your storage lifecycle in the Amazon S3 User Guide.
Access log entries
The following table describes the fields of an access log entry, in order. All fields are delimited by spaces. When new fields are introduced, they are added to the end of the log entry. When processing the log files, you should ignore any fields at the end of the log entry that you were not expecting.
Field | Description |
---|---|
type |
The type of listener. The supported value is
|
version |
The version of the log entry. The current version is 2.0. |
time |
The time recorded at the end of the TLS connection, in ISO 8601 format. |
elb |
The resource ID of the load balancer. |
listener |
The resource ID of the TLS listener for the connection. |
client:port |
The IP address and port of the client. |
destination:port |
The IP address and port of the destination. If the client connects directly to the load balancer, the destination is the listener. If the client connects using a VPC endpoint service, the destination is the VPC endpoint. |
connection_time |
The total time for the connection to complete, from start to closure, in milliseconds. |
tls_handshake_time |
The total time for the TLS handshake to complete after the TCP connection is established, including client-side delays, in milliseconds. This time is included in the connection_time field. |
received_bytes |
The count of bytes received by the load balancer from the client, after decryption. |
sent_bytes |
The count of bytes sent by the load balancer to the client, before encryption. |
incoming_tls_alert |
The integer value of TLS alerts received by the load balancer from the client, if present. Otherwise, this value is set to -. |
chosen_cert_arn |
The ARN of the certificate served to the client. If no valid client hello message is sent, this value is set to -. |
chosen_cert_serial |
Reserved for future use. This value is always set to -. |
tls_cipher |
The cipher suite negotiated with the client, in OpenSSL format. If TLS negotiation does not complete, this value is set to -. |
tls_protocol_version |
The TLS protocol negotiated with the client, in string format.
The possible values are |
tls_named_group |
Reserved for future use. This value is always set to -. |
domain_name |
The value of the server_name extension in the client hello message. This value is URL-encoded. If no valid client hello message is sent or the extension is not present, this value is set to -. |
alpn_fe_protocol |
The application protocol negotiated with the client, in string
format. The possible values are |
alpn_be_protocol |
The application protocol negotiated with the target, in string
format. The possible values are |
alpn_client_preference_list |
The value of the application_layer_protocol_negotiation extension in the client hello message. This value is URL-encoded. Each protocol is enclosed in double quotes and protocols are separated by a comma. If no ALPN policy is configured in the TLS listener, no valid client hello message is sent, or the extension is not present, this value is set to -. The string is truncated if it is longer than 256 bytes. |
tls_connection_creation_time |
The time recorded at the beginning of the TLS connection, in ISO 8601 format. |
Example log entries
The following are example log entries. Note that the text appears on multiple lines only to make it easier to read.
The following is an example for a TLS listener without an ALPN policy.
tls 2.0 2018-12-20T02:59:40 net/my-network-loadbalancer/c6e77e28c25b2234 g3d4b5e8bb8464cd
72.21.218.154:51341 172.100.100.185:443 5 2 98 246 -
arn:aws:acm:us-east-2:671290407336:certificate/2a108f19-aded-46b0-8493-c63eb1ef4a99 -
ECDHE-RSA-AES128-SHA tlsv12 -
my-network-loadbalancer-c6e77e28c25b2234.elb.us-east-2.amazonaws.com
- - - 2018-12-20T02:59:30
The following is an example for a TLS listener with an ALPN policy.
tls 2.0 2020-04-01T08:51:42 net/my-network-loadbalancer/c6e77e28c25b2234 g3d4b5e8bb8464cd
72.21.218.154:51341 172.100.100.185:443 5 2 98 246 -
arn:aws:acm:us-east-2:671290407336:certificate/2a108f19-aded-46b0-8493-c63eb1ef4a99 -
ECDHE-RSA-AES128-SHA tlsv12 -
my-network-loadbalancer-c6e77e28c25b2234.elb.us-east-2.amazonaws.com
h2 h2 "h2","http/1.1" 2020-04-01T08:51:20
Bucket requirements
When you enable access logging, you must specify an S3 bucket for the access logs. The bucket can be owned by a different account than the account that owns the load balancer. The bucket must meet the following requirements.
Requirements
-
The bucket must be located in the same Region as the load balancer.
-
The prefix that you specify must not include
AWSLogs
. We add the portion of the file name starting withAWSLogs
after the bucket name and prefix that you specify. -
The bucket must have a bucket policy that grants permission to write the access logs to your bucket. Bucket policies are a collection of JSON statements written in the access policy language to define access permissions for your bucket. The following is an example policy.
{ "Version": "2012-10-17", "Id": "AWSLogDeliveryWrite", "Statement": [ { "Sid": "AWSLogDeliveryAclCheck", "Effect": "Allow", "Principal": { "Service": "delivery.logs.amazonaws.com" }, "Action": "s3:GetBucketAcl", "Resource": "arn:aws:s3:::
my-bucket
", "Condition": { "StringEquals": { "aws:SourceAccount": ["012345678912
"] }, "ArnLike": { "aws:SourceArn": ["arn:aws:logs:us-east-1
:012345678912
:*"] } } }, { "Sid": "AWSLogDeliveryWrite", "Effect": "Allow", "Principal": { "Service": "delivery.logs.amazonaws.com" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::my-bucket/AWSLogs/account-ID
/*", "Condition": { "StringEquals": { "s3:x-amz-acl": "bucket-owner-full-control", "aws:SourceAccount": ["012345678912
"] }, "ArnLike": { "aws:SourceArn": ["arn:aws:logs:us-east-1
:012345678912
:*"] } } } ] }
In the previous policy, for aws:SourceAccount
, specify the list
of account numbers for which logs are being delivered to this bucket. For aws:SourceArn
,
specify the list of ARNs of the resource that generates the logs, in the form
arn:aws:logs:
.source-region
:source-account-id
:*
Encryption
You can enable server-side encryption for your Amazon S3 access log bucket in one of the following ways:
-
Amazon S3-Managed Keys (SSE-S3)
-
AWS KMS keys stored in AWS Key Management Service (SSE-KMS) †
† With Network Load Balancer access logs, you can't use AWS managed keys, you must use customer managed keys.
For more information, see Specifying Amazon S3 encryption (SSE-S3) and Specifying server-side encryption with AWS KMS (SSE-KMS) in the Amazon S3 User Guide.
The key policy must allow the service to encrypt and decrypt the logs. The following is an example policy.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "delivery.logs.amazonaws.com" }, "Action": [ "kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt*", "kms:GenerateDataKey*", "kms:DescribeKey" ], "Resource": "*" } ] }
Enable access logging
When you enable access logging for your load balancer, you must specify the S3 bucket where the load balancer will store the logs. Be sure that you own this bucket and that you configured the required bucket policy for this bucket. For more information, see Bucket requirements.
To enable access logging using the console
-
Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/
. -
In the navigation pane, choose Load Balancers.
-
Select the name of your load balancer to open its details page.
-
On the Attributes tab, choose Edit.
-
On the Edit load balancer attributes page, do the following:
-
For Monitoring, turn on Access logs.
-
Choose Browse S3 and select a bucket to use. Alternatively, enter the location of your S3 bucket, including any prefix.
-
Choose Save changes.
-
To enable access logging using the AWS CLI
Use the modify-load-balancer-attributes command.
Disable access logging
You can disable access logging for your load balancer at any time. After you disable access logging, your access logs remain in your S3 bucket until you delete the them. For more information, see Working with buckets in the Amazon Simple Storage Service User Guide.
To disable access logging using the console
-
Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/
. -
In the navigation pane, choose Load Balancers.
-
Select the name of your load balancer to open its details page.
-
On the Attributes tab, choose Edit.
-
For Monitoring, turn off Access logs.
-
Choose Save changes.
To disable access logging using the AWS CLI
Use the modify-load-balancer-attributes command.
Processing access log files
The access log files are compressed. If you open the files using the Amazon S3 console, they are uncompressed and the information is displayed. If you download the files, you must uncompress them to view the information.
If there is a lot of demand on your website, your load balancer can generate log files with gigabytes of data. You might not be able to process such a large amount of data using line-by-line processing. Therefore, you might have to use analytical tools that provide parallel processing solutions. For example, you can use the following analytical tools to analyze and process access logs:
-
Amazon Athena is an interactive query service that makes it easy to analyze data in Amazon S3 using standard SQL. For more information, see Querying Network Load Balancer logs in the Amazon Athena User Guide.