Chronograf 配置选项

Chronograf 使用配置文件 (/etc/default/chronograf) 和环境变量进行配置。如果您不对配置选项取消注释，系统将使用其默认设置。本文档中的配置设置设置为其默认设置。有关更多信息，请参阅配置 Chronograf。

用法
Chronograf 服务选项
身份验证选项

用法

启动 Chronograf 服务，并在 chronograf 之后包含任何选项，其中 [OPTIONS] 是以空格分隔的选项

chronograf [OPTIONS]

Linux 示例

启动没有选项的 chronograf

sudo systemctl start chronograf

启动 chronograf 并设置开发模式和禁用报告的选项

sudo systemctl start chronograf --develop --reporting-disabled

MacOS X 示例

启动没有选项的 chronograf

chronograf

启动 chronograf 并为开发模式和禁用报告添加快捷选项

chronograf -d -r

注意： 命令行选项优先于相应的环境变量。

Chronograf 服务选项

`--host=`

chronograf 服务监听的 IP。

默认值：0.0.0.0

示例：--host=0.0.0.0

环境变量：$HOST

`--port=`

chronograf 服务监听不安全连接的端口。

默认值：8888

环境变量：$PORT

`--bolt-path=` | `-b`

BoltDB 文件的文件路径。

默认值：./chronograf-v1.db

环境变量：$BOLT_PATH

`--canned-path=` | `-c`

预置仪表板文件目录的路径。预置仪表板（也称为预创建的仪表板或应用程序布局）无法编辑。它们随 Chronograf 一起交付，并根据您启用的 Telegraf 输入插件提供。

默认值：/usr/share/chronograf/canned

环境变量：$CANNED_PATH

`--resources-path=`

源文件 (.src 文件)、Kapacitor 连接文件 (.kap 文件)、组织文件 (.org 文件) 和仪表板文件 (.dashboard 文件) 目录的路径。

注意： 如果您的仪表板具有 .json 扩展名，请在此目录中将其重命名为 .dashboard 扩展名，以确保加载仪表板。

默认值：/usr/share/chronograf/resources

环境变量：$RESOURCES_PATH

`--basepath=` | `-p`

所有 chronograf 路由将挂载在其下的 URL 路径前缀。

环境变量：$BASE_PATH

`--status-feed-url=`

JSON 订阅源的 URL，用于在客户端状态页面上显示为新闻订阅源。

默认值：https://influxdb.org.cn/feed/json

环境变量：$STATUS_FEED_URL

`--version` | `-v`

显示 Chronograf 服务的版本。

示例

$ chronograf -v
2018/01/03 14:11:19 Chronograf 1.10.6 (git: b74ae387)

InfluxDB 连接选项

通过命令行在启动 Chronograf 时指定的 InfluxDB 连接详细信息在 Chronograf 关闭时不会持久保留。要持久保留连接详细信息，请将它们包含在 .src 文件中，该文件位于您的--resources-path中。

只有 InfluxDB 1.x 连接可以在 .src 文件中配置。 使用 CLI 标志或 Chronograf UI 配置 InfluxDB 2.x 和 Cloud 连接。

`--influxdb-url`

您的 InfluxDB 实例的位置，包括协议、IP 地址和端口。

示例：--influxdb-url https://127.0.0.1:8086

环境变量：$INFLUXDB_URL

`--influxdb-username`

您的 InfluxDB 实例的[用户名]。

环境变量：$INFLUXDB_USERNAME

`--influxdb-password`

您的 InfluxDB 实例的[密码]。

环境变量：$INFLUXDB_PASSWORD

`--influxdb-org`

InfluxDB 2.x 或 InfluxDB Cloud 组织名称。

环境变量：$INFLUXDB_ORG

`--influxdb-token`

InfluxDB 2.x 或 InfluxDB Cloud 身份验证令牌。

环境变量：$INFLUXDB_TOKEN

Kapacitor 连接选项

通过命令行在启动 Chronograf 时指定的 Kapacitor 连接详细信息在 Chronograf 关闭时不会持久保留。要持久保留连接详细信息，请将它们包含在 .kap 文件中，该文件位于您的--resources-path中。

`--kapacitor-url=`

您的 Kapacitor 实例的位置，包括 http://、IP 地址和端口。

示例：--kapacitor-url=http://0.0.0.0:9092。

环境变量：$KAPACITOR_URL

`--kapacitor-username=`

您的 Kapacitor 实例的用户名。

环境变量：$KAPACITOR_USERNAME

`--kapacitor-password=`

您的 Kapacitor 实例的密码。

环境变量：$KAPACITOR_PASSWORD

TLS（传输层安全）选项

有关更多信息，请参阅配置 TLS（传输层安全）和 HTTPS。

`--cert=`

PEM 编码的公钥证书的文件路径。

环境变量：$TLS_CERTIFICATE

`--key=`

与给定证书关联的私钥的文件路径。

环境变量：$TLS_PRIVATE_KEY

etcd 选项

`--etcd-endpoints=` | `-e`

etcd 端点列表。

CLI 示例

## Single parameter
--etcd-endpoints=localhost:2379

## Multiple parameters
--etcd-endpoints=localhost:2379 \
--etcd-endpoints=192.168.1.61:2379 \
--etcd-endpoints=192.192.168.1.100:2379

环境变量：$ETCD_ENDPOINTS

环境变量示例

## Single parameter
ETCD_ENDPOINTS=localhost:2379

## Multiple parameters
ETCD_ENDPOINTS=localhost:2379,192.168.1.61:2379,192.192.168.1.100:2379

`--etcd-username=`

环境变量：$ETCD_USERNAME

`--etcd-password=`

环境变量：$ETCD_PASSWORD

`--etcd-dial-timeout=`

连接到 etcd 端点时，在超时之前等待的总时间。0 表示没有超时。默认值为 1 秒。

环境变量：$ETCD_DIAL_TIMEOUT

`--etcd-request-timeout=`

超时 etcd 视图或更新请求之前等待的总时间。0 表示没有超时。默认值为 1 秒。

环境变量：$ETCD_REQUEST_TIMEOUT

`--etcd-cert=`

etcd PEM 编码的 TLS 公钥证书的路径。

环境变量：$ETCD_CERTIFICATE

`--etcd-key=`

与指定的 etcd 证书关联的私钥的路径。

环境变量：$ETCD_PRIVATE_KEY

`--etcd-root-ca`

用于 TLS 验证的根 CA 证书的路径。

环境变量：$ETCD_ROOT_CA

其他服务选项

`--custom-auto-refresh`

将自定义自动刷新间隔添加到 Chronograf 仪表板中可用的自动刷新间隔列表。提供以分号分隔的键值对列表，其中键是在自动刷新下拉菜单中显示的间隔名称，值是以毫秒为单位的自动刷新间隔。

示例：--custom-auto-refresh "500ms=500;1s=1000"

环境变量：$CUSTOM_AUTO_REFRESH

`--custom-link <display_name>:<link_address>`

添加到 Chronograf 用户菜单选项的自定义链接。对于为 Chronograf 用户提供内部公司资源的链接很有用。当启用任何 OAuth 2.0 身份验证时可以使用。要添加另一个自定义链接，请重复自定义链接选项。

示例：--custom-link InfluxData:https://influxdb.org.cn/

`--develop` | `-d`

在开发人员模式下运行 chronograf 服务。

`--help` | `-h`

显示 chronograf 的命令行帮助。

`--host-page-disabled` | `-H`

禁用主机列表页面 (/sources/$sourceId/hosts) 的渲染和服务。

环境变量：$HOST_PAGE_DISABLED

`--log-level=` | `-l`

设置日志级别。

有效值：debug | info | error

默认值：info

示例：--log-level=debug

环境变量：$LOG_LEVEL

`--reporting-disabled` | `-r`

禁用使用情况统计信息的报告。每 24 小时报告一次的使用情况统计信息包括：OS、arch、version、cluster_id 和 uptime。

环境变量：$REPORTING_DISABLED

身份验证选项

通用身份验证选项

`--auth-duration=`

身份验证的 cookie 生存期的总持续时间（以小时为单位）。

默认值：720h

当 --auth-duration=0 时，身份验证在浏览器关闭时过期。

环境变量：$AUTH_DURATION

`--inactivity-duration=`

令牌在没有任何新活动的情况下有效的持续时间。

默认值：5m

环境变量：$INACTIVITY_DURATION

`--public-url=`

使用 Web 浏览器访问 Chronograf 所需的公共 URL。例如，如果您使用默认 URL 访问 Chronograf，则公共 URL 值将为 https://127.0.0.1:8888。Google OAuth 2.0 身份验证必需。用于 Auth0 和某些通用 OAuth 2.0 身份验证提供程序。

环境变量：$PUBLIC_URL

`--token-secret=` | `-t`

用于签署令牌的密钥。

环境变量：$TOKEN_SECRET

GitHub 特定的 OAuth 2.0 身份验证选项

有关更多信息，请参阅配置 GitHub 身份验证。

`--github-url`

如果使用 Github Enterprise，则为必需
GitHub 基本 URL。默认为 https://github.com。

环境变量：$GH_URL

`--github-client-id` | `-i`

OAuth 2.0 支持的 GitHub 客户端 ID 值。

环境变量：$GH_CLIENT_ID

`--github-client-secret` | `-s`

OAuth 2.0 支持的 GitHub 客户端密钥值。

环境变量：$GH_CLIENT_SECRET

`--github-organization` | `-o`

[可选] 指定用户所需的 GitHub 组织成员资格。

CLI 示例

## Single parameter
--github-organization=org1

## Multiple parameters
--github-organization=org1 \
--github-organization=org2 \
--github-organization=org3

环境变量：$GH_ORGS

环境变量示例

## Single parameter
GH_ORGS=org1

## Multiple parameters
GH_ORGS=org1,org2,org3

Google 特定的 OAuth 2.0 身份验证选项

有关更多信息，请参阅配置 Google 身份验证。

`--google-client-id=`

OAuth 2.0 支持所需的 Google 客户端 ID 值。

环境变量：$GOOGLE_CLIENT_ID

`--google-client-secret=`

OAuth 2.0 支持所需的 Google 客户端密钥值。

环境变量：$GOOGLE_CLIENT_SECRET

`--google-domains=`

[可选] 将授权限制为来自指定 Google 电子邮件域的用户。

CLI 示例

## Single parameter
--google-domains=delorean.com

## Multiple parameters
--google-domains=delorean.com \
--google-domains=savetheclocktower.com

环境变量：$GOOGLE_DOMAINS

环境变量示例

## Single parameter
GOOGLE_DOMAINS=delorean.com

## Multiple parameters
GOOGLE_DOMAINS=delorean.com,savetheclocktower.com

Auth0 特定的 OAuth 2.0 身份验证选项

有关更多信息，请参阅配置 Auth0 身份验证。

`--auth0-domain=`

您的 Auth0 客户端的子域；在您的 Auth0 客户端的配置页面上可用。

示例：https://myauth0client.auth0.com

环境变量：$AUTH0_DOMAIN

`--auth0-client-id=`

OAuth 2.0 支持所需的 Auth0 客户端 ID 值。

环境变量：$AUTH0_CLIENT_ID

`--auth0-client-secret=`

OAuth 2.0 支持所需的 Auth0 客户端密钥值。

环境变量：$AUTH0_CLIENT_SECRET

`--auth0-organizations=`

[可选] 访问 Chronograf 所需的 Auth0 组织成员资格。组织使用用户 app_metadata 中的“organization”键设置。列表以逗号分隔，并且仅在使用环境变量时可用。

CLI 示例

## Single parameter
--auth0-organizations=org1

## Multiple parameters
--auth0-organizations=org1 \
--auth0-organizations=org2 \
--auth0-organizations=org3

环境变量：$AUTH0_ORGS

环境变量示例

## Single parameter
AUTH0_ORGS=org1

## Multiple parameters
AUTH0_ORGS=org1,org2,org3

Heroku 特定的 OAuth 2.0 身份验证选项

有关更多信息，请参阅配置 Heroku 身份验证。

`--heroku-client-id=`

OAuth 2.0 支持的 Heroku 客户端 ID。

环境变量： $HEROKU_CLIENT_ID

`--heroku-secret=`

OAuth 2.0 支持的 Heroku 密钥。

环境变量： $HEROKU_SECRET

`--heroku-organization=`

访问 Chronograf 所需的 Heroku 组织成员资格。

CLI 示例

## Single parameter
--heroku-organization=org1

## Multiple parameters
--heroku-organization=org1 \
--heroku-organization=org2 \
--heroku-organization=org3

环境变量： $HEROKU_ORGS

环境变量示例

## Single parameter
HEROKU_ORGS=org1

## Multiple parameters
HEROKU_ORGS=org1,org2,org3

通用 OAuth 2.0 身份验证选项

有关更多信息，请参阅配置 OAuth 2.0。

`--generic-name=`

登录页面上显示的通用 OAuth 2.0 名称。

环境变量：$GENERIC_NAME

`--generic-client-id=`

通用 OAuth 2.0 客户端 ID 值。可以用于自定义 OAuth 2.0 服务。

环境变量：$GENERIC_CLIENT_ID

`--generic-client-secret=`

通用 OAuth 2.0 客户端密钥值。

环境变量：$GENERIC_CLIENT_SECRET

`--generic-scopes=`

Web 客户端提供程序请求的作用域。

默认值：user:email

CLI 示例

## Single parameter
--generic-scopes=api

## Multiple parameters
--generic-scopes=api \
--generic-scopes=openid \
--generic-scopes=read_user

环境变量：$GENERIC_SCOPES

环境变量示例

## Single parameter
GENERIC_SCOPES=api

## Multiple parameters
GENERIC_SCOPES=api,openid,read_user

`--generic-domains=`

用户电子邮件地址所需的电子邮件域。

示例：--generic-domains=example.com

CLI 示例

## Single parameter
--generic-domains=delorean.com

## Multiple parameters
--generic-domains=delorean.com \
--generic-domains=savetheclocktower.com

环境变量：$GENERIC_DOMAINS

环境变量示例

## Single parameter
GENERIC_DOMAINS=delorean.com

## Multiple parameters
GENERIC_DOMAINS=delorean.com,savetheclocktower.com

`--generic-auth-url`

OAuth 2.0 提供程序的授权端点 URL。

环境变量：$GENERIC_AUTH_URL

`--generic-token-url`

OAuth 2.0 提供程序的令牌端点 URL。

环境变量：$GENERIC_TOKEN_URL

`--generic-api-url`

返回 OpenID UserInfo 兼容信息的 URL。

环境变量：$GENERIC_API_URL

`--oauth-no-pkce`

禁用 OAuth PKCE（代码交换的证明密钥）。

环境变量：$OAUTH_NO_PKCE

此页是否对您有帮助？

感谢您的反馈！

支持和反馈

感谢您成为我们社区的一份子！我们欢迎并鼓励您提供关于 Chronograf 和本文档的反馈和错误报告。要获得支持，请使用以下资源

编辑此页提交文档问题提交 Chronograf 问题

Chronograf 配置选项

用法

Chronograf 服务选项

--host=

--port=

--bolt-path= | -b

--canned-path= | -c

--resources-path=

--basepath= | -p

--status-feed-url=

--version | -v

InfluxDB 连接选项

--influxdb-url

--influxdb-username

--influxdb-password

--influxdb-org

--influxdb-token

Kapacitor 连接选项

--kapacitor-url=

--kapacitor-username=

--kapacitor-password=

TLS（传输层安全）选项

--cert=

--key=

etcd 选项

--etcd-endpoints= | -e

CLI 示例

环境变量示例

--etcd-username=

--etcd-password=

--etcd-dial-timeout=

--etcd-request-timeout=

--etcd-cert=

--etcd-key=

--etcd-root-ca

其他服务选项

--custom-auto-refresh

--custom-link <display_name>:<link_address>

--develop | -d

--help | -h

--host-page-disabled | -H

--log-level= | -l

--reporting-disabled | -r

身份验证选项

通用身份验证选项

--auth-duration=

--inactivity-duration=

--public-url=

--token-secret= | -t

GitHub 特定的 OAuth 2.0 身份验证选项

--github-url

--github-client-id | -i

--github-client-secret | -s

--github-organization | -o

CLI 示例

环境变量示例

Google 特定的 OAuth 2.0 身份验证选项

--google-client-id=

--google-client-secret=

--google-domains=

CLI 示例

环境变量示例

Auth0 特定的 OAuth 2.0 身份验证选项

--auth0-domain=

--auth0-client-id=

--auth0-client-secret=

--auth0-organizations=

CLI 示例

环境变量示例

Heroku 特定的 OAuth 2.0 身份验证选项

--heroku-client-id=

--heroku-secret=

--heroku-organization=

CLI 示例

环境变量示例

通用 OAuth 2.0 身份验证选项

--generic-name=

--generic-client-id=

--generic-client-secret=

--generic-scopes=

`--host=`

`--port=`

`--bolt-path=` | `-b`

`--canned-path=` | `-c`

`--resources-path=`

`--basepath=` | `-p`

`--status-feed-url=`

`--version` | `-v`

`--influxdb-url`

`--influxdb-username`

`--influxdb-password`

`--influxdb-org`

`--influxdb-token`

`--kapacitor-url=`

`--kapacitor-username=`

`--kapacitor-password=`

`--cert=`

`--key=`

`--etcd-endpoints=` | `-e`

`--etcd-username=`

`--etcd-password=`

`--etcd-dial-timeout=`

`--etcd-request-timeout=`

`--etcd-cert=`

`--etcd-key=`

`--etcd-root-ca`

`--custom-auto-refresh`

`--custom-link <display_name>:<link_address>`

`--develop` | `-d`

`--help` | `-h`

`--host-page-disabled` | `-H`

`--log-level=` | `-l`

`--reporting-disabled` | `-r`

`--auth-duration=`

`--inactivity-duration=`

`--public-url=`

`--token-secret=` | `-t`

`--github-url`

`--github-client-id` | `-i`

`--github-client-secret` | `-s`

`--github-organization` | `-o`

`--google-client-id=`

`--google-client-secret=`

`--google-domains=`

`--auth0-domain=`

`--auth0-client-id=`

`--auth0-client-secret=`

`--auth0-organizations=`

`--heroku-client-id=`

`--heroku-secret=`

`--heroku-organization=`

`--generic-name=`

`--generic-client-id=`

`--generic-client-secret=`

`--generic-scopes=`

`--generic-domains=`

`--generic-auth-url`

`--generic-token-url`

`--generic-api-url`

`--oauth-no-pkce`