Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shaiMoria committed Jul 4, 2020
1 parent 2061024 commit 843e514
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ FluntBit custom output plugin which allows sending messages to AWS-SQS.

## Configuration Parameters

| Configuration Key Name | Description | Mandatory |
| ---------------------- | ------------------------------------- | --------- |
| QueueUrl | the queue url in your aws account | yes |
| QueueRegion | the queue region in your aws account | yes |
| PluginTagAttribute | attribute name of the message tag | no |
| QueueMessageGroupId | the group id required for fifo queues | fifo-only |
| Configuration Key Name | Description | Mandatory |
| ---------------------- | -------------------------------------------------------- | --------- |
| QueueUrl | the queue url in your aws account | yes |
| QueueRegion | the queue region in your aws account | yes |
| PluginTagAttribute | attribute name of the message tag | no |
| QueueMessageGroupId | the group id required for fifo queues | fifo-only |
| ProxyUrl | the proxy address between fluentbit and sqs (if exists) | no |

```conf
[SERVICE]
Expand Down Expand Up @@ -73,3 +74,5 @@ More information about the usage and installation of golang plugins can be found
2) Shared credentials file.

3) If your application is running on an Amazon EC2 instance, IAM role for Amazon EC2. The IAM role should have full access to your SQS and in addition, it should add the following KMS permissions: `kms:GenerateDataKey*, kms:Get*, kms:Decrypt*`

- The plugin uses specific environment variable for log level: `SQS_OUT_LOG_LEVEL`. Supported values are: `debug`, `info` or `error`
2 changes: 1 addition & 1 deletion out_sqs.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func FLBPluginInit(plugin unsafe.Pointer) int {
queueRegion := output.FLBPluginConfigKey(plugin, "QueueRegion")
queueMessageGroupID := output.FLBPluginConfigKey(plugin, "QueueMessageGroupId")
pluginTagAttribute := output.FLBPluginConfigKey(plugin, "PluginTagAttribute")
proxyURL := output.FLBPluginConfigKey(plugin, "ProxyURL")
proxyURL := output.FLBPluginConfigKey(plugin, "ProxyUrl")

writeInfoLog(fmt.Sprintf("QueueUrl is: %s", queueURL))
writeInfoLog(fmt.Sprintf("QueueRegion is: %s", queueRegion))
Expand Down

0 comments on commit 843e514

Please sign in to comment.