Code Monkey home page Code Monkey logo

vscode-logstash-editor's Introduction

VSCode Logstash Editor

Visual Studio Code extension that provides completion, documentation and auto-formatting for Logstash pipeline configuration files and Elasticsearch index template json files.

Example

Project Page
Change Log

Features

  • Provides completion for Logstash pipeline configuration files (sections, plugins, options), depending current cursor position.
    For example, if cursor is inside grok filter, options for grok filter are suggested.
  • All completion data is generated from official Logstash documentation
  • Options for a plugin are sorted : first required options, then optional specific options, and finally optional common options
  • When you preselect an item, a link to official documentation, a short description and an example (if available) are provided
  • If you choose a completion item, a code snippet is automatically inserted with relevant content:
    • for a plugin, inserted snippet is the plugin block and all its required options
    • for an option, inserted snippet is based on option type (string, boolean, number, string_duration, array, hash)
  • Provides completion for if statement
  • Provides documentation when hover on a section, a plugin or an option
  • Provides document formatting and document range formatting on a Logstash pipeline configuration file
  • Provides completion for Elasticsearch index template json files, based on a json schema
  • Provides a specific index template json schema for Elasticsearch 6.x and 7.x
  • Provides "logstash.version" configuration setting to choose Logstash version (for completion)
  • Provides "Set Logstash Version" command (shortcut: Ctrl+Shift+L) to change Logstash version setting
  • Supported Logstash versions: 6.8, 7.2, 7.5
  • Following file patterns are automatically associated to Logstash language:
    • *logstash.conf
    • *logstash.conf.j2
    • *logstash.conf.template
    • logstash-*.conf
  • Following file patterns are automatically associated to Elasticsearch index template json schema:
    • *elasticsearch-template.json
    • *elasticsearch-template-es7x.json
    • *elasticsearch-template-es6x.json

Important note

For now, only this format style is supported for Logstash configuration files:

filter {
	tcp {
		port => 12345
	}
}

This format style is not supported:

filter 
{
	tcp 
	{
		port => 12345
	}
}

Neither this one:

filter { tcp { port => 12345 } }

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.