Configure audit logs

This page describes how to configure audit logs in Pinecone. Audit logs provide a detailed record of user, service account, and API actions that occur on the management and control plane within Pinecone. Pinecone supports Amazon S3 as a destination for audit logs.

1. Set up a IAM policy and role in Amazon S3.

2. Go to Settings > Audit logs in the Pinecone console.

3. Enter the Role ARN of the IAM role you created.

4. Enter the name of the Amazon S3 bucket you created.

5. Click Enable audit logging.

Once you enable audit logs, Pinecone will start writing logs to the S3 bucket. In your bucket, you will also see a file named audit-log-access-test, which is a test file that Pinecone writes to verify that it has the necessary permissions to write logs to the bucket.

Because audit logs are written to an Amazon S3 bucket you control, you can enforce write-once-read-many (WORM) immutability so that log files can't be modified or deleted — including by your own administrators — for a retention period you define. This is recommended for compliance use cases.

Enable S3 Object Lock in compliance mode with a retention period. Object Lock requires bucket versioning and, in general, must be enabled when the bucket is created — plan for it when you set up the IAM policy and S3 bucket above. Set the retention period to at least your required audit-log retention. Pinecone writes each log batch as a new, uniquely named file and doesn't modify or delete previously written logs.

Logs are written to the S3 bucket approximately every 30 minutes. Each log batch will be saved into its own file as a JSON blob, keyed by the time of the log to be written. Only logs since the integration was created and enabled will be saved.

For more information about the log schema and captured events, see Understanding security - Audit logs.

You can edit the details of the audit log integration in the Pinecone console:

1. Go to Settings > Audit logs.
2. Enter the new Role ARN or AWS Bucket.
3. Click Update settings.

If you disable audit logs, logs not yet saved will be lost. You can disable audit logs in the Pinecone console:

1. Go to Settings > Audit logs.
2. Click the toggle next to Audit logs are active.
3. Click Confirm.

If you remove the audit log integration, logs not yet saved will be lost. You can remove the audit log integration in the Pinecone console:

1. Go to Settings > Audit logs.
2. At the top of the page, click the ellipsis (...) menu > Remove integration.
3. Click Remove integration.