菜单
文档breadcrumb arrow Grafana Alloybreadcrumb arrow 参考breadcrumb arrow 组件breadcrumb arrow prometheusbreadcrumb arrow prometheus.exporter.github
开源

prometheus.exporter.github

prometheus.exporter.github 组件封装了用于从 GitHub 收集统计信息的 github_exporter

用法

alloy
prometheus.exporter.github "LABEL" {
}

参数

以下参数可用于配置导出器的行为。所有参数都是可选的。省略的字段将采用默认值。

名称类型描述默认值是否必须
api_url字符串GitHub API 的完整 URI。https://api.github.com
repositories列表(字符串)要收集指标的 GitHub 仓库。
organizations列表(字符串)要收集指标的 GitHub 组织。
users列表(字符串)要收集指标的 GitHub 用户列表。
api_token机密用于对 GitHub 进行身份验证的 API 令牌。
api_token_file字符串包含用于对 GitHub 进行身份验证的 API 令牌的文件。

GitHub 根据 IP 地址使用基于请求未验证的积极速率限制。为了允许更多的 API 请求,建议配置 api_tokenapi_token_file 以对 GitHub 进行身份验证。

提供时,api_token_fileapi_token 优先。

导出字段

以下字段将被导出,并且可以由其他组件引用。

名称类型描述
targets列表(映射(字符串))可用于收集导出器指标的靶标。

例如,targets 可以传递给 discovery.relabel 组件以重新编写靶标的标签集,或者传递给收集公开指标的 prometheus.scrape 组件。

导出的靶标使用由 运行命令 指定的配置的 内存流量 地址。

组件健康

只有在不提供有效配置的情况下,prometheus.exporter.github 才会被报告为不健康。在这种情况下,导出字段保留其最后健康的值。

调试信息

prometheus.exporter.github 不公开任何特定于组件的调试信息。

调试指标

prometheus.exporter.github 不公开任何特定于组件的调试指标。

示例

此示例使用 prometheus.scrape 组件prometheus.exporter.github 收集指标

alloy
prometheus.exporter.github "example" {
  api_token_file = "/etc/github-api-token"
  repositories   = ["grafana/alloy"]
}

// Configure a prometheus.scrape component to collect github metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.github.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = PROMETHEUS_REMOTE_WRITE_URL

    basic_auth {
      username = USERNAME
      password = PASSWORD
    }
  }
}

替换以下

  • PROMETHEUS_REMOTE_WRITE_URL:发送指标到兼容 Prometheus remote_write 服务器 URL。
  • USERNAME:用于远程_write API 认证的用户名。
  • PASSWORD:用于远程_write API 认证的密码。

兼容组件

prometheus.exporter.github 导出一些可以被以下组件消费的实体

注意

连接某些组件可能不合理或组件可能需要进一步配置才能正确连接。请参阅链接文档以获取更多详细信息。