Splunk has a ton to offer visually. And while visualizations are Splunk’s sweet spot, let’s make your Splunk instance a little more… personal. Why not add some flare and customize your Splunk environment by adding your company logos and branding? I’ll walk you through how to add customization to login pages and PDF exports, directly in Splunk. Not only does customizing your Splunk environment help you maintain brand standards, but it makes your reports look more professional and it makes your deployment overall look and feel more mature. (You also get some great brownie points with management!)
Customize Your Login Page
Here’s the default login page you’re probably seeing in Splunk. You can turn this into something that fits your company’s brand standards through some customization tricks in Splunk.
Custom Login Page
First, update your login page background. Navigate to Settings > Server Settings > Login Background. Once you’re there, follow these image format settings…
- Use a .jpg, .jpeg, or .png formatted file.
- A landscape-oriented image is recommended.
- The maximum file size is 20MB.
- The suggested minimum image size is 1024×640 pixels.
Add Your Logo
Next, change out the Splunk login logo to your company’s login logo. On this step, the Splunk web.conf file needs to be updated to use a custom logo. Follow these image requirements:
- The maximum image size is 485px wide and 100px high.
- If the image exceeds these limits, the image is automatically resized.
loginCustomLogo = <fullUrl, pathToMyFile, myApp:pathToMyFile, or blank for default> Default destination folder: $SPLUNK_HOME/etc/apps/search/appserver/static/logincustomlogo. Example: If your logo image is located at $SPLUNK_HOME/etc/apps/search/appserver/static/logincustomlogo/logo.png, type loginCustomLogo = logincustomlogo/logo.png. Manual location: $SPLUNK_HOME/etc/apps/<myApp>/appserver/static/<pathToMyFile>, and type loginCustomLogo = <myApp:pathToMyFile>
Add Text to Login
After that, add some login text to your page. Similar to the previous step, the same web.conf needs to be updated to add login text. Add “login_content” setting to conf file.
login_content = <string>
* Lets you add custom content to the login page.
* Supports any text including HTML.
* No default.
Add Alert Action
Finally, on your login page customization, add an alert action. It is often required to present a notice to a user before logging in. This can be done by adding an “alert” script to the login content. Follow the lines below to set up your login page alert.
Customize Your Reports
Once you’re done updating your login page, take a look at customizing your PDF’s and reports with your company logo. Not only does it add to the visualization of reports, but small things like this can make your work in Splunk stand out.
In order to add a custom logo to reports, the alert_actions.conf file needs to be updated.
pdf.logo_path = <string>* Define the PDF logo using the syntax <app>:<path-to-image>. * If set, the PDF is rendered with this logo instead of the Splunk logo. * If not set, the Splunk logo is used by default. * The logo is read from the $SPLUNK_HOME/etc/apps/<app>/appserver/static/<path-to-image> path if <app> is provided.
Check it out — you’ve got your company logo on your PDF! An easy way to make your Splunk reports look more professional and quality.
Customizing your Splunk environment can add a personal and professional touch to the work you do. If one of the biggest benefits for using Splunk is visualizations, take advantage of that and add your company branding to make those visuals stand-out even more. At Kinney Group, we love adding our logo and branding anywhere we can in Splunk. If you need help or more tips in tricks on how to customize your Splunk environment, we’re happy to help.