emojiedit

  • Version: 1.0.0
  • Released on: March 8, 2017
  • Changelog

Installationedit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-filter-emoji. See Working with plugins for more details.

Getting Helpedit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Descriptionedit

This plugin maps the severity names or numeric codes as defined in RFC 3164 and RFC 5424 to the emoji as defined in the configuration.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

emoji {
    field => ...
}

Available configuration options:

Detailsedit

 

add_fieldedit

  • 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 {
  emoji {
    add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
  }
}
# You can also add multiple fields at once:
filter {
  emoji {
    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_tagedit

  • 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 {
  emoji {
    add_tag => [ "foo_%{somefield}" ]
  }
}
# You can also add multiple tags at once:
filter {
  emoji {
    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).

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

fallbackedit

  • Value type is string
  • There is no default value for this setting.

In case no match is found in the event, this will add a default emoji, which will always populate target, if the match failed.

For example, if we have configured fallback => "`❓"`, using this dictionary:

foo: 👤

Then, if logstash received an event with the field foo set to 👤, the target field would be set to 👤. However, if logstash received an event with foo set to nope, then the target field would still be populated, but with the value of ❓. This configuration can be dynamic and include parts of the event using the %{field} syntax.

fieldedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The name of the logstash event field containing the value to be compared for a match by the emoji filter (e.g. severity).

If this field is an array, only the first value will be used.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
 stdout {
   id => "my_plugin_id"
 }
}

overrideedit

  • Value type is boolean
  • Default value is false

If the target field already exists, this configuration item specifies whether the filter should skip being rewritten as an emoji (default) or overwrite the target field value with the emoji value.

periodic_flushedit

  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

remove_fieldedit

  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary fields from this event. Example:

filter {
  emoji {
    remove_field => [ "foo_%{somefield}" ]
  }
}
# You can also remove multiple fields at once:
filter {
  emoji {
    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_tagedit

  • 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 {
  emoji {
    remove_tag => [ "foo_%{somefield}" ]
  }
}
# You can also remove multiple tags at once:
filter {
  emoji {
    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.

sev_alertedit

  • Value type is string
  • Default value is "🚨"

sev_alert selects the emoji/unicode character for Alert severity

sev_criticaledit

  • Value type is string
  • Default value is "🔥"

sev_critical selects the emoji/unicode character for Critical severity

sev_debugedit

  • Value type is string
  • Default value is "🐛"

sev_debug selects the emoji/unicode character for Debug severity

sev_emergencyedit

  • Value type is string
  • Default value is "💥"

sev_emergency selects the emoji/unicode character for Emergency severity

sev_erroredit

  • Value type is string
  • Default value is "❌"

sev_error selects the emoji/unicode character for Error severity

sev_infoedit

  • Value type is string
  • Default value is "ℹ️"

sev_info selects the emoji/unicode character for Informational severity

sev_noticeedit

  • Value type is string
  • Default value is "👀"

sev_notice selects the emoji/unicode character for Notice severity

sev_warningedit

  • Value type is string
  • Default value is "⚠️"

sev_warning selects the emoji/unicode character for Warning severity

targetedit

  • Value type is string
  • Default value is "emoji"

The target field you wish to populate with the emoji. The default is a field named emoji. Set this to the same value as the source (field) if you want to do a substitution, in this case filter will allways succeed. This will overwrite the old value of the source field!