Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions docs/plugins/inputs/cloudwatch.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
// :integration: aws
:plugin: cloudwatch
:type: input
:default_plugin: 0
:default_plugin: 1
:default_codec: plain

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v2.2.4
:release_date: 2018-09-17
:changelog_url: https://github.com/logstash-plugins/logstash-input-cloudwatch/blob/v2.2.4/CHANGELOG.md
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -18,7 +19,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!

=== Cloudwatch input plugin

include::{include_path}/plugin_header.asciidoc[]
// include::{include_path}/plugin_header-integration.asciidoc[]

==== Description

Expand Down Expand Up @@ -85,6 +86,21 @@ See http://aws.amazon.com/iam/ for more details on setting up AWS identities.
}
}

[source, ruby]
input {
cloudwatch {
namespace => "sqlserver_test2"
metrics => [ "Memory Available Bytes"]
filters => {
InstanceId => "i-xxxxxxxxxxx"
objectname => "Memory"
}
combined => true
interval => 600
period => 300
}
}


[id="plugins-{type}s-{plugin}-options"]
==== Cloudwatch Input Configuration Options
Expand Down Expand Up @@ -302,4 +318,4 @@ The AWS SDK for Ruby defaults to SSL so we preserve that
[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!:
:default_codec!:
17 changes: 14 additions & 3 deletions docs/plugins/inputs/dead_letter_queue.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v1.1.12
:release_date: 2022-06-16
:changelog_url: https://github.com/logstash-plugins/logstash-input-dead_letter_queue/blob/v1.1.12/CHANGELOG.md
:version: v2.0.0
:release_date: 2022-08-02
:changelog_url: https://github.com/logstash-plugins/logstash-input-dead_letter_queue/blob/v2.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -46,6 +46,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-clean_consumed>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-commit_offsets>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-path>> |a valid filesystem path|Yes
| <<plugins-{type}s-{plugin}-pipeline_id>> |<<string,string>>|No
Expand All @@ -58,6 +59,16 @@ input plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-clean_consumed"]
===== `clean_consumed`

* Value type is <<boolean,boolean>>
* Default value is `false`

When set to `true`, this option deletes the DLQ segments that have been read.
This feature requires that `commit_offsets` is set to `true`. If not, you'll get a configuration error.
This feature is available in Logstash 8.4.0 and later. If this setting is `true` and and you are using a Logstash version older than 8.4.0, then you'll get a configuration error.

[id="plugins-{type}s-{plugin}-commit_offsets"]
===== `commit_offsets`

Expand Down
9 changes: 5 additions & 4 deletions docs/plugins/inputs/s3.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// :integration: aws
:plugin: s3
:type: input
:default_plugin: 1
Expand All @@ -6,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.8.4
:release_date: 2022-02-16
:changelog_url: https://github.com/logstash-plugins/logstash-input-s3/blob/v3.8.4/CHANGELOG.md
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -18,7 +19,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!

=== S3 input plugin

include::{include_path}/plugin_header.asciidoc[]
// include::{include_path}/plugin_header-integration.asciidoc[]

==== Description

Expand Down
9 changes: 5 additions & 4 deletions docs/plugins/inputs/sqs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// :integration: aws
:plugin: sqs
:type: input
:default_plugin: 1
Expand All @@ -6,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.3.2
:release_date: 2022-03-17
:changelog_url: https://github.com/logstash-plugins/logstash-input-sqs/blob/v3.3.2/CHANGELOG.md
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -18,7 +19,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!

=== Sqs input plugin

include::{include_path}/plugin_header.asciidoc[]
// include::{include_path}/plugin_header-integration.asciidoc[]

==== Description

Expand Down
39 changes: 39 additions & 0 deletions docs/plugins/integrations/aws.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
:plugin: aws
:type: integration
:default_plugin: 1
:no_codec:

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== AWS Integration Plugin

// include::{include_path}/plugin_header.asciidoc[]

==== Description

The AWS Integration Plugin provides integrated plugins for working with Amazon Web Services:

////
- {logstash-ref}/plugins-codecs-cloudfront.html[Cloudfront Codec Plugin]
- {logstash-ref}/plugins-codecs-cloudtrail.html[Cloudtrail Codec Plugin]
- {logstash-ref}/plugins-inputs-cloudwatch.html[Cloudwatch Input Plugin]
- {logstash-ref}/plugins-inputs-s3.html[S3 Input Plugin]
- {logstash-ref}/plugins-inputs-sqs.html[Sqs Input Plugin]
- {logstash-ref}/plugins-outputs-cloudwatch.html[Cloudwatch Output Plugin]
- {logstash-ref}/plugins-outputs-s3.html[S3 Output Plugin]
- {logstash-ref}/plugins-outputs-sns.html[Sns Output Plugin]
- {logstash-ref}/plugins-outputs-sqs.html[Sqs Output Plugin]
////

:no_codec!:
9 changes: 5 additions & 4 deletions docs/plugins/outputs/cloudwatch.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// :integration: aws
:plugin: cloudwatch
:type: output
:default_plugin: 1
Expand All @@ -6,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.1.0
:release_date: 2022-06-15
:changelog_url: https://github.com/logstash-plugins/logstash-output-cloudwatch/blob/v3.1.0/CHANGELOG.md
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -18,7 +19,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!

=== Cloudwatch output plugin

include::{include_path}/plugin_header.asciidoc[]
// include::{include_path}/plugin_header-integration.asciidoc[]

==== Description

Expand Down
25 changes: 8 additions & 17 deletions docs/plugins/outputs/s3.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// :integration: aws
:plugin: s3
:type: output
:default_plugin: 1
Expand All @@ -6,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v4.3.7
:release_date: 2022-06-16
:changelog_url: https://github.com/logstash-plugins/logstash-output-s3/blob/v4.3.7/CHANGELOG.md
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -18,7 +19,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!

=== S3 output plugin

include::{include_path}/plugin_header.asciidoc[]
// include::{include_path}/plugin_header-integration.asciidoc[]

==== Description

Expand All @@ -31,9 +32,8 @@ Other S3 compatible storage solutions are not supported.
S3 outputs create temporary files into the OS' temporary directory.
You can specify where to save them using the `temporary_directory` option.

IMPORTANT: For configurations containing multiple s3 outputs with the `restore`
option enabled, each output should define its own `temporary_directory`.
Shared or nested directories can cause data loss upon recovery.
IMPORTANT: For configurations containing multiple s3 outputs with the restore
option enabled, each output should define its own 'temporary_directory'.

===== Requirements

Expand Down Expand Up @@ -257,10 +257,6 @@ The AWS Region
Used to enable recovery after crash/abnormal termination.
Temporary log files will be recovered and uploaded.

NOTE: If you're using multiple S3 outputs, always set
<<plugins-{type}s-{plugin}-temporary_directory>> to a
unique directory. Otherwise the recovery mechanism won't work correctly.

[id="plugins-{type}s-{plugin}-retry_count"]
===== `retry_count`

Expand Down Expand Up @@ -394,12 +390,7 @@ Defaults to STANDARD.
* Default value is `"/tmp/logstash"`

Set the directory where logstash will store the tmp files before sending it to S3
default to the current OS temporary directory in linux `/tmp/logstash`.

WARNING: Using multiple S3 outputs with `restore => true` requires unique directories
per output. All of the directory's contents are processed and deleted upon recovery, and shared or nested directories can cause data loss.
For example, an output using `/tmp/s3` and a second configured with `/tmp/s3/sub` would
cause issues. Having temporary directories `/tmp/s3/sub1` and `/tmp/s3/sub2` is fine.
default to the current OS temporary directory in linux /tmp/logstash

[id="plugins-{type}s-{plugin}-time_file"]
===== `time_file`
Expand Down
9 changes: 5 additions & 4 deletions docs/plugins/outputs/sns.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// :integration: aws
:plugin: sns
:type: output
:default_plugin: 1
Expand All @@ -6,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v4.0.8
:release_date: 2021-11-30
:changelog_url: https://github.com/logstash-plugins/logstash-output-sns/blob/v4.0.8/CHANGELOG.md
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -18,7 +19,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!

=== Sns output plugin

include::{include_path}/plugin_header.asciidoc[]
// include::{include_path}/plugin_header-integration.asciidoc[]

==== Description

Expand Down
10 changes: 6 additions & 4 deletions docs/plugins/outputs/sqs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// :integration: aws
:plugin: sqs
:type: output
:default_plugin: 1
Expand All @@ -6,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v6.0.0
:release_date: 2019-01-11
:changelog_url: https://github.com/logstash-plugins/logstash-output-sqs/blob/v6.0.0/CHANGELOG.md
:version: v7.0.0
:release_date: 2022-07-25
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.0.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -18,7 +19,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!

=== Sqs output plugin

include::{include_path}/plugin_header.asciidoc[]
// include::{include_path}/plugin_header-integration.asciidoc[]

==== Description

Expand Down Expand Up @@ -91,6 +92,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
| <<plugins-{type}s-{plugin}-message_max_size>> |<<bytes,bytes>>|No
| <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-queue_owner_aws_account_id>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-region>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-role_arn>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-role_session_name>> |<<string,string>>|No
Expand Down