Chronograf 配置选项

Chronograf 的配置使用配置文件 (/etc/default/chronograf) 和环境变量。如果您不取消注释某个配置选项，系统将使用其默认设置。本文档中的配置设置已设置为默认设置。有关更多信息，请参见 Configure 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://www.influxdata.com/feed/json

环境变量: $STATUS_FEED_URL

`--version` | `-v`

显示Chronograf服务的版本。

示例:

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

InfluxDB 连接选项

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

仅支持在 .src 文件中配置 InfluxDB 1.x 连接。 通过 CLI 标志或在 Chronograf UI 中配置 InfluxDB 2.x 和 Cloud 连接。

`--influxdb-url`

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

示例: --influxdb-url http://localhost:8086

环境变量: $INFLUXDB_URL

`--influxdb-username`

您的 InfluxDB 实例的 [username]。

环境变量: $INFLUXDB_USERNAME

`--influxdb-password`

您 InfluxDB 实例的 [password]。

环境变量: $INFLUXDB_PASSWORD

`--influxdb-org`

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

环境变量： $INFLUXDB_ORG

`--influxdb-token`

InfluxDB 2.x 或 InfluxDB Cloud authentication token。

环境变量: $INFLUXDB_TOKEN

Kapacitor 连接选项

通过命令行指定的Kapacitor连接详细信息在Chronograf关闭时不会持久化。为了持久化连接详细信息，将其包含在位于你的 --resources-path中的.kap文件中。

`--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端点列表。

命令行示例

## 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的用户名。

环境变量: $ETCD_USERNAME

`--etcd-password=`

用于登录etcd的密码。

环境变量： $ETCD_PASSWORD

`--etcd-dial-timeout=`

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

环境变量: $ETCD_DIAL_TIMEOUT

`--etcd-request-timeout=`

在超时等候视图或更新请求之前的总时间。 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 <显示名称>:<链接地址>`

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

示例: --custom-link InfluxData:http://www.influxdata.com/

`--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=`

访问Chronograf所需的公共URL，使用网页浏览器。例如，如果您使用默认URL访问Chronograf，公共URL值将为 http://localhost:8888。
用于Google OAuth 2.0身份验证。用于Auth0和一些通用OAuth 2.0身份验证提供者。

环境变量: $PUBLIC_URL

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

签名令牌的秘密。

环境变量: $TOKEN_SECRET

GitHub特定的OAuth 2.0认证选项

请参阅 Configuring GitHub authentication 以获取更多信息。

`--github-url`

如果使用Github企业版则需要
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 组织成员资格。

命令行示例

## 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身份验证选项

有关更多信息，请参见 Configuring Google authentication。

`--google-client-id=`

用于OAuth 2.0支持的Google客户端ID值。

环境变量: $GOOGLE_CLIENT_ID

`--google-client-secret=`

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

环境变量: $GOOGLE_CLIENT_SECRET

`--google-domains=`

[可选] 限制授权仅限于指定的 Google 邮件域的用户。

命令行示例

## 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身份验证选项

请参见 Configuring Auth0 authentication 以获取更多信息。

`--auth0-domain=`

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

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

环境变量: $AUTH0_DOMAIN

`--auth0-client-id=`

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

环境变量: $AUTH0_CLIENT_ID

`--auth0-client-secret=`

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

环境变量: $AUTH0_CLIENT_SECRET

`--auth0-organizations=`

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

命令行示例

## 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身份验证选项

有关更多信息，请参见 Configuring Heroku authentication。

`--heroku-client-id=`

支持OAuth 2.0的Heroku客户端ID。

环境变量： $HEROKU_CLIENT_ID

`--heroku-secret=`

Heroku 的 OAuth 2.0 支持的秘密。

环境变量： $HEROKU_SECRET

`--heroku-organization=`

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

命令行示例

## 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 认证选项

有关更多信息，请参见 Configure OAuth 2.0。

`--通用名称=`

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

环境变量: $GENERIC_NAME

`--generic-client-id=`

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

环境变量: $GENERIC_CLIENT_ID

`--通用客户端密钥=`

通用的OAuth 2.0客户端密钥值。

环境变量: $GENERIC_CLIENT_SECRET

`--generic-scopes=`

Web客户端提供者请求的范围。

默认值: user:email

命令行示例

## 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

命令行示例

## 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 服务选项

--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

命令行示例

环境变量示例

--etcd-username=

--etcd-password=

--etcd-dial-timeout=

--etcd-request-timeout=

--etcd-cert=

--etcd-key=

--etcd-root-ca

其他服务选项

--custom-auto-refresh

--custom-link <显示名称>:<链接地址>

--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

命令行示例

环境变量示例

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

--google-client-id=

--google-client-secret=

--google-domains=

命令行示例

环境变量示例

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

--auth0-domain=

--auth0-client-id=

--auth0-client-secret=

--auth0-organizations=

命令行示例

环境变量示例

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

--heroku-client-id=

--heroku-secret=

--heroku-organization=

命令行示例

环境变量示例

通用 OAuth 2.0 认证选项

--通用名称=

--generic-client-id=

--通用客户端密钥=

--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 <显示名称>:<链接地址>`

`--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-client-id=`

`--通用客户端密钥=`

`--generic-scopes=`

`--generic-domains=`

`--generic-auth-url`

`--generic-token-url`

`--generic-api-url`

`--oauth-no-pkce`