未提供项目描述
项目描述
此软件包将GitHub组织所有仓库的安全漏洞警报导出为Prometheus指标。
用法
配置API令牌
您需要提供一个具有repo作用域的访问令牌来访问GitHub API。有关详细信息,请参阅GitHub文档。
启动HTTP服务
像这样启动HTTP服务器:
$ GITHUB_AUTHTOKEN=MYTOKEN GITHUB_OWNER=MyGitHubOrgOrUser github_vulnerability_exporter --host=127.0.0.1 --port=9597
传递--ttl=SECONDS以缓存给定时间的GitHub API结果或-1以禁用(默认为600)。Prometheus在300秒后将指标视为过时,因此这是应使用的最高scrape_interval。但是,通常没有必要那么频繁地调用API,因为漏洞警报信息不会那么快改变。
如果您想包含分叉仓库,请传递--forked(不确定它们是否真的接收到漏洞警报)。
配置Prometheus
scrape_configs: - job_name: 'vulnerabilities' scrape_interval: 300s static_configs: - targets: ['localhost:9597']
我们导出了一个名为github_vulnerability_alerts的gauge指标,具有以下标签:{repository="MyGitHubOrgOrUser/my-repository-name, status="active|dismissed"}。
此外,还导出了ghvuln_scrape_duration_seconds gauge指标。
变更
1.5.2 (2023-04-11)
棕色袋发布
1.5.1 (2023-04-11)
将“dismissedAt: unknown”解释为已忽略,而不是活动状态
1.5.0 (2019-06-07)
添加内存缓存,以便在每次抓取时不必调用API
1.4.0 (2019-06-07)
支持收集组织或用户的仓库数据
1.3.0 (2019-06-07)
使监听主机可配置
1.2.0 (2019-06-07)
添加 状态 标签以区分活动警报和已删除警报
1.1.0 (2019-06-07)
允许通过环境变量以及命令行参数进行配置
1.0.1 (2019-06-07)
增加仓库查询批量大小。
1.0.0 (2019-06-06)
第一个版本。
项目详情
关闭
github_vulnerability_exporter-1.5.2.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 17f6458b7832288c76c77fa900360b2fa00fb053ff9792d3325cc020787a6dfe |
|
MD5 | b026850ab13aa6e728fddba1ee68b3b8 |
|
BLAKE2b-256 | efd5ab20f5453d9f4557d7426531b0c60a4a9787a7eddd8bc9895e5b80aadabe |
关闭
github_vulnerability_exporter-1.5.2-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | db62cbc473ee0d387a2b9312edc72b2a41d2064bd55ad8c95cabce0daf26eeae |
|
MD5 | 0b76ba19594612d10b28d5cbc66a26c4 |
|
BLAKE2b-256 | 9f0afbceec9cfe52ab3d01f42b2ec6944e2cbffb8bb774d5d9fe790df527ea18 |