Book Image

Mastering Splunk

By : James D. Miller
Book Image

Mastering Splunk

By: James D. Miller

Overview of this book

Table of Contents (18 chapters)
Mastering Splunk
About the Author
About the Reviewers

Naming conventions for documentation

As with any technology, it is highly recommended that you develop naming conventions (sometimes referred to as a naming style) for your knowledge objects before you begin developing them. That's the trick.

Developing naming conventions for knowledge objects

It is difficult to create workable conventions or standards unless you have experience and are familiar with which objects can be created within Splunk and their purposes. Generally speaking, more mature organizations will adopt styles used with other technologies, which you'll need to learn and adhere to. In new or less mature shops, it'll be up to you to define naming styles.

You can cultivate naming conventions for almost every kind of knowledge object in Splunk, but what will this standard naming really do for us Splunkers?

Organized naming conventions

Using consistent naming, such as a prefix for all the objects intended for a specific purpose, will naturally show object associations. If I prefix all...