文件

指標和日誌設定

此頁面涵蓋控制與 MinIO 指標和日誌相關行為的設定。如需更多資訊,請參閱指標和警示

這些設定會設定將常規的 minio server 日誌和稽核日誌發佈到 HTTP webhook。如需更完整的文件,請參閱將伺服器或稽核日誌發佈到外部服務

您可以透過定義來建立或修改設定

  • 在啟動或重新啟動 MinIO 伺服器之前,在主機系統上設定環境變數。請參閱您作業系統的文件,了解如何定義環境變數。

  • 使用 mc admin config set 使用組態設定

  • 使用MinIO 主控台 管理員 > 設定頁面來使用組態設定

如果您同時定義環境變數和類似的組態設定,MinIO 會使用環境變數值。

某些設定只有環境變數或組態設定,但兩者沒有。

重要

每個組態設定都會控制 MinIO 的基本行為和功能。MinIO 強烈建議在套用到生產環境之前,先在較低的環境(例如開發或品保)中測試組態變更。

Prometheus 驗證

此設定控制 MinIO 如何驗證到 Prometheus。

MINIO_PROMETHEUS_AUTH_TYPE

此設定沒有組態設定選項。

指定 Prometheus 抓取端點的驗證模式。

  • jwt - 預設。MinIO 要求抓取客戶端指定 JWT 令牌以驗證請求。

    使用 mc admin prometheus generate 來產生必要的 JWT 持有者令牌。

  • public - MinIO 不要求抓取客戶端驗證其請求。

伺服器日誌

以下章節說明設定 MinIO 以發佈 minio server 日誌至 HTTP webhook 端點的設定。請參閱 發佈伺服器日誌至 HTTP Webhook 以取得關於使用這些設定的完整文件和教學。

定義多個端點

您可以將多個 webhook 端點指定為日誌目標,方法是為每組相關的日誌環境變數附加一個唯一識別碼 _ID。例如,以下設定定義了兩個不同的伺服器日誌 webhook 端點

export MINIO_LOGGER_WEBHOOK_ENABLE_PRIMARY="on"
export MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_PRIMARY="TOKEN"
export MINIO_LOGGER_WEBHOOK_ENDPOINT_PRIMARY="http://webhook-1.example.net"

export MINIO_LOGGER_WEBHOOK_ENABLE_SECONDARY="on"
export MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_SECONDARY="TOKEN"
export MINIO_LOGGER_WEBHOOK_ENDPOINT_SECONDARY="http://webhook-2.example.net"
mc admin config set logger_webhook:primary \
   endpoint="http://webhook-01.example.net" [ARGUMENTS=VALUE ...]

mc admin config set logger_webhook:secondary \
   endpoint="http://webhook-02.example.net" [ARGUMENTS=VALUE ...]

設定

啟用

MINIO_LOGGER_WEBHOOK_ENABLE

指定 "on" 以啟用發佈 minio server 日誌至 HTTP webhook 端點。

需要指定 MINIO_LOGGER_WEBHOOK_ENDPOINT

logger_webhook

用於設定日誌記錄至 HTTP webhook 端點的組態設定的頂層鍵。

端點

必要

MINIO_LOGGER_WEBHOOK_ENDPOINT
logger_webhook endpoint

Webhook 的 HTTP 端點。

驗證令牌

選用

MINIO_LOGGER_WEBHOOK_AUTH_TOKEN

適用於端點的適當類型的驗證令牌。對於不需要驗證的端點,請省略。

為了允許各種令牌類型,MinIO 使用完全依照指定的值建立請求驗證標頭。根據端點的不同,您可能需要包含其他資訊。

例如:對於持有者令牌,請加上 Bearer 前綴

set MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"

請依照端點需求修改值。自訂驗證格式可能如下所示

set MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"

請參閱所需服務的文件以了解更多詳細資訊。

此環境變數對應於 logger_webhook auth_token 組態設定。

logger_webhook auth_token

適用於端點的適當類型的驗證令牌。對於不需要驗證的端點,請省略。

為了允許各種令牌類型,MinIO 使用完全依照指定的值建立請求驗證標頭。根據端點的不同,您可能需要包含其他資訊。

例如:對於持有者令牌,請加上 Bearer 前綴

   mc admin config set myminio logger_webhook   \
      endpoint="https://webhook-1.example.net"  \
      auth_token="Bearer 1a2b3c4f5e"

請依照端點需求修改值。自訂驗證格式可能如下所示

   mc admin config set myminio logger_webhook   \
        endpoint="https://webhook-1.example.net"  \
      auth_token="ServiceXYZ 1a2b3c4f5e"

請參閱所需服務的文件以了解更多詳細資訊。

批次大小

MinIO 版本新增:伺服器 RELEASE.2024-03-10T02-53-48Z

選用

MINIO_LOGGER_WEBHOOK_BATCH_SIZE
logger_webhook batch_size

收集並將指定數量的事件以批次形式傳送到 webhook。如果未設定,MinIO 會針對每個請求傳送一個事件。

用戶端憑證

選用

還需要設定用戶端金鑰

MINIO_LOGGER_WEBHOOK_CLIENT_CERT
logger_webhook client_cert

用於驗證 webhook 日誌記錄器的 mTLS 憑證路徑。

用戶端金鑰

選用

如果您定義了用戶端憑證,則為必要項目。

MINIO_LOGGER_WEBHOOK_CLIENT_KEY
logger_webhook client_key

用於驗證 webhook 日誌記錄器服務的 mTLS 憑證金鑰路徑。

Proxy

選用

MINIO_LOGGER_WEBHOOK_PROXY
logger_webhook proxy

MinIO 版本新增:RELEASE.2023-02-22T18-23-45Z

定義在 MinIO 與外部 webhook 通訊時,用於 webhook 日誌記錄器的 Proxy。

佇列目錄

選用

版本新增:RELEASE.2023-05-18T00-05-36Z。

MINIO_LOGGER_WEBHOOK_QUEUE_DIR
logger_webhook queue_dir

指定目錄路徑,例如 /opt/minio/events,以啟用 MinIO 的未傳遞訊息的持續性事件儲存。MinIO 程序必須對指定的目錄具有讀取、寫入和列表存取權。

當 webhook 服務離線時,MinIO 會將未傳遞的事件儲存在指定的儲存空間中,並在連線恢復時重播儲存的事件。

佇列大小

選用

MINIO_LOGGER_WEBHOOK_QUEUE_SIZE
logger_webhook queue_size

用於日誌記錄器 webhook 目標的佇列大小的整數值。

Webhook 稽核日誌

以下章節說明設定 MinIO 以發佈稽核日誌至 HTTP webhook 端點的環境變數。請參閱 發佈稽核日誌至 HTTP Webhook 以取得關於使用這些環境變數的完整文件和教學。

多個目標

您可以將多個 webhook 端點指定為稽核日誌目標,方法是為每組相關的日誌設定附加一個唯一識別碼 _ID

例如,以下命令設定兩個不同的稽核日誌 webhook 端點

export MINIO_AUDIT_WEBHOOK_ENABLE_PRIMARY="on"
export MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_PRIMARY="TOKEN"
export MINIO_AUDIT_WEBHOOK_ENDPOINT_PRIMARY="http://webhook-1.example.net"
export MINIO_AUDIT_WEBHOOK_CLIENT_CERT_SECONDARY="/tmp/cert.pem"
export MINIO_AUDIT_WEBHOOK_CLIENT_KEY_SECONDARY="/tmp/key.pem"

export MINIO_AUDIT_WEBHOOK_ENABLE_SECONDARY="on"
export MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_SECONDARY="TOKEN"
export MINIO_AUDIT_WEBHOOK_ENDPOINT_SECONDARY="http://webhook-1.example.net"
export MINIO_AUDIT_WEBHOOK_CLIENT_CERT_SECONDARY="/tmp/cert.pem"
export MINIO_AUDIT_WEBHOOK_CLIENT_KEY_SECONDARY="/tmp/key.pem"
audit_webhook

用於定義發佈 MinIO 稽核日誌 的 HTTP webhook 目標的頂層組態鍵。

使用 mc admin config set 來設定或更新 HTTP webhook 目標。以空格 (" ") 分隔的清單形式指定其他選用引數。

mc admin config set audit_webhook \
   endpoint="http://webhook.example.net" [ARGUMENTS=VALUE ...]

您可以透過將 [:name] 附加至頂層鍵,來指定多個 HTTP webhook 目標。例如,以下命令會將兩個不同的 HTTP webhook 目標分別設定為 primarysecondary

mc admin config set audit_webhook:primary \
   endpoint="http://webhook-01.example.net" [ARGUMENTS=VALUE ...]


mc admin config set audit_webhook:secondary \
   endpoint="http://webhook-02.example.net" [ARGUMENTS=VALUE ...]

設定

啟用

MINIO_AUDIT_WEBHOOK_ENABLE

指定 "on" 以啟用發佈稽核日誌至 HTTP webhook 端點。

需要指定 MINIO_AUDIT_WEBHOOK_ENDPOINT

設定稽核 webhook 以啟用它。沒有單獨的 enable 組態設定。

端點

必要

MINIO_AUDIT_WEBHOOK_ENDPOINT
audit_webhook endpoint

Webhook 的 HTTP 端點。

驗證令牌

選用

MINIO_AUDIT_WEBHOOK_AUTH_TOKEN
audit_webhook auth_token

適用於端點的適當類型的驗證令牌。對於不需要驗證的端點,請省略。

為了允許各種令牌類型,MinIO 使用完全依照指定的值建立請求驗證標頭。根據端點的不同,您可能需要包含其他資訊。

例如,對於 Bearer 令牌,請在前面加上 Bearer

set MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"

根據端點需求修改值。

自訂驗證格式可能如下所示

set MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"
mc admin config set myminio audit_webhook       \
         endpoint="http://webhook.example.net"  \
         auth_token="Bearer 1a2b3c4f5e"

根據端點需求修改值。

自訂驗證格式的命令可能如下所示

mc admin config set myminio audit_webhook       \
         endpoint="http://webhook.example.net"  \
         auth_token="ServiceXYZ 1a2b3c4f5e"

請參閱所需服務的文件以了解更多詳細資訊。

批次大小

MinIO 版本新增:伺服器 RELEASE.2024-03-10T02-53-48Z

選用

MINIO_AUDIT_WEBHOOK_BATCH_SIZE
audit_webhook batch_size

收集並將指定數量的事件以批次形式傳送到 webhook。如果未設定,MinIO 會針對每個請求傳送一個事件。

客戶端憑證

選用

MINIO_AUDIT_WEBHOOK_CLIENT_CERT

還需要指定 MINIO_AUDIT_WEBHOOK_CLIENT_KEY

audit_webhook client_cert

還需要指定 client_key

要呈現給 HTTP webhook 的 x.509 客戶端憑證。對於不需要客戶端呈現已知 TLS 憑證的 webhook,請省略此項。

客戶端金鑰

選用

MINIO_AUDIT_WEBHOOK_CLIENT_KEY

還需要指定 MINIO_AUDIT_WEBHOOK_CLIENT_CERT

audit_webhook client_key

需要指定 client_cert

要呈現給 HTTP webhook 的 x.509 私人金鑰。對於不需要客戶端呈現已知 TLS 憑證的 webhook,請省略此項。

佇列目錄

選用

MINIO_AUDIT_WEBHOOK_QUEUE_DIR
audit_webhook queue_dir

版本新增:RELEASE.2023-05-18T00-05-36Z。

指定目錄路徑,例如 /opt/minio/events,以啟用 MinIO 的未傳遞訊息的持續性事件儲存。MinIO 程序必須對指定的目錄具有讀取、寫入和列表存取權。

當 webhook 服務離線時,MinIO 會將未傳遞的事件儲存在指定的儲存空間中,並在連線恢復時重播儲存的事件。

佇列大小

選用

MINIO_AUDIT_WEBHOOK_QUEUE_SIZE
audit_webhook queue_size

用於稽核 webhook 目標的佇列大小的整數值。預設值為 100000 個事件。

Kafka 稽核日誌

以下章節說明用於設定 MinIO 以將稽核日誌發佈到 Kafka 代理的環境變數。

audit_kafka

用於定義發佈 MinIO 稽核日誌 的 Kafka 代理目標的頂層設定金鑰。

使用 mc admin config set 設定或更新 Kafka 稽核目標。將其他選用引數指定為以空格 (" ") 分隔的清單。

mc admin config set audit_kafka \
   brokers="https://kafka-endpoint.example.net:9092" [ARGUMENTS=VALUE ...]

設定

啟用

必要

MINIO_AUDIT_KAFKA_ENABLE

設定為 "on" 以啟用目標。

設定為 "off" 以停用目標。

此值沒有設定配置。使用環境變數停用已設定的稽核 webhook 目標。

代理

必要

MINIO_AUDIT_KAFKA_BROKERS
audit_kafka brokers

以逗號分隔的 Kafka 代理位址清單

brokers="https://kafka-1.example.net:9092,https://kafka-2.example.net:9092"

至少一個代理必須在線上且可由 MinIO 伺服器連線,才能初始化並傳送稽核日誌事件。MinIO 會依規格順序檢查每個指定的代理。

主題

必要

MINIO_AUDIT_KAFKA_TOPIC
audit_kafka topic

要與 MinIO 稽核日誌事件關聯的 Kafka 主題名稱。

TLS

選用

MINIO_AUDIT_KAFKA_TLS
audit_kafka tls

設定為 "on" 以啟用與指定 Kafka 代理的 TLS 連線能力。

預設為 "off"

TLS 跳過驗證

選用

MINIO_AUDIT_KAFKA_TLS_SKIP_VERIFY
audit_kafka tls_skip_verify

設定為 "on" 以指示 MinIO 跳過 Kafka 代理 TLS 憑證的驗證。

您可以使用此選項來啟用與使用未知方 (例如自我簽署或公司內部憑證授權單位 (CA)) 簽署的 TLS 憑證的 Kafka 代理的連線能力。

MinIO 預設會使用系統信任存放區 *和* MinIO CA 目錄 的內容來驗證遠端客戶端 TLS 憑證。

預設值為 "off",以嚴格驗證 TLS 憑證。

SASL

選用

MINIO_AUDIT_KAFKA_SASL

需要指定 MINIO_AUDIT_KAFKA_SASL_USERNAMEMINIO_AUDIT_KAFKA_SASL_PASSWORD

audit_kafka sasl

需要指定 sasl_usernamesasl_password

設定為 "on" 以指示 MinIO 使用 SASL 向 Kafka 代理進行驗證。

SASL 使用者名稱

選用

MINIO_AUDIT_KAFKA_SASL_USERNAME

需要指定 MINIO_AUDIT_KAFKA_SASLMINIO_AUDIT_KAFKA_SASL_PASSWORD

audit_kafka sasl_username

需要指定 saslsasl_password

MinIO 用於向 Kafka 代理進行驗證的 SASL 使用者名稱。

SASL 密碼

選用

MINIO_AUDIT_KAFKA_SASL_PASSWORD

需要指定 MINIO_AUDIT_KAFKA_SASLMINIO_AUDIT_KAFKA_SASL_USERNAME

audit_kafka sasl_password

需要指定 saslsasl_username

MinIO 用於向 Kafka brokers 進行身份驗證的 SASL 密碼。

SASL 機制

選用

MINIO_AUDIT_KAFKA_SASL_MECHANISM

重要

PLAIN 身份驗證機制會以純文字形式透過網路傳送憑證。請使用 MINIO_AUDIT_KAFKA_TLS 來啟用與 Kafka brokers 的 TLS 連線,並確保 SASL 憑證的安全傳輸。

audit_kafka sasl_mechanism

重要

PLAIN 身份驗證機制會以純文字形式透過網路傳送憑證。請使用 tls 來啟用與 Kafka brokers 的 TLS 連線,並確保 SASL 憑證的安全傳輸。

MinIO 用於向 Kafka brokers 進行身份驗證的 SASL 機制。

預設為 plain

TLS 用戶端驗證

選用

MINIO_AUDIT_KAFKA_TLS_CLIENT_AUTH

需要指定 MINIO_AUDIT_KAFKA_CLIENT_TLS_CERTMINIO_AUDIT_KAFKA_CLIENT_TLS_KEY

audit_kafka tls_client_auth

需要指定 client_tls_certclient_tls_key

設定為 "on" 以指示 MinIO 使用 mTLS 向 Kafka brokers 進行身份驗證。

用戶端 TLS 憑證

選用

MINIO_AUDIT_KAFKA_CLIENT_TLS_CERT
audit_kafka client_tls_cert

用於 mTLS 驗證的 TLS 用戶端憑證路徑。

用戶端 TLS 金鑰

選用

MINIO_AUDIT_KAFKA_CLIENT_TLS_KEY
audit_kafka client_tls_key

用於 mTLS 驗證的 TLS 用戶端私密金鑰路徑。

版本

選用

MINIO_AUDIT_KAFKA_VERSION
audit_kafka version

MinIO 在指定端點預期的 Kafka broker 版本。

如果 Kafka broker 版本與此設定中指定的版本不符,MinIO 會傳回錯誤。

註解

選用

MINIO_AUDIT_KAFKA_COMMENT
audit_kafka comment

與組態相關聯的註解。

佇列目錄

選用

MINIO_AUDIT_KAFKA_QUEUE_DIR
audit_kafka queue_dir

指定目錄路徑以啟用 MinIO 對未傳遞訊息的持久性事件儲存,例如 /opt/minio/events

MinIO 會將未傳遞的事件儲存在指定的儲存區中,在 Kafka 服務離線時,並在連線恢復時重新播放儲存的事件。

佇列大小

選用

MINIO_AUDIT_KAFKA_QUEUE_SIZE
audit_kafka queue_size

指定未傳遞訊息的最大限制。預設為 100000