icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading FreeNAS app for Splunk
SHA256 checksum (freenas-app-for-splunk_101.tgz) b71afac2bd28c59b5f18b3adf27ab6b4243f29a0aaf8434d52d6d41e91c200a3
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

FreeNAS app for Splunk

Overview
Details
FreeNAS app for Splunk®

Monitor;
Drive Temperature and activity
ZFS Pool capacities.
Predict drive utilisation
Snapshots
Replication
Jails
Scrubs
Smart and disk info
Monitor multiple hosts
CPU temps
System Load
Compare local weather to system temperatures

Simple setup;

* Just add IP and password to utilise the FreeNAS api for ZFS and drive metrics
* Add cron scripts to output key=value data to syslog from FreeNAS (See documentation tab) - let the app do the rest

If email is configured there is an alert for CPU temp as an example (Disabled by default)

This should also work for a vanilla FreeBSD host, and FreeNAS 10 but only basic testing done

Many thanks to the FreeNAS community (and IXSystems) for forum posts and advice I have utilised making this app.

I am not affiliated with IXSystems, FreeNAS in any way.

FreeNAS app for Splunk

This repo contains a FreeNAS app for Splunk®

FreeNAS

http://www.freenas.org/

FreeNAS is a powerful, flexible home storage system – configured by you, for your needs.

Note - This should also work for a vanilla FreeBSD host, and FreeNAS 10 but only basic testing done

ZFS

The Z File System, or ZFS , is an advanced file system designed to overcome many of the major problems found in previous designs.

Splunk®

Free Splunk Download Link

Splunk Enterprise is the leading platform for real-time operational intelligence. When you download Splunk Enterprise for free, you get a Splunk Enterprise license for 60 days that lets you index up to 500 megabytes of data per day.

When the free trial ends, you can convert to a perpetual Free license or purchase an Enterprise license to continue using the expanded functionality designed for multi-user deployments.

Dashboards

System Info

This Dashboard contains information on the FreeNAS system(s)

Example Dashboard1

Example Dashboard2

Inputs

For this app to work completely the REST API Modular Input is required, install the REST app first (thanks to the awesome Damien Dallimore)

FreeNAS API

http://api.freenas.org/index.html

This app utilises the FreeNAS api for some data.

Check either inputs.conf, or if you are a novice you can just change the details in the “data inputs” section of Splunk.

You will need to configure for your environment;

  • Your FreeNAS IP address or host name
  • Your FreeNAS ROOT password (currently the FreeNAS API only allows the root user)

.SH files

There are several .sh scripts in /TA-SH_files_for_FreeNAS directory that need to be placed on a persistent dataset on the FreeNAS server with a cron job associated with them, set to run every few minutes.

https://doc.freenas.org/9.3/freenas_tasks.html

these scripts output to “logger” - which is the syslog output

Also once copied over this command may be your friend :)

chmod 777 foo.sh

Syslog

You need to configure FreeNAS to log to a central server (Splunk®) for the data to be ingested, point to port 1514 e.g.

192.168.1.2:1514

https://doc.freenas.org/9.3/freenas_system.html#general

Local Weather input - REST api (Optional)

To compare local temps with system temps I added a json API input via openweathermap

Its free to signup - edit inputs.conf with your location information and appid (API key)

VERY IMPORTANT NOTE

This app is work in progress

Please submit issues, improvements patches to github - http://j-c-b.github.io/freenas_splunk/

App is available directly on Splunkbase https://splunkbase.splunk.com/app/2940/#/overview

TODO

  • Snapshot script and dashboard for success / fail
  • ZFS related goodness for pools and datasets
  • Improve dashboard search efficiency
  • Use ipmiOutput for host data input
  • FreeNAS API related dashboarding for scrubs, snapshots etc

Release Notes

Version 1.0.1
Nov. 21, 2021

Fixed nav after changes

52
Installs
2,713
Downloads
Share Subscribe LOGIN TO DOWNLOAD

Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.