declare 块

declare 是一个可选的配置块，用于定义新的自定义组件。declare 块必须指定一个标签，该标签决定了自定义组件的名称。

示例

declare "COMPONENT_NAME" {
    COMPONENT_DEFINITION
}

参数

declare 块没有预定义的参数模式。declare 块的主体用作组件定义。主体可以包含以下内容：

argument 块
export 块
declare 块
import 块
组件定义（内置或自定义组件）

declare 块不能包含未在上面列出的任何配置块。

导出的字段

declare 块没有预定义的导出模式。declare 块导出的字段由其定义中的 export 块决定。

示例

此示例创建并使用一个自定义组件，该组件自动收集进程指标并将其转发到自定义组件用户指定的参数

declare "self_collect" {
  argument "metrics_output" {
    optional = false
    comment  = "Where to send collected metrics."
  }

  prometheus.scrape "selfmonitor" {
    targets = [{
      __address__ = "127.0.0.1:12345",
    }]

    forward_to = [argument.metrics_output.value]
  }
}

self_collect "example" {
  metrics_output = prometheus.remote_write.example.receiver
}

prometheus.remote_write "example" {
  endpoint {
    url = REMOTE_WRITE_URL
  }
}