获取 Amazon SQS 队列中的消息数量

Question

只是一个简单的问题，但我找不到答案。

是否可以使用 API 来获取 AWS SQS 队列的队列大小（等待处理的消息/作业的数量）？

最好使用 cURL 或 PHP SDK。

Answer 1

还有一些代码示例：

aws sqs get-queue-attributes --queue-url https://sqs.<region>.amazonaws.com/<accountId>/<SQS name> --attribute-names All


{
    "Attributes": {
        "QueueArn": "arn:aws:sqs:<region>:<accountId>:<SQS name>",
        "ApproximateNumberOfMessages": "0",
        "ApproximateNumberOfMessagesNotVisible": "3",
        "ApproximateNumberOfMessagesDelayed": "0",
        "CreatedTimestamp": "1594729555",
        "LastModifiedTimestamp": "1595845586",
        "VisibilityTimeout": "60",
        "MaximumMessageSize": "262144",
        "MessageRetentionPeriod": "900",
        "DelaySeconds": "0",
        "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:<region>:<accountId>:<DLQ name>\",\"maxReceiveCount\":3}",
        "ReceiveMessageWaitTimeSeconds": "0"
    }
}

获取已定义属性的值：

 aws sqs get-queue-attributes --queue-url https://sqs.<region>.amazonaws.com/<accountId>/<SQS name> --attribute-names VisibilityTimeout ApproximateNumberOfMessages ApproximateNumberOfMessagesNotVisible ApproximateNumberOfMessagesDelayed

{
    "Attributes": {
        "VisibilityTimeout": "60",
        "ApproximateNumberOfMessages": "0",
        "ApproximateNumberOfMessagesNotVisible": "3",
        "ApproximateNumberOfMessagesDelayed": "0"
    }
}

警告

ApproximateNumberOfMessagesDelayed 、 ApproximateNumberOfMessagesNotVisible 和 ApproximateNumberOfMessagesVisible 指标可能要在生产者停止发送消息后至少 1 分钟才能实现一致性。队列元数据达到最终一致性需要这个时间。

Answer 2

我相信您正在寻找的是 get-queue-attributes，也许是询问 ApproximateNumberOfMessages 属性。

Answer 3

您可以检索

Attributes of the Queue

并查找相关属性（请参阅此链接）。您可能想查看以下两个属性。

ApproximateNumberOfMessages - 返回可见的近似数量 队列中的消息

ApproximateNumberOfMessagesNotVisible - 返回未超时且未删除的消息的大致数量。

如果你想包含等待添加的消息，你也可以考虑以下属性。

ApproximateNumberOfMessagesDelayed - 返回大致数量 等待添加到队列中的消息。

最后对上述属性返回的值进行求和，得到当前队列的大小。

Answer 4

对于

PHP

，试试这个，

        $sqsClient = new  SqsClient([
            'region' => env('AWS_REGION'),
            'version' => '2012-11-05',
            'credentials' => [
                'key'    => env('AWS_ACCESS_KEY'),
                'secret' => env('AWS_SECRET_KEY'),
            ],
        ]);

        $sqs = new SqsQueue($sqsClient,null,null);
        $size = $sqs->size(env('AWS_SQS_URL'));

        echo $size;

Answer 5

使用 PHP :

putenv('AWS_ACCESS_TOKEN=xxxx');
putenv('AWS_ACCESS_TOKEN_SECRET=xxxx'); 

$sqs = new \Aws\Sqs\SqsClient([
    'profile' => 'default',
    'region' => 'REGION',
    'version' => 'latest'
]);

$queueUrl = 'https://sqs.REGION.amazonaws.com/xxxxxxxx/queue-name';

$x = $sqs->getQueueAttributes([
    'QueueUrl' => $queueUrl, 
    'AttributeNames' => ['All']
]);

echo json_encode($x->toArray(), JSON_PRETTY_PRINT);

将输出类似以下内容：

{
    "Attributes": {
        "QueueArn": "arn:aws:sqs:REGION:xxxxxxx:queue-name",
        "ApproximateNumberOfMessages": "0",
        "ApproximateNumberOfMessagesNotVisible": "0",
        "ApproximateNumberOfMessagesDelayed": "0",
        "CreatedTimestamp": "1587472818",
        "LastModifiedTimestamp": "1587473783",
        "VisibilityTimeout": "30",
        "MaximumMessageSize": "262144",
        "MessageRetentionPeriod": "345600",
        "DelaySeconds": "0",
        "ReceiveMessageWaitTimeSeconds": "0",
        "KmsMasterKeyId": "alias\/aws\/sqs",
        "KmsDataKeyReusePeriodSeconds": "300",
        "FifoQueue": "true",
        "ContentBasedDeduplication": "false"
    },
    "@metadata": {
       ....
    }
}

Answer 6

您可以使用 JQ 仅获取值中的输出：

$AWSProdAccountID = "1234567890"

$ProductionErrorMsgCount = aws sqs get-queue-attributes --queue-url https://sqs.<region>.amazonaws.com/$AWSProdAccountID/<SQS name> --attribute-names ApproximateNumberOfMessages --profile $AWSProfile --region ap-southeast-2 | jq.exe -r ".Attributes.ApproximateNumberOfMessages[:1]"

Answer 7

下面的代码使用 AWS PHP SDK V3 首先获取队列 URL，然后获取所请求队列的

ApproximateNumberOfMessages

、

ApproximateNumberOfMessagesDelayed

、

ApproximateNumberOfMessagesNotVisible

属性：

ApproximateNumberOfMessages – 返回可从队列中检索的消息的大致数量。

ApproximateNumberOfMessagesDelayed – 返回队列中延迟且无法立即读取的消息的大致数量。当队列配置为延迟队列或使用延迟参数发送消息时，可能会发生这种情况。

ApproximateNumberOfMessagesNotVisible – 返回正在传输的消息的大致数量。如果消息已发送给客户端但尚未删除或尚未到达可见窗口末尾，则消息被视为正在传输。

require 'vendor/autoload.php';

use Aws\Sqs\SqsClient; 
use Aws\Exception\AwsException;


$queueName = "SQS_QUEUE_NAME";
 
$client = new SqsClient([
    'profile' => 'default',
    'region' => 'us-west-2',
    'version' => '2012-11-05'
]);

try {
    $result = $client->getQueueUrl([
        'QueueName' => $queueName
    ]);
    
    $queueUrl = $result['QueueUrl'];
    $result = $client->getQueueAttributes([
        'AttributeNames' => ['ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible'],
        'QueueUrl' => $queueUrl,
    ]);
    var_dump($result);
} catch (AwsException $e) {
    // output error message if fails
    error_log($e->getMessage());
}

Answer 8

使用此命令可以获得所需的结果

aws sqs get-queue-attributes --queue-url <queue url> --region <region> --attribute-names ApproximateNumberOfMessages