environment

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-filter-environment.

This filter stores environment variables as subfields in the @metadata field. You can then use these values in other parts of the pipeline.

Adding environment variables is as easy as:

   filter {
     environment {
       add_metadata_from_env { "field_name" => "ENV_VAR_NAME" }
     }
   }

Accessing stored environment variables is now done through the @metadata field:

["@metadata"]["field_name"]

This would reference field field_name, which in the above example references the ENV_VAR_NAME environment variable.

Previous versions of this plugin put the environment variables as fields at the root level of the event. Current versions make use of the @metadata field, as outlined. You have to change add_field_from_env in the older versions to add_metadata_from_env in the newer version.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

environment {
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

add_metadata_from_env

hash

No

{}

add_tag

array

No

[]

periodic_flush

boolean

No

false

remove_field

array

No

[]

remove_tag

array

No

[]

Details

edit

 

add_field

edit
  • Value type is hash
  • Default value is {}

If this filter is successful, add any arbitrary fields to this event. Field names can be dynamic and include parts of the event using the %{field}.

Example:

    filter {
      environment {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }
    # You can also add multiple fields at once:
    filter {
      environment {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would add field foo_hello if it is present, with the value above and the %{host} piece replaced with that value from the event. The second example would also add a hardcoded field.

add_metadata_from_env

edit
  • Value type is hash
  • Default value is {}

Specify a hash of field names and the environment variable name with the value you want imported into Logstash. For example:

   add_metadata_from_env { "field_name" => "ENV_VAR_NAME" }

or

   add_metadata_from_env {
     "field1" => "ENV1"
     "field2" => "ENV2"
     # "field_n" => "ENV_n"
   }

add_tag

edit
  • Value type is array
  • Default value is []

If this filter is successful, add arbitrary tags to the event. Tags can be dynamic and include parts of the event using the %{field} syntax.

Example:

    filter {
      environment {
        add_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also add multiple tags at once:
    filter {
      environment {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would add a tag foo_hello (and the second example would of course add a taggedy_tag tag).

periodic_flush

edit
  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

remove_field

edit
  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary fields from this event. Fields names can be dynamic and include parts of the event using the %{field}

Example:

    filter {
      environment {
        remove_field => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple fields at once:
    filter {
      environment {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would remove the field with name foo_hello if it is present. The second example would remove an additional, non-dynamic field.

remove_tag

edit
  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary tags from the event. Tags can be dynamic and include parts of the event using the %{field} syntax.

Example:

    filter {
      environment {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple tags at once:
    filter {
      environment {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

If the event has field "somefield" == "hello" this filter, on success, would remove the tag foo_hello if it is present. The second example would remove a sad, unwanted tag as well.