The Splunk Product Best Practices team provided this response. Read more about How Crowdsourcing is Shaping the Future of Splunk Best Practices.
Welcome to the world of Splunk Dev, where creating a Splunk app or add-on is simple. Everything you need to develop a Splunk app is included in a stand-alone Splunk sandbox, or with any instance of Splunk Enterprise.
Note: This answer applies to Splunk Enterprise and Splunk Cloud.
How Splunk helps you create and share apps
You can develop a Splunk app or add-on from any Splunk Enterprise instance, like your local Splunk sandbox. If you're building an add-on, you can use the Splunk Add-On Builder. You can create advanced dashboards and visualizations using the Splunk Web Framework .
You can also build more advanced features into your app, for example, add a navigation layer, add app supportability metrics, and add licensing requirements. If you're the developer sort, you can create custom search commands using the Splunk SDK for Python. When you're ready to publish, you can use the packaging toolkit to validate it.
- Splunk Add-On Builder: A tool that helps you quickly create add-ons for Splunk using a UI. It also validates your add-on and suggests improvements before you package your add-on for distribution.
- Splunk Web Framework: An app framework for Splunk users who want to create custom dashboards and Splunk apps with tables, charts, forms searches, and other functionality.
- Packaging toolkit: A tool for authoring, packaging, and validating a Splunk app that simplifies and streamlines app installation, configuration, and updating.
When you're ready to share your app with the wide world, Splunk makes it easy to package it up and publish it. Where it goes from there is up to you: use it within your own organization, certify it for the wider Splunk community on Splunkbase, or get it vetted for use on Splunk Cloud!
How to get started creating Splunk apps and add-ons
- Create an app. Create a Splunk app using the barebones template. This creates the basic container for the Splunk knowledge objects you want to include in your app or add-on.
- Populate the app. Build a saved search or clone a dashboard or other knowledge object from an existing app into your app.
- Share your app. Package and publish a Splunk app to make your app ready to share.
- Enroll in Building Splunk Apps. To learn more about building apps and get some practice before you take to the streets, enroll in Building Splunk Apps, a course designed for power users, administrators, and app developers who want to create powerful, interactive apps using the Splunk Web Framework.
- Review the naming convention. Watch the following video about the suggested naming convention for Splunk apps and add-ons.
The Splunk Product Best Practices team provided this response. Read more about How Crowdsourcing is Shaping the Future of Splunk Best Practices.
Welcome to the world of Splunk Dev, where creating a Splunk app or add-on is simple. Everything you need to develop a Splunk app is included in a stand-alone Splunk sandbox, or with any instance of Splunk Enterprise.
Note: This answer applies to Splunk Enterprise and Splunk Cloud.
How Splunk helps you create and share apps
You can develop a Splunk app or add-on from any Splunk Enterprise instance, like your local Splunk sandbox. If you're building an add-on, you can use the Splunk Add-On Builder. You can create advanced dashboards and visualizations using the Splunk Web Framework .
You can also build more advanced features into your app, for example, add a navigation layer, add app supportability metrics, and add licensing requirements. If you're the developer sort, you can create custom search commands using the Splunk SDK for Python. When you're ready to publish, you can use the packaging toolkit to validate it.
- Splunk Add-On Builder: A tool that helps you quickly create add-ons for Splunk using a UI. It also validates your add-on and suggests improvements before you package your add-on for distribution.
- Splunk Web Framework: An app framework for Splunk users who want to create custom dashboards and Splunk apps with tables, charts, forms searches, and other functionality.
- Packaging toolkit: A tool for authoring, packaging, and validating a Splunk app that simplifies and streamlines app installation, configuration, and updating.
When you're ready to share your app with the wide world, Splunk makes it easy to package it up and publish it. Where it goes from there is up to you: use it within your own organization, certify it for the wider Splunk community on Splunkbase, or get it vetted for use on Splunk Cloud!
How to get started creating Splunk apps and add-ons
- Create an app. Create a Splunk app using the barebones template. This creates the basic container for the Splunk knowledge objects you want to include in your app or add-on.
- Populate the app. Build a saved search or clone a dashboard or other knowledge object from an existing app into your app.
- Share your app. Package and publish a Splunk app to make your app ready to share.
- Enroll in Building Splunk Apps. To learn more about building apps and get some practice before you take to the streets, enroll in Building Splunk Apps, a course designed for power users, administrators, and app developers who want to create powerful, interactive apps using the Splunk Web Framework.
- Review the naming convention. Watch the following video about the suggested naming convention for Splunk apps and add-ons.
