https://github.com/mridehalgh/xk6-sqs

A k6 extension to produce to an SQS queue
https://github.com/mridehalgh/xk6-sqs

k6 k6-extension sqs xk6

Last synced: about 2 months ago
JSON representation

A k6 extension to produce to an SQS queue

• Host: GitHub
• URL: https://github.com/mridehalgh/xk6-sqs
• Owner: mridehalgh
• License: apache-2.0
• Created: 2021-03-13T17:30:03.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-10T09:29:06.000Z (3 months ago)
• Last Synced: 2024-06-19T15:17:31.138Z (3 months ago)
• Topics: k6, k6-extension, sqs, xk6
• Language: Go
• Homepage:
• Size: 432 KB
• Stars: 6
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# xk6-sqs

This is a [k6](https://go.k6.io/k6) extension using the [xk6](https://github.com/grafana/xk6) system.

| :exclamation: This is a proof of concept, isn't supported by the k6 team or by the maintainer, and may break in the future. USE AT YOUR OWN RISK! |

|------|

## Build

To build a `k6` binary with this extension, first ensure you have the prerequisites:

- [Go toolchain](https://go101.org/article/go-toolchain.html)

- Git

Then, install [xk6](https://github.com/grafana/xk6) and build your custom k6 binary with the SQS extension:

1. Install `xk6`:

  ```shell

  $ go install go.k6.io/xk6/cmd/xk6@latest

  ```

2. Build the binary:

  ```shell

  $ xk6 build --with github.com/mridehalgh/xk6-sqs@latest

  ```

## AWS credentials

This plugin uses the AWS SDK Go v2 default credential chain. It looks for credentials in the following order:

1. Environment variables.

   1. Static Credentials (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN`)

   2. Web Identity Token (`AWS_WEB_IDENTITY_TOKEN_FILE`)

1. Shared configuration files.

   1. SDK defaults to `credentials` file under `.aws` folder that is placed in the home folder on your computer.

   1. SDK defaults to `config` file under `.aws` folder that is placed in the home folder on your computer.

1. If your application uses an ECS task definition or RunTask API operation, IAM role for tasks.

1. If your application is running on an Amazon EC2 instance, IAM role for Amazon EC2.

Source: https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials

## Example

```javascript

import sqs from 'k6/x/sqs';

const client = sqs.newClient()

export default function () {

    const params = {

        DelaySeconds: 0,

        MessageAttributes: {

            "Title": {

                DataType: "String",

                StringValue: "The Whistler"

            },

            "Author": {

                DataType: "String",

                StringValue: "John Grisham"

            },

            "WeeksOn": {

                DataType: "Number",

                StringValue: "6"

            }

        },

        MessageBody: "Information about current NY Times fiction bestseller for week of 12/11/2016.",

        // MessageDeduplicationId: "TheWhistler",  // Required for FIFO queues

        // MessageGroupId: "Group1",  // Required for FIFO queues

        QueueUrl: "QUEUE_URL"

    };

    sqs.send(client,params)

}

```