create_new_package.md

HOWTO: Create new packages and data streams

Introduction

The elastic-package tool can be used to bootstrap a new package or add a data stream using an embedded archetype (resource templates). It's advised to use elastic-package create to build new package rather than copying sources of an existing package. This will ensure that you're following latest recommendations for the package format.

Create new package

Prerequisites

Pick the directory where you'd like to create a new package. For integrations, it's: packages/.

Steps

1. Bootstrap new package using the TUI wizard: elastic-package create package.
2. Adjust the created package manually:
   • define policy templates and inputs
   • add icons and screenshots
   • update README files
   • update changelog.yml file
3. Verify the package:
   1. Enter the package directory: cd <new_package>.
   2. Check package correctness: elastic-package check.

Add data stream

Prerequisites

Enter the package directory. For nginx integration, it's: packages/nginx/.

Steps

1. Bootstrap new data stream using the TUI wizard: elastic-package create data-stream.
2. Adjust the created data stream manually:
   • define streams and required vars
   • define used fields
   • define ingest pipeline definition (if necessary)
   • update the agent's stream configuration
3. Verify the package:
   1. Enter the package directory: cd <new_package>.
   2. Check package correctness: elastic-package check.