​

Configuring BlackHole

​

Dynamic settings

​

Static settings

​

Chỉ định cài đặt cấu hình khi khởi động

​

Flags at startup

./blackhole -Ecluster.name=blackhole-cluster -Enode.name=blackhole-node1 -Ehttp.host=0.0.0.0 -Ediscovery.type=single-node

​

Directly in the shell environment

export BLACKHOLE_JAVA_OPTS="-Xms2g -Xmx2g"
export BLACKHOLE_PATH_CONF="/etc/blackhole"
./blackhole

​

Systemd service file

# /etc/systemd/system/blackhole.service.d/override.conf
[Service]
Environment="BLACKHOLE_JAVA_OPTS=-Xms2g -Xmx2g"
Environment="BLACKHOLE_PATH_CONF=/etc/blackhole"

sudo systemctl daemon-reload
sudo systemctl restart blackhole

​

Docker environment variables

docker run -e "BLACKHOLE_JAVA_OPTS=-Xms2g -Xmx2g" -e "BLACKHOLE_PATH_CONF=/usr/share/blackhole/config" ghcr.io/gcsclabs/blackhole-backend:latest

​

Updating cluster settings using the API

GET _cluster/settings?include_defaults=true

GET _cluster/settings

1. Transient settings
2. Persistent settings
3. Settings from blackhole.yml
4. Default settings

PUT _cluster/settings
{
  "persistent": {
    "action.auto_create_index": false
  }
}

PUT _cluster/settings
{
  "persistent": {
    "action": {
      "auto_create_index": false
    }
  }
}

​

Configuration file

cluster.name: my-application
action.auto_create_index: true
compatibility.override_main_response_version: true

​

(Optional) Cấu hình tiêu đề CORS

http.host: 0.0.0.0
http.port: 9200
http.cors.allow-origin: "http://localhost"
http.cors.enabled: true
http.cors.allow-headers: X-Requested-With,X-Auth-Token,Content-Type,Content-Length,Authorization
http.cors.allow-credentials: true

​

Cấu hình và cài đặt hệ thống

​

Network settings

​

Cài đặt mạng nâng cao

​

General TCP settings

​

Advanced HTTP settings

​

HTTP CORS settings

​

HTTP error handling settings

​

HTTP debugging settings

​

Advanced transport settings

​

Transport debugging settings

​

Transport profile settings

​

Advanced transport settings (continued)

​

Selecting the transport

​

Discovery and gateway settings

​

Discovery settings

​

Static discovery settings

​

Dynamic discovery settings

​

Cluster election settings

​

Expert-level discovery settings

​

Gateway settings

​

Security settings

​

Common settings

​

REST management API settings

​

Advanced settings

​

Expert-level settings

​

Audit log settings

​

Hostname verification and DNS lookup settings

​

Client authentication settings

​

Enabled cipher and protocol settings

​

Key store and trust store files—transport layer TLS settings

​

Key store and trust store files—REST layer TLS settings

​

X.509 PEM certificates and PKCS #8 keys—transport layer TLS settings

​

X.509 PEM certificates and PKCS #8 keys—REST layer TLS settings

​

Transport layer security settings

​

Security plugin settings examples

# Common configuration settings
plugins.security.nodes_dn:
  - "CN=*.example.com, OU=SSL, O=Test, L=Test, C=DE"
  - "CN=node.other.com, OU=SSL, O=Test, L=Test, C=DE"
  - "CN=node.example.com, OU=SSL\\, Inc., L=Test, C=DE"  # escape additional comma with `\\`

plugins.security.authcz.admin_dn:
  - CN=kirk,OU=client,O=client,L=test,C=de

plugins.security.roles_mapping_resolution: MAPPING_ONLY
plugins.security.ssl.transport.pemcert_filepath: esnode.pem
plugins.security.ssl.transport.pemkey_filepath: esnode-key.pem
plugins.security.ssl.transport.pemtrustedcas_filepath: root-ca.pem
transport.ssl.enforce_hostname_verification: false
plugins.security.ssl.http.enabled: true
plugins.security.ssl.http.pemcert_filepath: esnode.pem
plugins.security.ssl.http.pemkey_filepath: esnode-key.pem
plugins.security.ssl.http.pemtrustedcas_filepath: root-ca.pem
plugins.security.allow_unsafe_democertificates: true
plugins.security.allow_default_init_securityindex: true
plugins.security.nodes_dn_dynamic_config_enabled: false
plugins.security.audit.type: internal_blackhole
plugins.security.enable_snapshot_restore_privilege: true
plugins.security.check_snapshot_restore_write_privileges: true
plugins.security.cache.ttl_minutes: 60
plugins.security.restapi.roles_enabled: ["all_access", "security_rest_api_access"]
plugins.security.system_indices.enabled: true
plugins.security.system_indices.indices:
  - ".opendistro-alerting-config"
  - ".opendistro-alerting-alert*"
  - ".opendistro-anomaly-results*"
  - ".opendistro-anomaly-detector*"
  - ".opendistro-anomaly-checkpoints"
  - ".opendistro-anomaly-detection-state"
  - ".opendistro-reports-*"
  - ".opendistro-notifications-*"
  - ".opendistro-notebooks"
  - ".opendistro-asynchronous-search-response*"

node.max_local_storage_nodes: 3
plugins.security.restapi.password_validation_regex: '(?=.*[A-Z])(?=.*[^a-zA-Z\d])(?=.*[0-9])(?=.*[a-z]).{8,}'
plugins.security.restapi.password_validation_error_message: >
  Password must be minimum 8 characters long and must contain at least
  one uppercase letter, one lowercase letter, one digit, and one special character.

# REST Management API configuration settings
plugins.security.restapi.roles_enabled: ["all_access", "xyz_role"]
plugins.security.restapi.endpoints_disabled.all_access.ACTIONGROUPS: ["PUT", "POST", "DELETE"]

# Audit log configuration settings
plugins.security.audit.enable_rest: true
plugins.security.audit.enable_transport: false
plugins.security.audit.resolve_bulk_requests: false
plugins.security.audit.config.disabled_categories: ["AUTHENTICATED", "GRANTED_PRIVILEGES"]
plugins.security.audit.ignore_requests: ["indices:data/read/*", "*_bulk"]
plugins.security.audit.threadpool.size: 10
plugins.security.audit.threadpool.max_queue_len: 100000
plugins.security.audit.ignore_users: ['kibanaserver', 'some*user', '/also.*regex possible/']
plugins.security.audit.type: internal_blackhole

# external_blackhole settings
plugins.security.audit.config.http_endpoints: ['localhost:9200', 'localhost:9201', 'localhost:9202']
plugins.security.audit.config.index: "'auditlog6-'YYYY.MM.dd"
plugins.security.audit.config.type: auditlog
plugins.security.audit.config.username: auditloguser
plugins.security.audit.config.password: auditlogpassword
plugins.security.audit.config.enable_ssl: false
plugins.security.audit.config.verify_hostnames: false
plugins.security.audit.config.enable_ssl_client_auth: false
plugins.security.audit.config.cert_alias: mycert
plugins.security.audit.config.pemkey_filepath: key.pem
plugins.security.audit.config.pemkey_content: <...pem base 64 content>
plugins.security.audit.config.pemkey_password: secret
plugins.security.audit.config.pemcert_filepath: cert.pem
plugins.security.audit.config.pemcert_content: <...pem base 64 content>
plugins.security.audit.config.pemtrustedcas_filepath: ca.pem
plugins.security.audit.config.pemtrustedcas_content: <...pem base 64 content>

# Webhook settings
plugins.security.audit.config.webhook.url: "http://mywebhook/endpoint"
plugins.security.audit.config.webhook.format: JSON
plugins.security.audit.config.webhook.ssl.verify: false
plugins.security.audit.config.webhook.ssl.pemtrustedcas_filepath: ca.pem
plugins.security.audit.config.webhook.ssl.pemtrustedcas_content: <...pem base 64 content>

# log4j settings
plugins.security.audit.config.log4j.logger_name: auditlogger
plugins.security.audit.config.log4j.level: INFO

# Advanced configuration settings
plugins.security.authcz.impersonation_dn:
  "CN=spock,OU=client,O=client,L=Test,C=DE":
    - worf
  "cn=webuser,ou=IT,ou=IT,dc=company,dc=com":
    - user2
    - user1

plugins.security.authcz.rest_impersonation_user:
  "picard":
    - worf
  "john":
    - steve
    - martin

plugins.security.allow_default_init_securityindex: false
plugins.security.allow_unsafe_democertificates: false
plugins.security.restapi.password_min_length: 8
plugins.security.restapi.password_score_based_validation_strength: very_strong

# Advanced SSL settings - use only if you understand SSL ins and outs
plugins.security.ssl.transport.client.pemkey_password: superSecurePassword1
plugins.security.ssl.transport.keystore_keypassword: superSecurePassword2
plugins.security.ssl.transport.server.keystore_keypassword: superSecurePassword3
plugins.security.ssl.http.keystore_keypassword: superSecurePassword4
plugins.security.ssl.http.clientauth_mode: REQUIRE
plugins.security.ssl.transport.enabled: true
plugins.security.ssl.transport.server.keystore_alias: my_alias
plugins.security.ssl.transport.client.keystore_alias: my_other_alias
plugins.security.ssl.transport.server.truststore_alias: trustore_alias_1
plugins.security.ssl.transport.client.truststore_alias: trustore_alias_2
plugins.security.ssl.client.external_context_id: my_context_id
plugins.security.ssl.transport.principal_extractor_class: org.blackhole.security.ssl.ExampleExtractor
plugins.security.ssl.http.crl.file_path: ssl/crl/revoked.crl
plugins.security.ssl.http.crl.validate: true
plugins.security.ssl.http.crl.prefer_crlfile_over_ocsp: true
plugins.security.ssl.http.crl.check_only_end_entities: false
plugins.security.ssl.http.crl.disable_ocsp: true
plugins.security.ssl.http.crl.disable_crldp: true
plugins.security.ssl.allow_client_initiated_renegotiation: true

# Expert settings - use only if you understand their use completely
plugins.security.config_index_name: .opendistro_security
plugins.security.cert.oid: '1.2.3.4.5.5'
plugins.security.cert.intercluster_request_evaluator_class: org.blackhole.security.transport.DefaultInterClusterRequestEvaluator
plugins.security.disabled: false
plugins.security.protected_indices.enabled: true
plugins.security.protected_indices.roles: ['all_access']
plugins.security.protected_indices.indices: []
plugins.security.system_indices.indices:
  - '.opendistro-alerting-config'
  - '.opendistro-ism-*'
  - '.opendistro-reports-*'
  - '.blackhole-notifications-*'
  - '.blackhole-notebooks'
  - '.blackhole-observability'
  - '.opendistro-asynchronous-search-response*'
  - '.replication-metadata-store'

​

Cluster settings

​

Cluster-level routing and allocation settings

• PRIMARY_FIRST - Primary shards được di dời trước, trước các phân đoạn bản sao. Việc ưu tiên này có thể giúp ngăn tình trạng sức khỏe của cụm chuyển sang màu đỏ nếu các nút di dời bị lỗi trong quá trình này.
• REPLICA_FIRST - Các mảnh bản sao được di dời trước, trước các mảnh chính. Việc ưu tiên này có thể giúp ngăn tình trạng sức khỏe của cụm chuyển sang màu đỏ khi thực hiện di dời mảnh trong cụm BlackHole phiên bản hỗn hợp, hỗ trợ sao chép phân đoạn.
• NO_PREFERENCE - Hành vi mặc định trong đó thứ tự di chuyển phân đoạn không quan trọng.

​

Cluster-level shard, block, and task settings

​

Cluster-level search settings

​

Cluster-level slow log settings

​

Cluster-level index settings

​

Cluster-level coordination settings

​

Cluster-level fault detection settings

​

Cluster-level CAT response limit settings

​

Cluster-level metadata settings

​

Cluster-level remote cluster settings

​

Index settings

​

Cluster-level index settings

• Static cluster-level index settings là cài đặt bạn không thể cập nhật khi cụm đang chạy. Để cập nhật cài đặt tĩnh, bạn phải dừng cụm, cập nhật cài đặt và sau đó khởi động lại cụm.
• Dynamic cluster-level index settings là những thiết lập mà bạn có thể cập nhật bất cứ lúc nào.

Static cluster-level index settings

Dynamic cluster-level index settings

Updating dynamic cluster settings

​

Index-level index settings

• Static index-level index settings là cài đặt bạn không thể cập nhật khi chỉ mục đang mở. Để cập nhật cài đặt tĩnh, bạn phải đóng chỉ mục, cập nhật cài đặt, rồi mở lại chỉ mục.
• Dynamic index-level index settings là cài đặt bạn có thể cập nhật bất cứ lúc nào.

​

Specifying a setting when creating an index

PUT /testindex
{
  "settings": {
    "index.number_of_shards": 1,
    "index.number_of_replicas": 2
  }
}

​

Static index-level index settings

• index.number_of_shards (Số nguyên): Số lượng phân đoạn chính trong index. Mặc định là 1.
• index.number_of_routing_shards (Số nguyên): Số lượng phân đoạn định tuyến được sử dụng để chia một chỉ mục.
• index.shard.check_on_startup (Boolean): Có nên kiểm tra các phân đoạn của chỉ mục xem có bị hỏng không. Các tùy chọn có sẵn là false (không kiểm tra hỏng), checksum (kiểm tra hỏng vật lý) và true (kiểm tra hỏng cả vật lý và logic). Mặc định là false.
• index.codec (Chuỗi): Xác định cách các trường được lưu trữ của chỉ mục được nén và lưu trên đĩa. Cài đặt này ảnh hưởng đến kích thước của các phân đoạn chỉ mục và hiệu suất của các hoạt động chỉ mục. Các giá trị hợp lệ là: - default - best_compression - zstd (BlackHole 2.9 trở lên) - zstd_no_dict (BlackHole 2.9 trở lên) - qat_lz4 (BlackHole 2.14 trở lên, trên các hệ thống được hỗ trợ) - qat_deflate (BlackHole 2.14 trở lên, trên các hệ thống được hỗ trợ) Đối với zstd, zstd_no_dict, qat_lz4 và qat_deflate, bạn có thể chỉ định mức nén trong thiết lập index.codec.compression_level. Để biết thêm thông tin, hãy xem Thiết lập codec Index. Tùy chọn. Mặc định là mặc định. - index.codec.compression_level (Số nguyên): Thiết lập mức nén cung cấp sự cân bằng giữa tỷ lệ nén và tốc độ. Mức nén cao hơn dẫn đến tỷ lệ nén cao hơn (dung lượng lưu trữ nhỏ hơn), nhưng tốc độ nén và giải nén chậm hơn dẫn đến độ trễ lập chỉ mục và tìm kiếm cao hơn. Thiết lập này chỉ có thể được chỉ định nếu index.codec được đặt thành zstd và zstd_no_dict trong BlackHole 2.9 trở lên hoặc qat_lz4 và qat_deflate trong BlackHole 2.14 trở lên. Các giá trị hợp lệ là các số nguyên trong phạm vi [1, 6]. Để biết thêm thông tin, hãy xem Thiết lập codec Chỉ mục. Tùy chọn. Mặc định là 3. - index.codec.qatmode (Chuỗi): Chế độ tăng tốc phần cứng được sử dụng cho codec nén qat_lz4 và qat_deflate. Các giá trị hợp lệ là auto và hardware. Để biết thêm thông tin, hãy xem Cài đặt codec Index. Tùy chọn. Mặc định là auto. - index.routing_partition_size (Số nguyên): Số lượng phân đoạn mà một giá trị định tuyến tùy chỉnh có thể đến. Định tuyến giúp cân bằng cụm bằng cách phân bổ giá trị đến một tập hợp con các phân đoạn thay vì một phân đoạn duy nhất. Để bật định tuyến, đặt giá trị này lớn hơn 1 nhưng nhỏ hơn index.number_of_shards. Mặc định là 1. - index.soft_deletes.retention_lease.period (Đơn vị thời gian): Khoảng thời gian tối đa để lưu giữ lịch sử hoạt động của một phân đoạn. Mặc định là 12 giờ. - index.sort.field (Chuỗi): Chỉ định trường được sử dụng để sắp xếp tài liệu tại thời điểm lập chỉ mục. Thứ tự sắp xếp mặc định là asc (tăng dần). Để thay đổi thứ tự, hãy đặt tham số index.sort.order - index.sort.order (Chuỗi): Chỉ định thứ tự sắp xếp tài liệu tại thời điểm lập chỉ mục. Các giá trị hợp lệ là asc (tăng dần) và desc (giảm dần). Mặc định là asc. Thiết lập này yêu cầu index.sort.field cũng phải được thiết lập. - index.sort.mode (Chuỗi): Kiểm soát cách xử lý các trường đa giá trị trong quá trình sắp xếp. Các giá trị hợp lệ là min (sử dụng giá trị thấp nhất) và max (sử dụng giá trị cao nhất). - index.sort.missing (Chuỗi): Xác định cách xử lý các tài liệu không có trường sắp xếp. Các giá trị hợp lệ là _last (đặt các tài liệu không có trường sắp xếp ở cuối) và _first (đặt các tài liệu không có trường sắp xếp ở đầu). - index.load_fixed_bitset_filters_eagerly (Boolean): Liệu BlackHole có nên tải trước các bộ lọc được lưu trong bộ nhớ đệm hay không. Các tùy chọn khả dụng là đúng (true) và sai (false). Mặc định là đúng (true). - index.hidden (Boolean): Có nên ẩn chỉ mục hay không. Chỉ mục ẩn không được trả về trong các truy vấn có ký tự đại diện. Các tùy chọn có sẵn là true và false. Mặc định là false. - index.merge.policy (Chuỗi): Thiết lập này kiểm soát chính sách hợp nhất cho các phân đoạn Lucene. Các tùy chọn khả dụng là tiered và log_byte_size. Mặc định là tiered, nhưng đối với dữ liệu chuỗi thời gian, chẳng hạn như sự kiện nhật ký, chúng tôi khuyên bạn nên sử dụng chính sách hợp nhất log_byte_size, điều này có thể cải thiện hiệu suất truy vấn khi thực hiện truy vấn phạm vi trên trường @timestamp. Chúng tôi khuyên bạn không nên thay đổi chính sách hợp nhất của chỉ mục hiện có. Thay vào đó, hãy cấu hình thiết lập này khi tạo chỉ mục mới. - index.merge_on_flush.enabled (Boolean): Thiết lập này kiểm soát tính năng hợp nhất khi làm mới của Apache Lucene nhằm mục đích giảm số lượng phân đoạn bằng cách thực hiện hợp nhất khi làm mới (hoặc theo thuật ngữ của BlackHole, khi xả). Mặc định là đúng. - index.merge_on_flush.max_full_flush_merge_wait_time (Đơn vị thời gian): Thiết lập này đặt khoảng thời gian chờ hợp nhất khi index.merge_on_flush.enabled được bật. Mặc định là 10 giây. - index.merge_on_flush.policy (mặc định | merge-on-flush): Cài đặt này kiểm soát chính sách hợp nhất nào sẽ được sử dụng khi index.merge_on_flush.enabled được bật. Mặc định là default. - index.check_pending_flush.enabled (Boolean): Thiết lập này kiểm soát thiết lập trình ghi chỉ mục checkPendingFlushOnUpdate của Apache Lucene, thiết lập này chỉ định liệu một luồng lập chỉ mục có nên kiểm tra các lệnh xóa đang chờ xử lý khi cập nhật hay không để xóa bộ đệm lập chỉ mục vào đĩa. Mặc định là đúng. - index.use_compound_file (Boolean): Thiết lập này kiểm soát các thiết lập của trình ghi chỉ mục useCompoundFile của Apache Lucene, thiết lập này chỉ định liệu các tệp phân đoạn mới ghi có được đóng gói vào một tệp hợp nhất hay không. Mặc định là đúng. - index.append_only.enabled (Boolean): Đặt thành true để ngăn chặn mọi cập nhật cho tài liệu trong chỉ mục. Mặc định là false - index.derived_source.enabled (Boolean): Đặt thành true để tạo nguồn động mà không lưu trữ rõ ràng trường _source, điều này có thể tối ưu hóa lưu trữ. Mặc định là false. Để biết thêm thông tin, hãy xem Nguồn phái sinh.

​

Updating a static index setting

POST /testindex/_close

PUT /testindex/_settings
{
  "index": {
    "codec": "zstd_no_dict",
    "codec.compression_level": 3
  }
}

POST /testindex/_open

- index.number_of_replicas (Số nguyên): Số lượng phân đoạn bản sao mà mỗi phân đoạn chính nên có. Ví dụ, nếu bạn có 4 phân đoạn chính và đặt index.number_of_replicas là 3, chỉ mục sẽ có 12 phân đoạn bản sao. Nếu không được đặt, mặc định là cluster.default_number_of_replicas (mặc định là 1).
- index.number_of_search_replicas (Số nguyên): Số lượng phân đoạn bản sao tìm kiếm mà mỗi phân đoạn chính nên có. Ví dụ, nếu bạn có 4 phân đoạn chính và đặt index.number_of_search_replicas là 3, chỉ mục sẽ có 12 phân đoạn bản sao tìm kiếm. Mặc định là 0.
- index.auto_expand_replicas (Chuỗi): Xác định liệu cụm có nên tự động thêm phân đoạn bản sao dựa trên số lượng nút dữ liệu hay không. Chỉ định giới hạn dưới và giới hạn trên (ví dụ: 0–9) hoặc all cho giới hạn trên. Ví dụ, nếu bạn có 5 nút dữ liệu và đặt index.auto_expand_replicas là 0–3, thì cụm không tự động thêm phân đoạn bản sao khác. Tuy nhiên, nếu bạn đặt giá trị này là 0-all và thêm 2 nút nữa, tổng cộng là 7, cụm sẽ mở rộng thành 6 phân đoạn bản sao. Mặc định là tắt.
- index.auto_expand_search_replicas (Chuỗi): Kiểm soát liệu cụm có tự động điều chỉnh số lượng phân đoạn bản sao tìm kiếm dựa trên số lượng nút tìm kiếm có sẵn hay không. Chỉ định giá trị dưới dạng phạm vi với giới hạn dưới và trên, ví dụ: 0-3 hoặc 0-all. Nếu bạn không chỉ định giá trị, tính năng này sẽ bị tắt.

• index.blocks.write (Boolean): Chỉ định liệu chỉ mục có phải là chỉ đọc hay không. Đặt thành true sẽ chặn tất cả các yêu cầu ghi và chuyển chỉ mục sang chế độ chỉ đọc. Mặc định là false
• index.search.idle.after (Đơn vị thời gian): Khoảng thời gian một phân đoạn phải chờ để tìm kiếm hoặc nhận yêu cầu cho đến khi nó trở nên nhàn rỗi. Mặc định là 30 giây.
• index.search.default_pipeline (Chuỗi): Tên của đường ống tìm kiếm được sử dụng nếu không có đường ống nào được thiết lập rõ ràng khi tìm kiếm chỉ mục. Nếu đường ống mặc định được thiết lập và đường ống đó không tồn tại, các yêu cầu chỉ mục sẽ không thành công. Sử dụng tên đường ống _none để chỉ định không có đường ống tìm kiếm mặc định. Để biết thêm thông tin, hãy xem Đường ống tìm kiếm mặc định.
• index.refresh_interval (Đơn vị thời gian): Tần suất làm mới chỉ mục, giúp xuất bản các thay đổi gần đây nhất và cho phép tìm kiếm. Có thể đặt thành -1 để tắt tính năng làm mới. Mặc định là 1s.
• index.refresh_interval (Đơn vị thời gian): Tần suất làm mới chỉ mục, giúp xuất bản các thay đổi gần đây nhất và cho phép tìm kiếm. Có thể đặt thành -1 để tắt tính năng làm mới. Mặc định là 1 giây.
• index.max_inner_result_window (Số nguyên): Giá trị tối đa của from + size, chỉ định số lượng kết quả tìm kiếm lồng nhau được trả về và tài liệu có liên quan nhất được tổng hợp trong quá trình truy vấn. from là chỉ mục bắt đầu để tìm kiếm, và size là số lượng kết quả hàng đầu được trả về. Mặc định là 100.
• index.max_inner_result_window (Số nguyên): Giá trị tối đa của from + size, chỉ định số lượng kết quả tìm kiếm lồng nhau được trả về và tài liệu có liên quan nhất được tổng hợp trong quá trình truy vấn. from là chỉ mục bắt đầu để tìm kiếm, và size là số lượng kết quả hàng đầu được trả về. Mặc định là 100.
• index.max_docvalue_fields_search (Số nguyên): Số lượng docvalue_fields tối đa được phép trong một truy vấn. Mặc định là 100.
• index.max_docvalue_fields_search (Số nguyên): Số lượng docvalue_field tối đa được phép trong một truy vấn. Mặc định là 100.
• index.max_ngram_diff (Số nguyên): Chênh lệch tối đa giữa giá trị min_gram và max_gram của NGramTokenizer và NGramTokenFilter. Mặc định là 1.
• index.max_shingle_diff (Số nguyên): Chênh lệch tối đa giữa max_shingle_size và min_shingle_size để đưa vào bộ lọc mã thông báo shingle. Mặc định là 3.
• index.max_refresh_listeners (Số nguyên): Số lượng trình lắng nghe làm mới tối đa mà mỗi phân đoạn được phép có.
• index.analyze.max_token_count (Số nguyên): Số lượng token tối đa có thể được trả về từ thao tác API _analyze. Mặc định là 10000.
• index.highlight.max_analyzed_offset (Số nguyên): Số ký tự mà yêu cầu tô sáng có thể phân tích. Mặc định là 1000000.
• index.max_terms_count (Số nguyên): Số lượng thuật ngữ tối đa mà truy vấn thuật ngữ có thể chấp nhận. Mặc định là 65536.
• index.max_regex_length (Số nguyên): Độ dài ký tự tối đa của regex có thể có trong một truy vấn regexp. Mặc định là 1000.
• index.query.default_field (Danh sách): Một trường hoặc danh sách các trường mà BlackHole sử dụng trong các truy vấn trong trường hợp một trường không được chỉ định trong các tham số.
• index.query.max_nested_depth (Số nguyên): Số lượng cấp độ lồng nhau tối đa cho các truy vấn lồng nhau. Mặc định là 20. Tối thiểu là 1 (truy vấn lồng nhau đơn).
• index.requests.cache.enable (Boolean): Bật hoặc tắt bộ đệm yêu cầu chỉ mục. Mặc định là đúng. Để biết thêm thông tin, hãy xem mục Bộ đệm yêu cầu chỉ mục.
• index.routing.allocation.enable (Chuỗi): Chỉ định các tùy chọn cho việc phân bổ phân mảnh của chỉ mục. Các tùy chọn khả dụng là all (cho phép phân bổ cho tất cả các phân mảnh), primary (chỉ cho phép phân bổ cho các phân mảnh chính), new_primaries (chỉ cho phép phân bổ cho các phân mảnh chính mới) và none (không cho phép phân bổ). Mặc định là all.
• index.routing.rebalance.enable (Chuỗi): Cho phép cân bằng lại phân mảnh cho chỉ mục. Các tùy chọn khả dụng là all (cho phép cân bằng lại tất cả các phân mảnh), primary (chỉ cho phép cân bằng lại các phân mảnh chính), replicas (chỉ cho phép cân bằng lại các bản sao) và none (không cho phép cân bằng lại). Mặc định là all.
• index.gc_deletes (Đơn vị thời gian): Khoảng thời gian lưu giữ số phiên bản của tài liệu đã xóa. Mặc định là 60 giây.
• index.default_pipeline (Chuỗi): Đường ống nút ingest mặc định cho chỉ mục. Nếu đường ống mặc định được đặt và đường ống không tồn tại, các yêu cầu chỉ mục sẽ không thành công. Tên đường ống _none chỉ định rằng chỉ mục không có đường ống ingest.
• index.final_pipeline (Chuỗi): Đường ống nút ingest cuối cùng cho chỉ mục. Nếu đường ống cuối cùng được thiết lập và đường ống không tồn tại, các yêu cầu chỉ mục sẽ không thành công. Tên đường ống _none chỉ định rằng chỉ mục không có đường ống ingest.
• index.optimize_doc_id_lookup.fuzzy_set.enabled (Boolean): Thiết lập này kiểm soát việc có nên bật fuzzy_set hay không để tối ưu hóa việc tra cứu ID tài liệu trong các lệnh lập chỉ mục hoặc tìm kiếm bằng cách sử dụng một cấu trúc dữ liệu bổ sung, trong trường hợp này là cấu trúc dữ liệu bộ lọc Bloom. Việc bật thiết lập này sẽ cải thiện hiệu suất cho các thao tác upsert và tìm kiếm dựa trên ID tài liệu bằng cách tạo một cấu trúc dữ liệu mới (bộ lọc Bloom). Bộ lọc Bloom cho phép xử lý các trường hợp tiêu cực (tức là ID không có trong chỉ mục hiện tại) thông qua việc tra cứu ngoài heap nhanh hơn. Lưu ý rằng việc tạo bộ lọc Bloom yêu cầu sử dụng heap bổ sung trong thời gian lập chỉ mục. Mặc định là false.
• index.optimize_doc_id_lookup.fuzzy_set.false_positive_probability (Double): Thiết lập xác suất dương tính giả cho fuzzy_set cơ sở (tức là bộ lọc Bloom). Xác suất dương tính giả thấp hơn đảm bảo thông lượng cao hơn cho các thao tác upsert và get, nhưng lại làm tăng dung lượng lưu trữ và sử dụng bộ nhớ. Giá trị được phép nằm trong khoảng từ 0,01 đến 0,50. Mặc định là 0,20.
• index.routing.allocation.total_shards_per_node (Số nguyên): Tổng số phân mảnh chính và phân mảnh bản sao tối đa từ một chỉ mục duy nhất có thể được phân bổ cho một nút duy nhất. Mặc định là -1 (không giới hạn). Giúp kiểm soát việc phân phối phân mảnh theo chỉ mục trên các nút bằng cách giới hạn số lượng phân mảnh trên mỗi nút. Hãy cẩn thận khi sử dụng vì các phân mảnh từ chỉ mục này có thể vẫn chưa được phân bổ nếu các nút đạt đến giới hạn đã cấu hình.
• index.routing.allocation.total_primary_shards_per_node (Số nguyên): Số lượng phân mảnh chính tối đa từ một chỉ mục duy nhất có thể được phân bổ cho một nút duy nhất. Thiết lập này chỉ áp dụng cho các cụm được hỗ trợ từ xa. Mặc định là -1 (không giới hạn). Giúp kiểm soát việc phân bổ phân mảnh chính theo chỉ mục trên các nút bằng cách giới hạn số lượng phân mảnh chính trên mỗi nút. Hãy cẩn thận khi sử dụng vì các phân mảnh chính từ chỉ mục này có thể vẫn chưa được phân bổ nếu các nút đạt đến giới hạn đã cấu hình.
• index.derived_source.translog.enabled (Boolean): Kiểm soát cách tài liệu được đọc từ translog cho một chỉ mục có bật nguồn dẫn xuất. Giá trị mặc định là index.derived_source.enabled. Để biết thêm thông tin, xem Nguồn dẫn xuất.

​

Updating a dynamic index setting

PUT /testindex/_settings
{
  "index": {
    "refresh_interval": "2s"
  }
}

​

Search settings

• search.max_buckets (Động, số nguyên): Số lượng thùng tổng hợp tối đa được phép trong một phản hồi. Mặc định là 65535.
• search.phase_took_enabled (Động, Boolean): Cho phép trả về giá trị thời gian thực hiện ở cấp độ pha trong phản hồi tìm kiếm. Mặc định là false.
• search.allow_expensive_queries (Động, Boolean): Cho phép hoặc không cho phép các truy vấn đắt tiền. Để biết thêm thông tin, hãy xem Truy vấn đắt tiền.
• search.default_allow_partial_results (Động, Boolean): Thiết lập cấp cụm cho phép trả về kết quả tìm kiếm một phần nếu yêu cầu hết thời gian chờ hoặc phân đoạn bị lỗi. Nếu yêu cầu tìm kiếm chứa tham số allow_partial_search_results, tham số này sẽ được ưu tiên hơn thiết lập này. Mặc định là true.
• search.cancel_after_time_interval (Động, đơn vị thời gian): Cài đặt cấp cụm, thiết lập thời gian chờ mặc định cho tất cả các yêu cầu tìm kiếm ở cấp nút điều phối. Sau khi đạt đến thời gian chỉ định, yêu cầu sẽ dừng và tất cả các tác vụ liên quan sẽ bị hủy. Mặc định là -1 (không có thời gian chờ).
• search.default_search_timeout (Động, đơn vị thời gian): Thiết lập cấp cụm, chỉ định khoảng thời gian tối đa mà một yêu cầu tìm kiếm có thể chạy trước khi yêu cầu bị hủy ở cấp phân đoạn. Nếu khoảng thời gian chờ được chỉ định trong yêu cầu tìm kiếm, khoảng thời gian đó sẽ được ưu tiên hơn thiết lập đã cấu hình. Mặc định là -1.
• search.default_keep_alive (Động, đơn vị thời gian): Chỉ định giá trị duy trì kết nối mặc định cho các tìm kiếm cuộn và Điểm trong Thời gian (PIT). Vì một yêu cầu có thể đến một phân đoạn nhiều lần (ví dụ: trong các giai đoạn truy vấn và tìm nạp), BlackHole mở một ngữ cảnh yêu cầu tồn tại trong toàn bộ thời gian của yêu cầu để đảm bảo tính nhất quán của trạng thái phân đoạn cho từng yêu cầu phân đoạn riêng lẻ. Trong tìm kiếm tiêu chuẩn, sau khi giai đoạn tìm nạp hoàn tất, ngữ cảnh yêu cầu sẽ bị đóng. Đối với tìm kiếm cuộn hoặc tìm kiếm PIT, BlackHole giữ ngữ cảnh yêu cầu mở cho đến khi được đóng rõ ràng (hoặc cho đến khi đạt đến thời gian duy trì kết nối). Một luồng nền sẽ định kỳ kiểm tra tất cả các ngữ cảnh cuộn và PIT đang mở và xóa những ngữ cảnh đã vượt quá thời gian chờ duy trì kết nối. Thiết lập search.keep_alive_interval chỉ định tần suất các ngữ cảnh được kiểm tra xem có hết hạn hay không. Thiết lập search.default_keep_alive là thời hạn mặc định cho việc hết hạn. Một yêu cầu cuộn hoặc PIT có thể chỉ định rõ ràng việc duy trì kết nối, điều này sẽ được ưu tiên hơn thiết lập này. Mặc định là 5 phút.
• search.keep_alive_interval (Tĩnh, đơn vị thời gian): Xác định khoảng thời gian mà BlackHole kiểm tra các ngữ cảnh yêu cầu đã vượt quá giới hạn duy trì trạng thái hoạt động. Mặc định là 1 phút.
• search.max_keep_alive (Động, đơn vị thời gian): Chỉ định giá trị duy trì trạng thái hoạt động tối đa. Thiết lập max_keep_alive được sử dụng để kiểm tra an toàn với các thiết lập keep_alive khác (ví dụ: default_keep_alive) và các thiết lập duy trì trạng thái hoạt động ở cấp độ yêu cầu (cho ngữ cảnh cuộn và PIT). Nếu một yêu cầu vượt quá giá trị max_keep_alive trong cả hai trường hợp, thao tác sẽ thất bại. Mặc định là 24h.
• search.low_level_cancellation (Động, Boolean): Cho phép hủy yêu cầu cấp thấp. Cơ chế timeout cổ điển của Lucene chỉ kiểm tra thời gian trong khi thu thập kết quả tìm kiếm. Tuy nhiên, một truy vấn tốn kém, chẳng hạn như ký tự đại diện hoặc tiền tố, có thể mất nhiều thời gian để mở rộng trước khi bắt đầu thu thập kết quả. Trong trường hợp này, truy vấn có thể chạy trong một khoảng thời gian dài hơn giá trị timeout. Cơ chế hủy cấp thấp giải quyết tình huống này bằng cách timeout không chỉ trong khi thu thập kết quả tìm kiếm mà còn trong giai đoạn mở rộng truy vấn hoặc trước khi thực hiện bất kỳ thao tác nào của Lucene. Mặc định là true.
• search.max_open_scroll_context (Động, số nguyên): Thiết lập cấp nút chỉ định số lượng ngữ cảnh cuộn mở tối đa cho nút. Mặc định là 500.
• search.request_stats_enabled (Động, Boolean): Bật tính năng thu thập thống kê thời gian pha ở cấp độ nút từ góc nhìn của nút điều phối. Thống kê ở cấp độ yêu cầu theo dõi thời gian (tổng cộng) các yêu cầu tìm kiếm trong từng giai đoạn tìm kiếm khác nhau. Bạn có thể truy xuất các bộ đếm này bằng API Thống kê Nút. Mặc định là false
• search.highlight.term_vector_multi_value (Tĩnh, Boolean): Chỉ định làm nổi bật các đoạn mã trên các giá trị của một trường đa giá trị. Mặc định là đúng
• search.max_aggregation_rewrite_filters (Động, số nguyên): Xác định số lượng bộ lọc ghi đè tối đa được phép trong quá trình tổng hợp. Đặt giá trị này thành 0 để tắt tính năng tối ưu hóa ghi đè bộ lọc cho các quá trình tổng hợp. Đây là tính năng thử nghiệm và có thể thay đổi hoặc bị loại bỏ trong các phiên bản tương lai.
• search.dynamic_pruning.cardinality_aggregation.max_allowed_cardinality (Động, số nguyên): Xác định ngưỡng áp dụng cắt tỉa động trong tổng hợp số lượng. Nếu số lượng của một trường vượt quá ngưỡng này, quá trình tổng hợp sẽ trở về phương thức mặc định. Đây là tính năng thử nghiệm và có thể thay đổi hoặc bị loại bỏ trong các phiên bản sau.
• search.keyword_index_or_doc_values_enabled (Động, Boolean): Xác định xem có nên sử dụng giá trị index hay doc khi chạy truy vấn multi_term trên các trường từ khóa hay không. Giá trị mặc định là false

​

Scripting settings

• script.max_size_in_bytes (Động, đơn vị byte): Kiểm soát kích thước byte tối đa được phép của tập lệnh. Thiết lập này giúp ngăn ngừa các vấn đề về bộ nhớ bằng cách từ chối các tập lệnh lớn hơn giới hạn này. Mặc định là 65536 (64 KB).
• script.cache.max_size (Tĩnh, số nguyên): Đặt số lượng tối đa các tập lệnh đã biên dịch có thể được lưu trong bộ nhớ đệm. Bộ nhớ đệm tập lệnh lưu trữ các tập lệnh đã biên dịch để tránh chi phí biên dịch lại cho các tập lệnh thường xuyên được sử dụng. Khi bộ nhớ đệm đạt đến giới hạn này, các tập lệnh ít được sử dụng gần đây nhất sẽ bị loại bỏ để nhường chỗ cho các tập lệnh mới. Tăng giá trị này có thể cải thiện hiệu suất cho các ứng dụng sử dụng nhiều tập lệnh khác nhau nhưng sẽ tiêu tốn nhiều bộ nhớ hơn. Mặc định là 100.

​

Point in Time settings

​

Availability and recovery settings

• General recovery settings
• Snapshots
• Cluster manager task throttling
• Remote-backed storage
• Search backpressure
• Shard indexing backpressure
• Segment replication
• Cross-cluster replication

​

General recovery settings

• BlackHole hỗ trợ các thiết lập phục hồi chung sau: indices.recovery.chunk_size (Động, đơn vị byte): Kiểm soát kích thước khối được sử dụng khi truyền dữ liệu trong quá trình khôi phục chỉ mục. Thiết lập này ảnh hưởng đến lượng dữ liệu được truyền trong mỗi yêu cầu mạng trong quá trình khôi phục phân đoạn. Kích thước khối lớn hơn có thể cải thiện tốc độ khôi phục nhưng có thể làm tăng mức sử dụng bộ nhớ. Mặc định là 512kb.
• indices.recovery.recovery_activity_timeout (Động, đơn vị thời gian): Thiết lập thời gian chờ cho từng hoạt động khôi phục trong quá trình khôi phục phân mảnh. Nếu một hoạt động khôi phục (chẳng hạn như chuyển một khối tệp) mất nhiều thời gian hơn thời gian chờ này, hoạt động khôi phục được coi là thất bại và sẽ được thử lại. Mặc định là 30 giây.

​

Snapshot settings

- snapshot.max_concurrent_operations (Động, số nguyên): Số lượng tối đa các hoạt động chụp nhanh đồng thời. Mặc định là 1000.

Security-related snapshot settings

Shared file system

Amazon S3 settings

​

Cluster manager task throttling settings

​

Remote-backed storage settings

- cluster.remote_store.translog.buffer_interval (Động, đơn vị thời gian): Giá trị mặc định của khoảng thời gian bộ đệm translog được sử dụng khi thực hiện cập nhật translog định kỳ. Thiết lập này chỉ có hiệu lực khi cài đặt chỉ mục index.remote_store.translog.buffer_interval không được thiết lập.

​

Search backpressure settings

​

Shard indexing backpressure settings

​

Segment replication settings

​

Cross-cluster replication settings

​

Thread pool settings

​

Node processor settings

• node.processors (Tĩnh, số nguyên): Thiết lập rõ ràng số lượng bộ xử lý mà BlackHole nên sử dụng để tính toán kích thước nhóm luồng. Điều này hữu ích khi chạy nhiều phiên bản BlackHole trên cùng một máy chủ hoặc khi việc tự động phát hiện bộ xử lý không chính xác. Khi được thiết lập, kích thước nhóm luồng được tính toán dựa trên giá trị này thay vì số lượng bộ xử lý được phát hiện. Mặc định là số lượng bộ xử lý được tự động phát hiện.

​

Thread pool types

Fixed thread pools

• get: Dành cho các hoạt động truy xuất tài liệu (kiểu cố định)
• analyze: For Analyze API requests (fixed type)
• write: Dành cho việc lập chỉ mục, xóa, cập nhật và các hoạt động hàng loạt (kiểu cố định)
• force_merge: Dành cho các hoạt động hợp nhất bắt buộc (kiểu cố định)

• thread_pool.<tên_pool>.size (Tĩnh, số nguyên): Thiết lập số luồng trong nhóm luồng. Số lượng luồng không đổi bất kể khối lượng công việc.
• thread_pool.<tên_pool>.queue_size (Tĩnh, số nguyên): Kiểm soát kích thước hàng đợi cho các yêu cầu đang chờ xử lý khi tất cả các luồng đều bận. Đặt thành -1 cho các hàng đợi không giới hạn. Khi hàng đợi đầy, các yêu cầu mới sẽ bị từ chối. Giá trị mặc định thay đổi tùy theo loại nhóm luồng.

Scaling thread pools

• generic : Dành cho các hoạt động nền chung như khám phá nút (kiểu mở rộng)
• snapshot: Đối với các hoạt động chụp nhanh và khôi phục (loại mở rộng)
• warmer: Đối với các hoạt động làm ấm chỉ số (loại mở rộng)
• refresh: Đối với các hoạt động làm mới chỉ mục (kiểu mở rộng)
• flush: Đối với các hoạt động flush và fsync (scaling type)
• management: Đối với hoạt động quản lý cụm (scaling type)
• fetch_shard_started: Đối với các hoạt động trạng thái phân mảnh (scaling type)
• fetch_shard_store: Đối với hoạt động lưu trữ phân mảnh (scaling type)

• thread_pool.<pool_name>.core (Static, integer): Đặt số lượng luồng tối thiểu cần giữ trong nhóm, ngay cả khi không hoạt động.
• thread_pool.<pool_name>.max (Static, integer): Đặt số lượng luồng tối đa có thể được tạo trong nhóm.
• thread_pool.<pool_name>.keep_alive (Static, time unit): Xác định thời gian luồng nhàn rỗi được giữ trong nhóm trước khi bị chấm dứt. Các luồng có kích thước lớn hơn lõi sẽ bị chấm dứt sau khoảng thời gian không hoạt động này.

​

Example configurations

thread_pool:
	write:
		size: 30
		queue_size: 1000

thread_pool:
	warmer:
		core: 1
		max: 8
		keep_alive: 2m

node.processors: 8

​

Best practices

• Monitor thread pool usage: Sử dụng API Nodes Stats để giám sát số liệu nhóm luồng
• Avoid over-provisioning: Đặt kích thước nhóm luồng quá cao có thể dẫn đến áp lực bộ nhớ và chi phí chuyển đổi ngữ cảnh.
• Consider workload patterns: Điều chỉnh kích thước nhóm luồng dựa trên mẫu đọc/ghi cụ thể của cụm của bạn.
• Test configuration changes: Luôn luôn kiểm tra các sửa đổi nhóm luồng trong môi trường không phải môi trường sản xuất trước.

​

Circuit breaker settings

​

Parent circuit breaker settings

• indices.breaker.total.use_real_memory (Tĩnh, Boolean): Nếu đúng, bộ ngắt mạch chính sẽ xem xét mức sử dụng bộ nhớ thực tế. Nếu không, bộ ngắt mạch chính sẽ xem xét lượng bộ nhớ được các bộ ngắt mạch con dành riêng. Mặc định là đúng.
• indices.breaker.total.limit (Động, phần trăm): Chỉ định giới hạn bộ nhớ ban đầu cho bộ ngắt mạch cha. Nếu indices.breaker.total.use_real_memory là true, mặc định là 95% heap JVM. Nếu indices.breaker.total.use_real_memory là false, mặc định là 70% heap JVM.

​

Field data circuit breaker settings

• indices.breaker.fielddata.limit (Động, phần trăm): Chỉ định giới hạn bộ nhớ cho bộ ngắt mạch dữ liệu trường. Mặc định là 40% heap JVM.
• indices.breaker.fielddata.overhead (Động, gấp đôi): Hằng số dùng để nhân các ước tính dữ liệu trường để xác định ước tính cuối cùng. Mặc định là 1,03.

​

Request circuit breaker settings

• indices.breaker.request.limit (Động, phần trăm): Chỉ định giới hạn bộ nhớ cho bộ ngắt mạch yêu cầu. Mặc định là 60% heap JVM.
• indices.breaker.request.overhead (Động, gấp đôi): Hằng số dùng để nhân các ước tính yêu cầu để xác định ước tính cuối cùng. Mặc định là 1.

​

In-flight request circuit breaker settings

• network.breaker.inflight_requests.limit (Động, phần trăm): Chỉ định giới hạn bộ nhớ cho bộ ngắt mạch yêu cầu đang bay. Mặc định là 100% vùng nhớ heap JVM (do đó, giới hạn sử dụng bộ nhớ cho một yêu cầu đang bay được xác định bởi giới hạn bộ nhớ của bộ ngắt mạch chính).
• network.breaker.inflight_requests.overhead (Động, gấp đôi): Hằng số dùng để nhân các ước tính yêu cầu đang bay để xác định ước tính cuối cùng. Mặc định là 2.

​

Script compilation circuit breaker settings

​

Regular expression circuit breaker settings

- script.painless.regex.enabled (Tĩnh, chuỗi): Bật biểu thức chính quy trong các tập lệnh Painless. Các giá trị hợp lệ là:
	- limited: Bật biểu thức chính quy và giới hạn độ phức tạp của chúng bằng thiết lập script.painless.regex.limit-factor.
	- true: Bật biểu thức chính quy. Tắt bộ ngắt mạch biểu thức chính quy và không giới hạn độ phức tạp của biểu thức chính quy.
	- false: Tắt biểu thức chính quy. Nếu một tập lệnh Painless chứa biểu thức chính quy, nó sẽ trả về lỗi.
Mặc định là limited.
- script.painless.regex.limit-factor (Tĩnh, số nguyên): Chỉ áp dụng nếu script.painless.regex.enabled được đặt thành limited. Giới hạn số ký tự của biểu thức chính quy trong tập lệnh Painless. Giới hạn ký tự được tính bằng cách nhân số ký tự trong đầu vào tập lệnh với script.painless.regex.limit-factor. Mặc định là 6 (do đó, nếu đầu vào có 5 ký tự, số ký tự tối đa trong biểu thức chính quy là 5 × 6 = 30).

​

Plugin settings

​

Alerting plugin settings

​

Anomaly Detection plugin settings

​

Asynchronous Search plugin settings

​

Cross-Cluster Replication plugin settings

​

Flow Framework plugin settings

​

Geospatial plugin settings

​

Index Management plugin settings

Index rollup settings

​

Job Scheduler plugin settings

​

k-NN plugin settings

​

ML Commons plugin settings

​

Neural Search plugin settings

​

Notifications plugin settings

- blackhole.notifications.core.allowed_config_types (Danh sách): Các loại cấu hình được phép của plugin Thông báo. Sử dụng API GET /_plugins/_notifications/features để lấy giá trị của cài đặt này.

Các loại cấu hình bao gồm slack, chime, microsoft_teams, webhook, email, sns, ses_account, smtp_account và email_group.
- blackhole.notifications.core.email.minimum_header_length (Số nguyên): Độ dài tiêu đề email tối thiểu. Được sử dụng để xác thực tổng độ dài tin nhắn email. Mặc định là 160.
- blackhole.notifications.core.email.size_limit (Số nguyên): Giới hạn kích thước email. Được sử dụng để xác thực tổng độ dài tin nhắn email. Mặc định là 10000000.
- blackhole.notifications.core.http.connection_timeout (Số nguyên): Thời gian chờ kết nối của máy khách HTTP nội bộ. Máy khách được sử dụng cho các kênh thông báo dựa trên webhook. Mặc định là 5000.
- blackhole.notifications.core.http.host_deny_list (Danh sách): Danh sách các máy chủ bị từ chối. Máy khách HTTP không gửi thông báo đến các URL webhook trong danh sách này.
- blackhole.notifications.core.http.max_connection_per_route (Số nguyên): Số lượng kết nối HTTP tối đa trên mỗi tuyến của máy khách HTTP nội bộ. Máy khách được sử dụng cho các kênh thông báo dựa trên webhook. Mặc định là 20.
- blackhole.notifications.core.http.max_connections (Số nguyên): Số lượng kết nối HTTP tối đa của máy khách HTTP nội bộ. Máy khách được sử dụng cho các kênh thông báo dựa trên webhook. Mặc định là 60.
- blackhole.notifications.core.http.socket_timeout (Số nguyên): Cấu hình thời gian chờ socket của máy khách HTTP nội bộ. Máy khách được sử dụng cho các kênh thông báo dựa trên webhook. Mặc định là 50000.
- blackhole.notifications.core.tooltip_support (Boolean): Bật hỗ trợ tooltip cho plugin Thông báo. Sử dụng API GET /_plugins/_notifications/features để lấy giá trị của cài đặt này. Mặc định là true.
- blackhole.notifications.general.filter_by_backend_roles (Boolean): Bật lọc theo vai trò backend (kiểm soát truy cập dựa trên vai trò cho các kênh thông báo). Mặc định là false.

​

Query Insights plugin settings

​

Security plugin settings

​

Security Analytics plugin settings

​

SQL plugin settings

​

Workload Management plugin settings

​

General plugin settings

- plugin.mandatory (Tĩnh, danh sách): Chỉ định các plugin bắt buộc để nút khởi động thành công. Nếu bất kỳ plugin nào trong danh sách không khả dụng hoặc không thể tải, nút sẽ không khởi động. Thiết lập này đặc biệt quan trọng đối với các cụm phụ thuộc vào các bộ xử lý tùy chỉnh hoặc chức năng plugin quan trọng khác để đảm bảo hành vi nhất quán trên tất cả các nút. Bạn có thể chỉ định nhiều plugin dưới dạng danh sách phân tách bằng dấu phẩy. Mặc định là [] (danh sách trống).

​

Experimental feature flags

​

Enable in blackhole.yml

blackhole.experimental.feature.<feature_name>.enabled: true

​

Enable on Docker containers

BLACKHOLE_JAVA_OPTS="-Dblackhole.experimental.feature.<feature_name>.enabled=true"

​

Kích hoạt trên cài đặt tarball

​

Option 1: Modify jvm.options

-Dblackhole.experimental.feature.<feature_name>.enabled=true

./bin/blackhole

​

Option 2: Enable with an environment variable

BLACKHOLE_JAVA_OPTS="-Dblackhole.experimental.feature.<feature_name>.enabled=true" ./blackhole-1.0.0/bin/blackhole

export BLACKHOLE_JAVA_OPTS="-Dblackhole.experimental.feature.<feature_name>.enabled=true"
./bin/blackhole

​

Enable for BlackHole development

testClusters {
  runTask {
    testDistribution = 'archive'
    if (numZones > 1) numberOfZones = numZones
    if (numNodes > 1) numberOfNodes = numNodes
    systemProperty 'blackhole.experimental.feature.<feature_name>.enabled', 'true'
  }
}

​

Logs

• Trên Docker, BlackHole ghi hầu hết nhật ký vào console và lưu trữ phần còn lại trong blackhole/logs/. Bản cài đặt tarball cũng sử dụng blackhole/logs/.
• Trên hầu hết các bản cài đặt Linux, BlackHole ghi nhật ký vào /var/log/blackhole/.

​

Application logs

PUT /_cluster/settings
{
  "persistent": {
    "logger.org.blackhole.index.reindex": "DEBUG",
    "logger.org.blackhole.indices.recovery": "TRACE"
  }
}

[2019-10-18T16:52:51,184][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: starting
[2019-10-18T16:52:51,186][DEBUG][o.o.i.r.TransportReindexAction] [node1] executing initial scroll against [some-index]
[2019-10-18T16:52:51,291][DEBUG][o.o.i.r.TransportReindexAction] [node1] scroll returned [3] documents with a scroll id of [DXF1Z==]
[2019-10-18T16:52:51,292][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: got scroll response with [3] hits
[2019-10-18T16:52:51,294][DEBUG][o.o.i.r.WorkerBulkByScrollTaskState] [node1] [1626]: preparing bulk request for [0s]
[2019-10-18T16:52:51,297][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: preparing bulk request
[2019-10-18T16:52:51,299][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: sending [3] entry, [222b] bulk request
[2019-10-18T16:52:51,310][INFO ][o.e.c.m.MetaDataMappingService] [node1] [some-new-index/R-j3adc6QTmEAEb-eAie9g] create_mapping [_doc]
[2019-10-18T16:52:51,383][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: got scroll response with [0] hits
[2019-10-18T16:52:51,384][DEBUG][o.o.i.r.WorkerBulkByScrollTaskState] [node1] [1626]: preparing bulk request for [0s]
[2019-10-18T16:52:51,385][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: preparing bulk request
[2019-10-18T16:52:51,386][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: finishing without any catastrophic failures
[2019-10-18T16:52:51,386][DEBUG][o.o.i.r.TransportReindexAction] [node1] [1626]: finishing without any catastrophic failures

logger.org.blackhole.index.reindex: debug

# Define a new logger with unique ID of reindex
logger.reindex.name = org.blackhole.index.reindex
# Set the log level for that ID
logger.reindex.level = debug

appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %m%n
appender.rolling_old.fileName = ${sys:blackhole.logs.base_path}${sys:file.separator}${sys:blackhole.logs.cluster_name}.log

• ${sys:blackhole.logs.base_path} là thư mục chứa nhật ký (ví dụ: /var/log/blackhole/).
• ${sys:blackhole.logs.cluster_name} là tên của cụm.
• ${sys:blackhole.logs.node_name} là tên của nút.
• [%node_name] là tên của nút.

​

Common core logging categories

​

Plugin logger categories

​

Search request slow logs

PUT /_cluster/settings
{
  "persistent": {
    "cluster.search.request.slowlog.level": "TRACE",
    "cluster.search.request.slowlog.threshold.warn": "10s",
    "cluster.search.request.slowlog.threshold.info": "5s",
    "cluster.search.request.slowlog.threshold.debug": "2s",
    "cluster.search.request.slowlog.threshold.trace": "10ms"
  }
}

[2023-10-30T15:47:42,630][TRACE][c.s.r.slowlog] [runTask-0] took[80.8ms], took_millis[80], phase_took_millis[{expand=0, query=39, fetch=22}], total_hits[4 hits], search_type[QUERY_THEN_FETCH], shards[{total: 10, successful: 10, skipped: 0, failed: 0}], source[{"query":{"match_all":{"boost":1.0}}}], id[]

​

Shard slow logs

GET <some-index>/_settings?include_defaults=true
{
	"indexing": {
		"slowlog": {
			"reformat": "true",
				"threshold": {
					"index": {
						"warn": "-1",
						"trace": "-1",
						"debug": "-1",
						"info": "-1"
					}
				},
				"source": "1000",
				"level": "TRACE"
				}
			},
			"search": {
				"slowlog": {
					"level": "TRACE",
					"threshold": {
						hreshold": { "fetch": {
							"warn": "-1",
							"trace": "-1",
							"debug": "-1"
							"info": "-1"
						},
						"query": {
							"warn": "-1",
							"trace": "-1",
							"debug": "-1",
							"info": "-1"
						}
					}
				}
			}
		}
		Để bật các nhật ký này, hãy tăng một hoặc nhiều ngưỡng:
		PUT <some-index>/_settings
		{
			"indexing": {
				"slowlog": {
					 "threshold": {
						  "index": {
							  "warn": "15s",
							  "trace": "750ms",
							  "debug": "3s",
							  "info":  "10s"
							  }
							},
							"source": "500",
							"level": "INFO"
						}
					}
				}

• reformat chỉ định liệu có ghi nhật ký trường _source của tài liệu dưới dạng một dòng duy nhất (true) hay cho phép nó trải rộng trên nhiều dòng (false).
• source là số ký tự của trường _source của tài liệu để ghi nhật ký.
• level là mức nhật ký tối thiểu cần bao gồm.

node1 | [2019-10-24T19:48:51,012][WARN][i.i.s.index] [node1] [some-index/i86iF5kyTyy-PS8zrdDeAA] took[3.4ms], took_millis[3], type[_doc], id[1], routing[], source[{"title":"Your Name", "Director":"Makoto Shinkai"}]

​

Task logs

PUT _cluster/settings
{
  "persistent": {
    "task_resource_consumers.enabled": "true"
  }
}

# Số lượng tác vụ tìm kiếm tốn kém cần ghi nhật ký
cluster.task.consumers.top_n.size: 100

# Khoảng thời gian ghi nhật ký
cluster.task.consumers.top_n.frequency: 30s

​

Deprecation logs