Definitions
editDefinitions
editPackage
editAn Elastic Package, or simply package for short, contains the dashboards, visualisations, and configurations to monitor the logs and metrics of a particular technology or group of related services, such as “MySQL”, or “System”.
The package consists of:
- Name
- Zero or more dashboards and visualisations and Canvas workpads
- Zero or more ML job definitions
- Zero or more data stream index templates
The package is versioned.
Integration
editAn integration is a specific type of a package defining data streams used to observe a product using logs, metrics, and traces.
Data stream
editA data stream is logical sub-division of an Integration package, dealing with a specific type of observable aspect of the service or product being observed. For example, the mysql
package defines a data stream for collecting metrics and another data stream for collecting server logs.
A data stream defines all the assets needed to create an Elasticsearch data stream, for example: index templates and ingest pipelines. These assets are loaded into Elasticsearch when a user installs a package via the Fleet UI in Kibana.
A data stream also defines a policy template. Policy templates include variables that allow users to configure the data stream via the Fleet UI in Kibana. The resulting policy is interpreted by the Elastic Agent to collect relevant information from the product or service being observed.
Data streams are defined inside the data_stream
folder located under the package’s root directory. Each data stream is defined in it’s own sub-folder.
The data stream consists of:
-
Field definitions (
fields.yml
files) - Zero or more ingest pipelines
- An Elastic Agent policy template
Development Extensions: _dev
directories
editThe _dev
directory is part of the package-spec, and contains development resources. These development resources cover any types of files or folders needed only at development time. This includes resources needed for testing, but also includes any templates that might be used for generating documentation. In the future it could include other files or folders needed just at development time. It can be defined on the following levels:
-
The package-level
_dev
folder contains files needed to set up the testing environment for that package. This environment setup is specified by files and folders in the_dev/deploy
folder. For example, theapache
package specifies how to spin up an Apache Docker container for testing. -
The data stream-level
_dev
folder contains test configuration files for various types of tests. For example, see the_dev/test folder
under theapache/error
data stream. The integrations have also asset and static tests. They don’t require config files, but configs can be used to mark them as optional.