菜单
文档breadcrumb arrow Grafana Alloybreadcrumb arrow 入门breadcrumb arrow 自定义组件
开源

自定义组件

自定义组件是一种通过内置组件和其他自定义组件的管道来创建新组件的方式。

自定义组件包含

  • 参数:配置自定义组件的设置。
  • 导出值:自定义组件暴露给消费者的值。
  • 组件:作为自定义组件一部分运行的内置和自定义组件。

创建自定义组件

使用 declare 配置块 创建新的自定义组件。该块的标签指定了自定义组件的名称。

您可以在 declare 块中使用以下配置块

  • argument:定义一个命名参数,您可以使用表达式 argument.NAME.value 引用其当前值。自定义组件的使用者决定参数值。
  • export:定义一个命名值以暴露给自定义组件用户。

自定义组件有助于多次重用同一个管道。要了解如何在文件之间共享自定义组件,请参阅 模块

示例

此示例创建了一个名为 add 的自定义组件,它导出两个参数的和

alloy
declare "add" {
    argument "a" { }
    argument "b" { }

    export "sum" {
        value = argument.a.value + argument.b.value
    }
}

add "example" {
    a = 15
    b = 17
}

// add.example.sum == 32