Logstash 输出插件,用于签名并将 Logstash 事件导出到 Amazon Elasticsearch 服务
Logstash 输出插件,用于签名并将 Logstash 事件导出到 Amazon Elasticsearch 服务
This plugin is now in maintenance mode. We will supply bug fixes and security patches for v7.2.X, older versions are no longer supported. This change is because the OpenSearch Project created a new Logstash output plugin logstash-output-opensearch which ships events from Logstash to OpenSearch 1.x and Elasticsearch 7.x clusters, and also supports SigV4 signing. Having similar functionality plugins can be redundant, so we plan to eventually replace this logstash-output-amazon_es plugin with the logstash-output-opensearch plugin.
To help you migrate to logstash-output-opensearch plugin, please find below a brief migration guide.
This guide provides instructions for existing users of logstash-output-amazon_es plugin to migrate to logstash-output-opensearch plugin.
amazon_es to opensearch.opensearch plugin does not default to it like amazon_es does:hosts as https (or option ssl added with value true)port must explicitly specified as 443auth_type will be added to the Config to support SigV4 signing.region parameter will move under auth_type.aws_access_key_id and aws_secret_access_key will move under auth_type.type value for auth_type for SigV4 signing will be set to aws_iam.For the Logstash configuration provided in Configuration for Amazon Elasticsearch Service Output Plugin , here's a mapped example configuration for logstash-output-opensearch plugin:
output {
opensearch {
hosts => ["https://hostname:port"]
auth_type => {
type => 'aws_iam'
aws_access_key_id => 'ACCESS_KEY'
aws_secret_access_key => 'SECRET_KEY'
region => 'us-west-2'
}
index => "logstash-logs-%{+YYYY.MM.dd}"
}
}This Installation Guide has instructions on installing the logstash-output-opensearch plugin in two ways: Linux (ARM64/X64) OR Docker (ARM64/X64).
To install the latest version of logstash-output-opensearch, use the normal Logstash plugin installation command:
bin/logstash-plugin install logstash-output-opensearchThe remainder of this document is for using or developing the logstash-output-amazon_es plugin.
This is a plugin for Logstash which outputs to Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) using SigV4 signing.
This library is licensed under Apache License 2.0.
The following table shows the versions of logstash and logstash-output-amazon_es plugin was built with.
| logstash-output-amazon_es | Logstash |
|---|---|
| 6.0.0 | = 6.0.0 |
| 7.0.1 | >= 7.0.0 |
| 7.1.0 | >= 7.0.0 |
| 8.0.0 | >= 7.0.0 |
Also, logstash-output-amazon_es plugin versions 6.4.0 and newer are tested to be compatible with Elasticsearch 6.5 and greater.
| logstash-output-amazon_es | Elasticsearch |
|---|---|
| 6.4.0+ | 6.5+ |
To install the latest version, use the normal Logstash plugin script.
bin/logstash-plugin install logstash-output-amazon_esIf you want to use old version of logstash-output-amazon_es, you can use the --version
flag to specify the version. For example:
bin/logstash-plugin install --version 6.4.2 logstash-output-amazon_esStarting in 8.0.0, the aws sdk version is bumped to v3. In order for all other AWS plugins to work together, please remove pre-installed plugins and install logstash-integration-aws plugin as follows. See also https://github.com/logstash-plugins/logstash-mixin-aws/issues/38
…To run the Logstash Output Amazon Elasticsearch Service plugin, simply add a configuration following the below documentation.
An example configuration:
output {
amazon_es {
hosts => ["foo.us-east-1.es.amazonaws.com"]
region => "us-east-1"
# aws_access_key_id and aws_secret_access_key are optional if instance profile is configured
aws_access_key_id => 'ACCESS_KEY'
aws_secret_access_key => 'SECRET_KEY'
index => "production-logs-%{+YYYY.MM.dd}"
}
}["foo.us-east-1.es.amazonaws.com"])Credential parameters:
The credential resolution logic can be described as follows:
aws_access_key_id and aws_secret_access_key in amazon_es configurationAWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY (RECOMMENDED since they are recognized by all the AWS SDKs and CLI except for .NET), or AWS_ACCESS_KEY and AWS_SECRET_KEY (only recognized by Java SDK)~/.aws/credentials) shared by all AWS SDKs and the AWS CLItemplate (path) - You can set the path to your own template here, if you so desire. If not set, the included template will be used.
template_name (string, default => "logstash") - defines how the template is named inside Elasticsearch
port (string, default 443) - Amazon Elasticsearch Service listens on port 443 for HTTPS (default) and port 80 for HTTP. Tweak this value for a custom proxy.
protocol (string, default https) - The protocol used to connect to the Amazon Elasticsearch Service
max_bulk_bytes - The max size for a bulk request in bytes. Default is 20MB. It is recommended not to change this value unless needed. For guidance on changing this value, please consult the table for network limits for your instance type: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-limits.html#network-limits
After 6.4.0, users can't set batch size in this output plugin config. However, users can still set batch size in logstash.yml file.
Starting logstash-output-amazon_es v7.1.0, we have introduced the following optional parameters to resolve specific use cases:
To get started, you can install JRuby with the Bundler gem using RVM
rvm install jruby-9.2.5.0Verify JRuby is already installed
jruby -vInstall dependencies:
bundle installUpdate your dependencies:
bundle installRun unit tests:
bundle exec rspecEdit Logstash Gemfile and add the local plugin path, for example:
gem "logstash-output-amazon_es", :path => "/your/local/logstash-output-amazon_es"Install the plugin:
# Logstash 2.3 and higher
bin/logstash-plugin install --no-verify
# Prior to Logstash 2.3
bin/plugin install --no-verifyRun Logstash with your plugin:
bin/logstash -e 'output {amazon_es {}}'At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply re-run Logstash.
Before build your Gemfile, please make sure use JRuby. Here is how you can know your local Ruby version:
rvm listPlease make sure you current using JRuby. Here is how you can change to JRuby
rvm jruby-9.2.5.0You can use the same 3.1 method to run your plugin in an installed Logstash by editing its Gemfile and pointing the :path to your local plugin development directory. You can also build the gem and install it using:
Build your plugin gem:
gem build logstash-output-amazon_es.gemspecInstall the plugin from the Logstash home. Please be sure to check the version number against the actual Gem file. Run:
bin/logstash-plugin install /your/local/logstash-output-amazon_es/logstash-output-amazon_es-7.0.1-java.gemStart Logstash and test the plugin.
All contributions are welcome: ideas, patches, documentation, bug reports, and complaints.
暂无开放 Issues,或尚未同步最近议题。