# YAML notes # |- means 'scalar block' useful for formatted text # > means 'scalar block' but it chomps all newlines. Useful # for unformatted text. en: oops: |- An unexpected error occurred! logstash: error: >- Error: %{error} bootstrap_check: persisted_queue_config: page-capacity: >- Invalid configuration, 'queue.page_capacity' must be less than or equal to 'queue.max_bytes' environment: jruby-required: >- JRuby is required missing-jars: >- Could not find jar files under %{pattern} pipeline: worker-error: |- A plugin had an unrecoverable error. Will restart this plugin. Pipeline_id:%{pipeline_id} Plugin: %{plugin} Error: %{error} worker-error-debug: |- A plugin had an unrecoverable error. Will restart this plugin. Pipeline_id:%{pipeline_id} Plugin: %{plugin} Error: %{error} Exception: %{exception} Stack: %{stacktrace} plugin-loading-error: >- Couldn't find any %{type} plugin named '%{name}'. Are you sure this is correct? Trying to load the %{name} %{type} plugin resulted in this error: %{error} plugin-type-loading-error: >- Could not find any plugin type named '%{type}'. Check for typos. Valid plugin types are 'input' 'filter' and 'output' output-worker-unsupported: >- %{plugin} output plugin: setting 'workers => %{worker_count}' is not supported by this plugin. I will continue working as if you had not set this setting. output-worker-unsupported-with-message: >- %{plugin} output plugin: setting 'workers => %{worker_count}' is not supported by this plugin. I will continue working as if you had not set this setting. Reason: %{message} effective_ecs_compatibility: >- Pipeline `%{pipeline_id}` is configured with `pipeline.ecs_compatibility: %{ecs_compatibility}` setting. All plugins in this pipeline will default to `ecs_compatibility => %{ecs_compatibility}` unless explicitly configured otherwise. plugin: deprecated_milestone: >- %{plugin} plugin is using the 'milestone' method to declare the version of the plugin this method is deprecated in favor of declaring the version inside the gemspec. web_api: cant_bind_to_port: |- Logstash tried to bind to port %{port}, but the port is already in use. You can specify a new port by launching logstash with the --api.http.port option." cant_bind_to_port_in_range: |- Logstash tried to bind to port range %{http_ports}, but all the ports are already in use. You can specify a new port by launching logstash with the --api.http.port option." hot_threads: title: |- ::: {%{hostname}} Hot threads at %{time}, busiestThreads=%{top_count}: thread_title: |- %{percent_of_cpu_time} % of cpu usage, state: %{thread_state}, thread name: '%{thread_name}', thread id: %{thread_id} logging: unrecognized_option: |- unrecognized option [%{option}] modules: configuration: parse-failed: |- Failed to parse the module configuration: [%{error}] modules-must-be-unique: >- Only a single instance of any module can be run at a time. Duplicate modules: %{duplicate_modules} modules-invalid-name: >- Invalid module name: %{module_name} modules-variables-malformed: >- Failed to parse module variable %{rawvar}. Must be in -M "MODULE_NAME.KEY.SUBKEY=VALUE" format modules-unavailable: >- The modules specified are not available yet. Specified modules: %{specified_modules} Available modules: %{available_modules} elasticsearch_connection_failed: >- Failed to import module configurations to Elasticsearch and/or Kibana. Module: %{module_name} has Elasticsearch hosts: %{elasticsearch_hosts} and Kibana hosts: %{kibana_hosts} modules-too-many-specified: >- Too many modules specified. Maximum allowed: %{max}, specified: %{specified_modules} runner: short-help: |- usage: bin/logstash -f CONFIG_PATH [-t] [-r] [] [-w COUNT] [-l LOG] bin/logstash --modules MODULE_NAME [-M "MODULE_NAME.var.PLUGIN_TYPE.PLUGIN_NAME.VARIABLE_NAME=VALUE"] [-t] [-w COUNT] [-l LOG] bin/logstash -e CONFIG_STR [-t] [--log.level fatal|error|warn|info|debug|trace] [-w COUNT] [-l LOG] bin/logstash -i SHELL [--log.level fatal|error|warn|info|debug|trace] bin/logstash -V [--log.level fatal|error|warn|info|debug|trace] bin/logstash --help invalid-settings: >- Your settings are invalid. Reason: %{error} invalid-configuration: >- The given configuration is invalid. Reason: %{error} missing-configuration: >- No configuration file was specified. Perhaps you forgot to provide the '-f yourlogstash.conf' flag? config-string-path-exclusive: Settings 'path.config' (-f) and 'config.string' (-e) can't be used simultaneously. config-module-exclusive: >- Settings 'path.config' (-f) or 'config.string' (-e) can't be used in conjunction with (--modules) or the "modules:" block in the logstash.yml file. reload-with-modules: >- Configuration reloading can't be used with command-line or logstash.yml specified modules. cli-module-override: >- Both command-line and logstash.yml modules configurations detected. Using command-line module configuration to override logstash.yml module configuration. config-pipelines-failed-read: >- Failed to read pipelines yaml file. Location: %{path} config-pipelines-failed-read-with-exception: >- Failed to read pipelines yaml file. Location: %{path}, Exception: %{exception} config-pipelines-failed-parse-with-exception: >- Failed to parse contents of pipelines yaml file. Location: %{path}, Exception: %{exception} config-pipelines-empty: >- Pipelines YAML file is empty. Location: %{path} config-pipelines-invalid: >- Pipelines YAML file must contain an array of pipeline configs. Found "%{invalid_class}" in %{path} config-pipelines-duplicate-ids: >- Pipelines YAML file contains duplicate pipeline ids: #{duplicate_ids}. Location: #{path} reload-without-config-path: >- Configuration reloading also requires passing a configuration path with '-f yourlogstash.conf' reload-with-config-string: >- Configuration reloading can't be used with 'config.string' (-e). locked-data-path: >- Logstash could not be started because there is already another instance using the configured data directory. If you wish to run multiple instances, you must change the "path.data" setting. invalid-shell: >- Invalid option for interactive Ruby shell. Use either "irb" or "pry" configtest-flag-information: |- You may be interested in the '--configtest' flag which you can use to validate logstash's configuration before you choose to restart a running system. tags-illegal-warning: >- Setting `event_api.tags.illegal` to `warn` allows illegal values in the reserved `tags` field, which may crash pipeline unexpectedly. This flag is deprecated and will be removed in version 9. # YAML named reference to the logstash.runner.configuration # so we can later alias it from logstash.agent.configuration configuration: &runner_configuration obsolete: >- The setting `%{name}` in plugin `%{plugin}` is obsolete and is no longer available. %{extra} If you have any questions about this, you are invited to visit https://discuss.elastic.co/c/logstash and ask. file-not-found: |- No config files found: %{path}. Can you make sure this path is a logstash config file? scheme-not-supported: |- URI scheme not supported: %{path} Either pass a local file path or "file|http://" URI fetch-failed: |- Unable to fetch config from: %{path} Reason: %{message} setting_missing: |- Missing a required setting for the %{plugin} %{type} plugin: %{type} { %{plugin} { %{setting} => # SETTING MISSING ... } } setting_invalid: |- Invalid setting for %{plugin} %{type} plugin: %{type} { %{plugin} { # This setting must be a %{value_type} # %{note} %{setting} => %{value} ... } } invalid_plugin_settings: >- Something is wrong with your configuration. invalid_plugin_settings_duplicate_keys: |- Duplicate keys found in your configuration: [%{keys}] At line: %{line}, column %{column} (byte %{byte}) after %{after} invalid_plugin_settings_multiple_codecs: |- The %{type} plugin %{plugin} at line %{line} has multiple `codec` declarations - this is not a valid configuration, only one top-level `codec` per %{type} plugin is supported. invalid_plugin_register: >- Cannot register %{plugin} %{type} plugin. The error reported is: %{error} plugin_path_missing: >- You specified a plugin path that does not exist: %{path} no_plugins_found: |- Could not find any plugins in "%{path}" I tried to find files matching the following, but found none: %{plugin_glob} log_file_failed: |- Failed to open %{path} for writing: %{error} This is often a permissions issue, or the wrong path was specified? flag: # Note: Wrap these at 55 chars so they display nicely when clamp emits # them in an 80-character terminal config: |+ Load the logstash config from a specific file or directory. If a directory is given, all files in that directory will be concatenated in lexicographical order and then parsed as a single config file. You can also specify wildcards (globs) and any matched files will be loaded in the order described above. config-string: |+ Use the given string as the configuration data. Same syntax as the config file. If no input is specified, then the following is used as the default input: "%{default_input}" and if no output is specified, then the following is used as the default output: "%{default_output}" If you wish to use both defaults, please use the empty string for the '-e' flag. field-reference-escape-style: |+ Use the given STYLE when parsing field references. This allows you to reference fields whose name includes characters that are meaningful in a field reference including square brackets (`[` and `]`). This feature is in TECHNICAL PREVIEW, and implementations are subject to change. Available escape styles are: - `none`: escape sequences in field references are not processed, which means fields that contain special characters cannot be referenced. - `percent`: characters may be encoded with URI-style percent notation represeting UTF-8 bytes (`[` is `%5B`; `]` is `%5D`). Unlike URI-encoding, literal percent characters do not need to be escaped unless followed by a sequence of 2 capital hexadecimal characters. - `ampersand`: characters may be encoded with HTML-style ampersand-hash encoding notation representing decimal unicode codepoints (`[` is `[`; `]` is `]`). event_api: tags: illegal: |+ The top-level `tags` field is reserved, and may only contain a single `string` or an array of `string`s -- other values will cause subsequent access of the `tags` field to crash the pipeline. This flag controls how the Event API handles a `tags` field that is an illegal shape, such as a key-value map. Available options are: - `rename`: illegal value in `tags` will be moved to `_tags`. A tag `_tagsparsefailure` is added to `tags` field to indicate the illegal assignment. Doing `set` operation with illegal value will throw exception. This is the default option. - `warn`: allow illegal value assignment and print warning at startup. This option is deprecated and slated for removal. modules: |+ Load Logstash modules. Modules can be defined using multiple instances '--modules module1 --modules module2', or comma-separated syntax '--modules=module1,module2' Cannot be used in conjunction with '-e' or '-f' Use of '--modules' will override modules declared in the 'logstash.yml' file. modules_variable: |+ Load variables for module template. Multiple instances of '-M' or '--modules.variable' are supported. Ignored if '--modules' flag is not used. Should be in the format of '-M "MODULE_NAME.var.PLUGIN_TYPE.PLUGIN_NAME.VARIABLE_NAME=VALUE"' as in '-M "example.var.filter.mutate.fieldname=fieldvalue"' modules_setup: |+ Load index template into Elasticsearch, and saved searches, index-pattern, visualizations, and dashboards into Kibana when running modules. cloud_id: |+ Sets the elasticsearch and kibana host settings for module connections in Elastic Cloud. Your Elastic Cloud User interface or the Cloud support team should provide this. Add an optional label prefix '