Git Product home page Git Product logo

cc-synology-events's Introduction

Cribl Pack for Synology NAS Events


The Cribl Pack for Synology NAS processes events with the following goals in mind:

  • Events are received via syslog directly from Synology NAS
  • The pack is designed to send logs to the Splunk destination, so it embeds some additional information in the events:
    • splunk metadata (index, sourcetype, host)
    • fields are named according to the Splunk Common Information Model (CIM), so it will work with Splunk Enterprise Security out of the box
  • Reduction of events by trimming the Syslog header, removing unnecessary fields and droping logs about suppression.

You should expect to see 10-30% reduction in the size of your Synology NAS log data.

Configuration

Before you begin, ensure that you have met the following requirements:

  • Synology - DSM
  • Cribl Stream - Syslog input
    • Pack pipelines are designed to remove all unnecessary syslog fields, such as severity, facility, facilityName, appname, etc., and leave only the important ones.

Note - This pack was NOT tested in conjunction with the cribl-syslog-input pack.

Synology DSM

  • Install the Log Center package from the Package Center.
  • Configure the Log Sending settings.
    • Server: IP or hostname of Cribl Stream.
    • Port: Listening port (514)
    • Transfer Protocol: UDP or TCP
    • Log format: BSD (RFC 3164)
  • Configure the Log Filters settings.
  • Configure the File Transfer logs.
    • Go to Control Panel > File Services
    • For SMB, click Enable Tranfer Log and then configure the Log Settings.

Release Notes

Version 0.1.3 - 2022-08-18

Minor release with a fix that changes the order of routes to avoid parsing problems.

Version 0.1.2 - 2022-08-16

A few changes to regexes to extract more fields when possible.

Version 0.1.1 - 2022-07-17

Minor release to fix version mismatch, update README and samples.

Version 0.1.0 - 2022-07-08

Initial release.

Contributing to the Pack

To contribute to the pack, please open a pull request on GitHub.

Contact

Feel free to reach out to [email protected].

License

This Pack uses the following license: Apache 2.0.

cc-synology-events's People

Contributors

faloker avatar

Watchers

 avatar

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.