https://github.com/synlay/logstash-filter-htmlentities

Logstash filter for decoding (X)HTML entities from event fields
https://github.com/synlay/logstash-filter-htmlentities

htmlentities logstash logstash-plugin

Last synced: over 1 year ago
JSON representation

Logstash filter for decoding (X)HTML entities from event fields

• Host: GitHub
• URL: https://github.com/synlay/logstash-filter-htmlentities
• Owner: synlay
• License: mit
• Created: 2017-05-26T09:38:27.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-26T13:55:40.000Z (about 9 years ago)
• Last Synced: 2025-03-02T08:17:13.669Z (over 1 year ago)
• Topics: htmlentities, logstash, logstash-plugin
• Language: Ruby
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Logstash Filter HTMLEntities Plugin

[![Build Status](https://travis-ci.org/synlay/logstash-filter-htmlentities.svg)](https://travis-ci.org/synlay/logstash-filter-htmlentities)

[![Coverage Status](https://coveralls.io/repos/github/synlay/logstash-filter-htmlentities/badge.svg?branch=master)](https://coveralls.io/github/synlay/logstash-filter-htmlentities?branch=master)

[![Gem Version](https://badge.fury.io/rb/logstash-filter-htmlentities.svg)](https://badge.fury.io/rb/logstash-filter-htmlentities)

[![GitHub license](https://img.shields.io/github/license/synlay/logstash-filter-htmlentities.svg)](https://github.com/synlay/logstash-filter-htmlentities)

This is a plugin for [Logstash](https://github.com/elastic/logstash).

It is fully free and fully open source. The license is MIT, see [LICENSE](http://github.com/synlay/logstash-filter-htmlentities/LICENSE) for further infos.

## Documentation

This filter will decode (X)HTML entities from a given source field and store the result to the target field.

### 1. Configuration

```ruby

filter {

  htmlentities {

    source => "test_source_field"

    target => "test_target_field"

  }

}

```

This configuration will encode the source field `test_source_field` e.q. with data "Examples & Explanations" to "Examples & Explanations" and store the result to the field `test_target_field`.

## Developing

For further instructions on howto develop on logstash plugins, please see the documentation of the official [logstash-filter-example](https://github.com/logstash-plugins/logstash-filter-example#developing).