pcluster export-cluster-logs - Amazon ParallelCluster
Named arguments
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

pcluster export-cluster-logs

Export the logs of the cluster to a local tar.gz archive by passing through an Amazon S3 Bucket.

pcluster export-cluster-logs [-h]
                 --bucket BUCKET_NAME
                 --cluster-name CLUSTER_NAME 
                [--bucket-prefix BUCKET_PREFIX]
                [--debug]
                [--end-time END_TIME]
                [--filters FILTER [FILTER ...]]
                [--keep-s3-objects KEEP_S3_OBJECTS]
                [--output-file OUTPUT_FILE]
                [--region REGION]
                [--start-time START_TIME]

Named arguments

-h, --help

Shows the help text for pcluster export-cluster-logs.

--bucket BUCKET_NAME

Specifies the name of the Amazon S3 bucket to export cluster logs data to. It must be in the same Region as the cluster.

Note

You must add permissions to the Amazon S3 bucket policy to grant CloudWatch access. For more information, see Set permissions on an Amazon S3 bucket in the CloudWatch Logs User Guide.

--cluster-name, -n CLUSTER_NAME

Specifies the name of the cluster.

--bucket-prefix BUCKET_PREFIX

Specifies the path in the Amazon S3 bucket where exported logs data is to be stored.

By default, the bucket-prefix is:

cluster-name-logs-202209061743.tar.gz

202209061743 is the current time in %Y%m%d%H%M format.

--debug

Enables debug logging.

--end-time END_TIME

Specifies the end of the time range to collect log events, expressed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ, for example 2021-01-01T20:00:00Z'). Events with a timestamp equal to or later than this time are not included. Time elements (e.g. minutes and seconds) may be omitted. The default value is the current time.

--filters FILTER [FILTER ...]

Specifies filters for the log. Format: Name=a,Values=1 Name=b,Values=2,3. Supported filters are:

private-dns-name

Specifies the short form of the private DNS name of the instance (e.g. ip-10-0-0-101).

node-type

Specifies the node type, the only accepted value for this filter is HeadNode.

--keep-s3-objects KEEP_S3_OBJECTS

If true, the exported objects exports to Amazon S3 are kept. (Defaults to false.)

--output-file OUTPUT_FILE

Specifies the file path to save the log archive to. If this is provided, then the logs are saved locally. Otherwise they are uploaded to Amazon S3 with the URL returned in the output. Default is to upload to Amazon S3.

--region, -r REGION

Specifies the Amazon Web Services Region to use. The Amazon Web Services Region must be specified, using the AWS_DEFAULT_REGION environment variable, the region setting in the [default] section of the ~/.aws/config file, or the --region parameter.

--start-time START_TIME

Specifies the start of the time range, expressed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ, for example 2021-01-01T20:00:00Z). Log events with a timestamp equal to this time or later than this time are included. If not specified, the default is the time the cluster was created.

Example using Amazon ParallelCluster version 3.1.4:

$ pcluster export-cluster-logs --bucket cluster-v3-bucket -n cluster-v3
{
  "url": "https://cluster-v3-bucket..."
}