s3_put_bucket_logging does not actually create and write to logging file.

[jordan-schneider]

moto 4.0.8 inside conda using python 3.8.6

I'm trying to measure the number of GET/PUT requests I make to the mock s3 session. AFAICT the way you do this in actual S3 is to enable bucket logging and read the log. moto is not actually creating the log file and writing to it at any point, as far as I can tell. Here's my test script

import boto3
from moto import mock_s3  # type: ignore

@mock_s3
def test_bucket_logging():
    conn = boto3.resource("s3", region_name="us-east-1")
    s3 = conn.meta.client
    conn.create_bucket(Bucket="mybucket")
 
   # ACL copied verbatim from https://github.com/spulec/moto/blob/5f7f3e6e46f5dd3229f8da61b09a155d99d2a234/tests/test_s3/test_s3.py#L2191
    bucket_owner = s3.get_bucket_acl(Bucket="mybucket")["Owner"]
    s3.put_bucket_acl(
        Bucket="mybucket",
        AccessControlPolicy={
            "Grants": [
                {
                    "Grantee": {
                        "URI": "http://acs.amazonaws.com/groups/s3/LogDelivery",
                        "Type": "Group",
                    },
                    "Permission": "WRITE",
                },
                {
                    "Grantee": {
                        "URI": "http://acs.amazonaws.com/groups/s3/LogDelivery",
                        "Type": "Group",
                    },
                    "Permission": "READ_ACP",
                },
                {
                    "Grantee": {"Type": "CanonicalUser", "ID": bucket_owner["ID"]},
                    "Permission": "FULL_CONTROL",
                },
            ],
            "Owner": bucket_owner,
        },
    )
    s3.put_bucket_logging(
        Bucket="mybucket",
        BucketLoggingStatus={
            "LoggingEnabled": {"TargetBucket": "mybucket", "TargetPrefix": "log-"}
        },
    )

    # Creates a local sqlite database to write to the mock s3. You c
    s3.put_object(
        Bucket="mybucket", Key="blah.txt", Body="Hello world!"
    )

    print(s3.list_objects_v2(Bucket="mybucket"))
    # {'ResponseMetadata': {'RequestId': '34JRSbhMiR97JATGg5HkhGJyVTnXNE90tzQeGj65tqnVXASNedUb', 'HTTPStatusCode': 200, 'HTTPHeaders': {'x-amzn-requestid': '34JRSbhMiR97JATGg5HkhGJyVTnXNE90tzQeGj65tqnVXASNedUb'}, 'RetryAttempts': 0}, 'IsTruncated': False, 'Contents': [{'Key': 'blah.txt', 'LastModified': datetime.datetime(2022, 10, 24, 20, 20, 55, tzinfo=tzutc()), 'ETag': '"86fb269d190d2c85f6e0468ceca42a20"', 'Size': 12, 'StorageClass': 'STANDARD'}], 'Name': 'mybucket', 'Prefix': '', 'MaxKeys': 1000, 'EncodingType': 'url', 'KeyCount': 1}
    # Only the file we wrote, no log file.

    # Dirty hack to get pytest to show stdout
    assert False

Is there a better way to count/record requests within moto? Is this intentional?

[bblommers]

This feature hasn't been implemented yet @jordan-schneider - there is no Moto-specific way of doing this at the moment.

Would you be interesting in adding this feature?

[jordan-schneider]

Sorry, I'm basically flat new to S3 and have no idea what the logging format would look like. It seems like there's a solution to my request counting problem using boto3 event handlers that would be simpler to implement than this feature.

I'd be happy to write a dinky one-line PR adding this caveat to https://github.com/spulec/moto/blob/master/docs/docs/services/s3.rst just to save the next person some time figuring all this out, if you think that would be justified.

[bblommers]

No worries @jordan-schneider - I just raised #5600 to improve the docs here.