GSoC 2019 Proposal: Create syslog ng configuration snippets for VSCode (windonis)
E-mail: kollugil@itu.edu.tr
GitHub: https://github.com/windonis
Make it easier to write syslog-ng configurations in Visual Studio Code
The following features are planned to be included in the scope of the project:
I think the most important situation in the creation of the snippets is the control of the syntax required. For
this reason, we need to specify the required options and spelling in the syslog configuration. In particular,
standard log files and filter stage must be included.
In Syntax highlighting, the keyword control will facilitate the writing of configuration. (options, source, destination, filter, parser, rewrite, template, template-function, log, junction, channel, block)
In Syslog configuration, file path defining like this; {xxx ("…"); }; therefore, we should offer automatic completion and minimize the error.
We have to check that this order is in order, we should give a warning in case of faulty.
For example, if I need to create a snippet for syslog-ng;
{
"Create-Log-Block": {
"prefix": "log",
"body": [
"log {",
"\tsource ();",
"\tparser ();",
"\tfilter ();",
"\tdestination ()",
"};"
],
"description": "Log Block Example"
}
}
This file is saved as “xxx.json” and then added to VScode. When the snippet added to the system it became visible as in the figure.
I think VScode documentation will help me to creating snippet and I will read the syslog RFCs to increase my knowledge.
I am frequently using syslog for Linux servers. In addition, I write my PowerShell scripts on VsCode. I would like to combine these two works within project. I can do the snippet project for VIM if it's right for you.
The following plans will be followed throughout the project:
3.1. Project Schedule
The project will likely take most of the allotted time, and will be broken up into
three phases:
3.1.1. Planning (completion by mid of May)
This step to gain a thorough understanding of all requirements. I will meet with my mentors and plan the road map
with the help of community and my mentors.
3.1.2. Development (completion by beginning of August)
The development process will be largely iterative, in which small pieces of functionality are added and feedback
solicited from the Syslog community at each step, to ensure that the project is adequately meeting expectations.
3.1.3. Wrap-up (completion by end of August)
Code cleaning and write documents.
3.2. My working schedule
For the GSoC program I plan to allocate at least 30 hours per week, in
flexible manner. My time zone is GMT+3 (EET). The time difference won’t be an
issue for me.
3.3 Communication with mentor and community
Every week, I am planning to prepare a report and post to the
my mentor’s email address about my work. In addition, I will track related app issues and be involved discussions
from GitHub.
I am a senior year undergraduate student from Istanbul Technical University. I am working on University's IT Head Office as a System Administrators. I have experience with PowerShell scripting and Linux system administration. Also interested in algorithms and competitive programming. I am a FOSS enthusiast, contributor and passionate about working on open source tools and technologies.