lunar-collector.yml

Collector Plugin

• lunar-collector.yml

• Type: YAML file

• Form:

  version: 0
  
  name: <collector-name>
  description: <collector-description>
  author: <author-name>
  
  collectors:
    - <collector-configuration>
    - <collector-configuration>
    - ...
  
  inputs:
    <input-name>:
      description: <input-description>
      default: <default-value>
    ...

This page describes the configuration of a collector plugin. Collector plugins are used to collect live information from various sources to associate with individual components. Collector plugins can be imported from the Lunar configuration file, lunar-config.yml via the uses collector form.

Collector plugins can be defined either in a separate repository or in the same repository as the Lunar configuration, in a dedicated directory. Either way, the collector plugin must contain a lunar-collector.yml file in the root of the repository or directory. This file is used to configure the behavior of the collector plugin.

When using collectors in the Main or Run forms (e.g. mainPython or runPython), the collector plugin directory may also contain an install.sh file, and/or a requirements.txt file (Python only). These files can be used to specify any environment setup logic to be executed, or Python dependencies to be installed, respectively, before executing the main script. In ephemeral environments, the installation is executed every time the environment is created (e.g. on each CI job, or on each code collector execution). Lunar uses a lock file under the hood to detect if the script has previously been executed.

version

• lunar-collector.yml -> version

• Type: numeric

• Required

The version field is used to specify the version of the collector configuration file. The current version is 0.

name

• lunar-collector.yml -> name

• Type: string

• Required

The name field is used to specify the name of the collector.

description

• lunar-collector.yml -> description

• Type: string

• Optional

The description field is used to specify a description of the collector.

author

• lunar-collector.yml -> author

• Type: string

• Required

The author field is used to specify the author of the collector.

collectors

• lunar-collector.yml -> collectors

• Type: array

• Required

The collectors field is used to specify the configuration of the collector. The format of a collector is the same as in lunar-config.yml, except that the on field is not allowed. To learn more about the configuration of a collector, see the collectors page.

inputs

• lunar-collector.yml -> inputs

• Type: object

• Optional

The inputs field is used to specify the inputs required by the collector. Each input is defined as a key-value pair, where the key is the input name.

Inputs are passed to the collector when invoked in the form of environment variables.

description

• lunar-collector.yml -> inputs.<input-name>.description

• Type: string

• Optional

The description field is used to specify a description of the input.

default

• lunar-collector.yml -> inputs.<input-name>.default

• Type: string

• Optional

The default field is used to specify the default value of the input. If no default value is specified, the input is required.