grafana/okta-logs-collector

Okta Logs Collector

此应用程序轮询Okta 系统日志 条目并将其打印到控制台（stdout）。日志可随后通过 Loki 使用 Promtail 代理 或 Alloy 转发。

!https://raw.githubusercontent.com/grafana/okta-logs-collector/main/assets/explore-view.png

安装

您可以使用提供的Docker镜像、已发布的二进制文件或从源码构建来运行此应用程序。

Docker

Docker镜像可在 https://hub.docker.com/r/grafana/okta-logs-collector 获取。入口点已设置为命令本身，因此您可以直接向容器传递参数，如下所示。或者，您可以不带参数运行容器以查看帮助消息。请注意，您可以通过环境变量提供API密钥和Okta URL，如 配置 中所述。

bash
docker run --rm --name okta-logs-collector grafana/okta-logs-collector:latest --help

Docker部署示例： 使用环境变量配置API密钥和Okta URL，并以后台模式运行：

bash
docker run -d --name okta-logs-collector \
  -e API_KEY=<您的API密钥> \
  -e OKTA_URL=https://<您的组织>.okta.com \
  grafana/okta-logs-collector:latest poll --pollInterval 10s --logLevel info

二进制文件

从 https://github.com/grafana/okta-logs-collector/releases/latest 下载最新版本。解压归档文件并运行二进制文件。

bash
okta-logs-collector --help

从源码构建

要从源码构建应用程序，您需要在机器上安装Go。克隆仓库并运行以下命令：

bash
make build-dev

配置

应用程序需要API密钥以通过Okta API进行身份验证。API密钥可通过--apiKey标志或设置API_KEY环境变量提供。Okta URL可通过--oktaURL标志或设置OKTA_URL环境变量提供。Okta URL的默认值为https://<org>.okta.com，这意味着您需要将<org>替换为您的Okta组织名称。

bash
okta-logs-collector --apiKey <API_KEY> --oktaURL <OKTA_URL> poll

轮询

应用程序每POLL_INTERVAL轮询Okta API以获取新日志。默认值为10s。LOOKBACK_INTERVAL用于轮询更新时回溯时间，默认值为1h0m0s（一小时）。

bash
okta-logs-collector --apiKey <API_KEY> --oktaURL <OKTA_URL> poll --pollInterval 10s --lookbackInterval 1h

日志记录

应用程序将消息记录到stdout。日志级别可通过--logLevel标志设置，默认值为info。

bash
okta-logs-collector --apiKey <API_KEY> --oktaURL <OKTA_URL> poll --logLevel debug

超时

应用程序在REQUEST_TIMEOUT后取消请求，默认值为30s。

bash
okta-logs-collector --apiKey <API_KEY> --oktaURL <OKTA_URL> poll --requestTimeout 30s

示例

有关示例用法，请参见 examples 目录。其中包含运行Loki、Alloy和Promtail的配置文件。提供的配置文件仅用于演示，应根据您的环境进行调整。例如，您需要调整间隔、Loki URL和/或删除echo配置以禁用将日志打印到控制台。

贡献

我们欢迎所有人的贡献。只需提交 https://github.com/grafana/okta-logs-collector/issues 或发送 https://github.com/grafana/okta-logs-collector/pulls%E3%80%82

许可证

Okta日志收集器根据 https://github.com/grafana/okta-logs-collector/blob/main/LICENSE 授权。