Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.4 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.4 KB

Alloy Modules

Grafana

Grafana Alloy logo Grafana Alloy logo

Modules are a way to create Grafana Alloy configurations which can be loaded as a component. Modules are a great way to parameterize a configuration to create reusable pipelines.

Submitting modules

Create a folder for the module under the ./modules directory in the appropriate category. Each module must have a README.md that provides the following information:

  • Components
  • Brief description
  • Applicable Alloy versions
  • Declare arguments and exports
  • Example

Referencing Modules

Whenever a new module is submitted and a pull request is merged to the main branch, a tag is automatically created and published, by default this is a patch bump.

Modules can be reference directly from this git repository using the import.git or import.http components. It is recommended to always reference a tagged version, and not the main branch.