没有项目描述
github-vulnerability-exporter的Python项目详细描述
此包从github导出组织的所有存储库的Security Vulnerability Alerts作为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)。 普罗米修斯认为指标在300秒后失效,所以这是一个人应该使用的最高刮擦间隔。 但是,由于漏洞警报信息的变化并没有那么快,因此通常不需要经常攻击api。
如果要包含分叉存储库,请传递--forked(但不确定它们是否实际接收到漏洞警报)。
配置普罗米修斯
scrape_configs: - job_name: 'vulnerabilities' scrape_interval: 1800s static_configs: - targets: ['localhost:9597']
我们导出一个度量,一个称为github_vulnerability_alerts的度量, 带标签{repository="MyGitHubOrgOrUser/my-repository-name,status="active|dismissed"}。
此外,还导出了一个ghvuln_scrape_duration_secondsgauge。
更改
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)
- 第一次释放。