DataStaxエージェントの構成

address.yamlファイルでオプションを使用してDataStaxエージェントを構成します。

address.yaml構成ファイル

address.yaml

address.yamlファイルの場所は、インストールのタイプによって異なります。
  • パッケージ・インストール:/var/lib/datastax-agent/conf/address.yaml
  • tarボール・インストール:install_location/conf/address.yaml

cluster_name.conf

cluster_name.confファイルの場所は、インストールのタイプによって異なります。
  • パッケージ・インストール:/etc/opscenter/clusters/cluster_name.conf
  • tarボール・インストール:install_location/conf/clusters/cluster_name.conf

この address.yaml ファイルには、DataStaxエージェントの構成オプションが含まれています。

これらのプロパティのほとんどは、opscenterdマシン上のcluster_name.conf の[agent_config]で設定でき、プロパティはすべてのエージェントに自動的に伝播されます。特定のプロパティや状況によっては、該当するエージェント上のaddress.yamlでプロパティを直接設定する必要がある場合もあります。エージェントを手動でインストールする場合、ほとんどの環境で明示的に構成する必要があるプロパティはstomp_interfaceだけです。自動的にエージェントをインストールした場合stomp_interfaceは自動的に構成されます。

エージェントのステータスの表示とエージェントの問題のトラブルシューティングの詳細については、「エージェント・ビュー」を参照してください。

構成オプション

use_ssl
エージェントとopscenterdの間でSSL通信を使用するかどうかを指定します。STOMP接続とエージェントのHTTPサーバーの両方に影響します。opscenterd.confの[agents].use_sslに対応します。このオプションをtrueに設定すると、SSL接続がオンになります。例:use_ssl: true
stomp_port
opscenterdで使用されるstomp_port。例:stomp_port: 61620
stomp_interface
opscenterdマシンで到達可能なIPアドレス。接続はstomp_portで行われます。例:stomp_interface: 127.0.0.1
local_interface
ノードの識別に使用されるIP。cassandra.yamlでbroadcast_addressが設定されている場合はその設定と同じになりますが、設定されていない場合は通常、cassandra.yamlのlisten_addressと同じになります。nodetool ringが出力するアドレスとこのアドレスが同じであることを確認してください。例:local_interface: 172.10.0.2
agent_rpc_interface
エージェントのHTTPサーバーがリッスンするIP。複数リージョンのデプロイでは通常、これはプライベートIPになります。デフォルト:cassandra.yamlのrpc_interfaceに一致します。例:agent_rpc_interface: 172.10.0.2
agent_rpc_broadcast_address
中央のOpsCenterプロセスがDataStaxエージェントに接続するために使用するIP。デフォルト:cassandra.yamlの解決可能なアドレスのうち、broadcast_rpc_address、rpc_address、listen_addressの順で最初に使用できるアドレス。例:agent_rpc_broadcast_address: 172.10.0.2
swagger_enabled
エージェントAPIのSwagger UIを有効または無効にします。例:swagger_enabled: true
opscenter_ssl_keystore
エージェントが実行されているターゲット・ノードで、エージェントがopscenterd変更の接続に使用するSSLキーストア・ファイルへのパス。例:opscenter_ssl_keystore: /usr/share/opscenter/ssl/agentKeystore
opscenter_ssl_keystore_password
エージェントがopscenterdに接続するために使用するSSLキーストアのパスワード。例:opscenter_ssl_keystore_password: keystore-pass [このフィールドはセキュリティ強化のために暗号化される場合があります。]
opscenter_ssl_truststore
エージェントがopscenterdに接続するために使用するトラストストア・ファイルのパス。例:opscenter_ssl_truststore: /usr/share/opscenter/ssl/agentKeystore
opscenter_ssl_truststore_password
エージェントがopscenterdに接続するために使用するSSLトラストストアのパスワード。デフォルト:SSLトラストストアのパスワードが指定されていない場合は、キーストアのパスワードを使用します。例:opscenter_ssl_truststore_password: trust-pass [このフィールドはセキュリティ強化のために暗号化される場合があります。]
opscenter_ssl_strict_subject_validation
証明書の対象がサーバーのIPと一致しない場合、opscenterdからの証明書を拒否するようにエージェントに指示します。このオプションはデフォルトでfalseになっています。つまり、エージェントは最初に対象の検証を試みます。検証に失敗した場合、エージェントは警告をログに記録し、対象の検証なしで接続を再試行します。OpsCenter の最新バージョンでは、デフォルトがtrueになるように変更されます。例: opscenter_ssl_strict_subject_validation: true
poll_period
メトリクスのポーリングの試行間隔(秒)。例:poll_period: 60
disk_usage_update_period
使用するディスクのポーリングの試行間隔(秒)。例:disk_usage_update_period: 60
rollup_rate
[rollup_rate_unit]期間にCassandraに保存できるメトリクスの最大数。minDefault: 200(デフォルトのrollup_rate_unitで200/秒)ごとに少なくとも([#tables] * 40) + 200である必要があります。例: rollup_rate: 200
rollup_rate_unit
rollup_rateの時間の単位。マイクロ秒、ミリ秒、秒、分、時間、日、月から選択します。デフォルトは秒です。例:rollup_rate_unit: second
bypass_dse_metrics_storage
監視対象のDSEクラスターまたは別のストレージDSEクラスターへのメトリクスの格納を有効または無効にします。デフォルトでは、メトリクスはDSEの監視対象のクラスターまたはストレージ・クラスターに格納されます。デフォルト:false。例:bypass_dse_metrics_storage: true
jmx_host
ローカルのJMXサーバーに接続する際に使用されるホスト。デフォルト設定はlocalhostです。この情報は便宜上opscenterdから送信されますが、必要に応じてローカルに構成することも可能です。例:jmx_host: 127.0.0.1
jmx_port
ローカルのJMXサーバーに接続する際に使用されるポート。デフォルト設定は7199です。この情報は便宜上opscenterdから送信されますが、必要に応じてローカルに構成することも可能です。例:jmx_port: 7199
jmx_user
ローカルのJMXサーバーに接続する際に使用されるユーザー名。例:jmx_user: jmx-username
jmx_pass
ローカルのJMXサーバーに接続する際に使用されるパスワード。例:jmx_pass: jmx-password [このフィールドはセキュリティ強化のために暗号化される場合があります。]
jmx_queue_poll_timeout
JMX接続が使用可能になるまで待機する時間(秒)。この時間を経過するとタイムアウトします。デフォルト:10。例:jmx_queue_poll_timeout: 10
status_reporting_interval
エージェントの健全性情報の送信間隔(秒)。例:status_reporting_interval: 20
disk_wait
メトリクス収集時のディスク操作の待機時間(ミリ秒)。デフォルト:5000。例:disk_wait: 5000
ec2_metadata_api_host
ec2上にある場合にこのノードに関する情報を判断するために使用されるec2メタデータのAPIホスト。例:ec2_metadata_api_host: 169.254.169.254
metrics_enabled
ローカル・ノードのメトリクスを収集し、格納するかどうかを設定します。このオプションをfalseに設定すると、メトリクス収集がオフになります。デフォルト:true。例:metrics_enabled: true
jmx_metrics_threadpool_size
JMXでメトリクスを収集する際に使用されるスレッド・プールのサイズ。例:jmx_metrics_threadpool_size: 6
metrics_ignored_keyspaces
メトリクス収集時に無視されるキースペースのコンマ区切りリスト。例:metrics_ignored_keyspaces: ks1, ks2, ks3
metrics_ignored_column_families
メトリクス収集時に無視されるテーブルのコンマ区切りリスト(旧名はカラム・ファミリー)。例:metrics_ignored_column_families: ks1.cf1, ks1.cf2, ks2.cf1
metrics_ignored_solr_cores
メトリクス収集時に無視されるSolrコアのコンマ区切りリスト。例:metrics_ignored_solr_cores: ks1.cf1, ks1.cf2, ks2.cf1
hosts
OpsCenterデータの格納を担当するDataStax Enterpriseノード。デフォルトではローカル・ノードですが、別のクラスターにデータを格納するように構成することもできます。hostsオプションは、ノードのIPアドレスを指定する一連の文字列を受け入れます。例:["1.2.3.4"]["1.2.3.4", "1.2.3.5"]などです。例:hosts: ["127.0.0.1"]
cassandra_port
ストレージのcassandraノードに接続する際に使用するポート。ネイティブ・トランスポート・ポート。例:cassandra_port: 9042
thrift_port
ストレージのThriftサーバー接続する際に使用するポート。デフォルト設定は9160です。この情報は便宜上opscenterdから送信されますが、必要に応じてローカルに構成することも可能です。例:thrift_port: 9160
cassandra_user
認証が有効になっている場合に、ストレージのcassandraへの接続に使用するユーザー名。例:cassandra_user: cassandra
cassandra_pass
認証が有効になっている場合に、ストレージのcassandraへの接続に使用するパスワード。例:cassandra_pass: cassandra [このフィールドはセキュリティ強化のために暗号化される場合があります。]
max_reconnect_time
cassandraの再接続試行時のエージェントの最大待機時間(ms)。例:max_reconnect_time: 15000
max_pending_repairs
保留になっている可能性があるリペアの最大数。この数を超えると、新たなリペアはブロックされます。例:max_pending_repairs: 5
ssl_keystore
エージェントがCQLに接続するために使用するストレージ・クラスターのSSLキーストアの場所。例:ssl_keystore: /etc/dse/conf/.keystore
ssl_keystore_password
エージェントがCQLに接続するために使用するストレージ・クラスターのSSLキーストアのパスワード。例:ssl_keystore_password: keystore-pass [このフィールドはセキュリティ強化のために暗号化される場合があります。]
ssl_truststore
エージェントがCQLに接続するために使用するストレージ・クラスターのSSLトラスト・ストアの場所。例:ssl_truststore: /etc/dse/conf/.truststore
ssl_truststore_password
エージェントがCQLに接続するために使用するストレージ・クラスターのSSLトラスト・ストアのパスワード。例:ssl_truststore_password: truststore-pass [このフィールドはセキュリティ強化のために暗号化される場合があります。]
monitored_cassandra_port
監視対象のcassandraノードに接続する際に使用するポート。ネイティブ・トランスポート・ポート。例:monitored_cassandra_port: 9042
monitored_thrift_port
監視対象のThriftサーバーに接続する際に使用するポート。デフォルト設定は9160です。この情報は便宜上opscenterdから送信されますが、必要に応じてローカルに構成することも可能です。例:monitored_thrift_port: 9160
monitored_cassandra_user
認証が有効になっている場合に、監視対象のcassandraへの接続に使用するユーザー名。例:monitored_cassandra_user: cassandra
monitored_cassandra_pass
認証が有効になっている場合に、監視対象のcassandraへの接続に使用するパスワード。例:monitored_cassandra_pass: cassandra-pass [このフィールドはセキュリティ強化のために暗号化される場合があります。]
monitored_ssl_keystore
エージェントがCQLに接続するために使用する監視対象クラスターのSSLキーストアの場所。例:monitored_ssl_keystore: /etc/dse/conf/.keystore
monitored_ssl_keystore_password
エージェントがCQLに接続するために使用する監視対象クラスターのSSLキーストアのパスワード。例:monitored_ssl_keystore_password: keystore-pass [このフィールドはセキュリティ強化のために暗号化される場合があります。]
monitored_ssl_truststore
エージェントがCQLに接続するために使用する監視対象クラスターのSSLトラスト・ストアの場所。例:monitored_ssl_truststore: /etc/dse/conf/.truststore
monitored_ssl_truststore_password
エージェントがCQLに接続するために使用する監視対象クラスターのSSLトラスト・ストアのパスワード。例:monitored_ssl_truststore_password: truststore-pass [このフィールドはセキュリティ強化のために暗号化される場合があります。]
kerberos_service
DSEでKerberos認証を使用したときに使用するKerberosサービス名。例:kerberos_service: cassandra-kerberos
kerberos_keytab_location
DSEでKerberos認証を使用したときのKerberosキータブの場所。例:kerberos_keytab_location: /path/to/keytab.keytab
kerberos_client_principal
DSEでKerberos認証を使用したときに使用するKerberosクライアントのプリンシパル。例:kerberos_client_principal: cassandra@hostname
storage_keyspace
エージェントがデータの格納に使用するキースペース。例:storage_keyspace: OpsCenter
alias
ノードの詳細をOpsCenterに送信する際にエージェントが使用する別名を指定します。この別名は、エージェントがInetAddress.getLocalHost()からローカルホスト名を取得できない場合に便利です。例:alias: MyNodeOne
storage_dse_connection_timeout
DSEクラスターへの接続試行時のエージェントの最大待機時間(秒)。デフォルト:30。例:storage_dse_connection_timeout: 30
storage_dse_host_read_timeout
ノードが応答しないと見なされるまで、ストレージ・ノードによって読み取り要求から応答が返されるまでエージェントが待機する最長時間(ミリ秒)。cassandra.yamlのread_request_timeout_in_msより高い値に設定する必要があります。例: storage_dse_host_read_timeout: 10000
monitored_dse_connection_timeout
DSEクラスターへの接続試行時のエージェントの最大待機時間(秒)。デフォルト:30。例:monitored_dse_connection_timeout: 30
monitored_dse_host_read_timeout
ノードが応答しないと見なされるまで、ストレージ・ノードによって読み取り要求から応答が返されるまでエージェントが待機する最長時間(ミリ秒)。cassandra.yamlのread_request_timeout_in_msより高い値に設定する必要があります。例:monitored_dse_host_read_timeout10000
cassandra_install_location
DataStax EnterpriseまたはCassandraがインストールされているベース・ディレクトリー。設定されていない場合、エージェントは場所の自動検出を試みますが、検出できない場合もあります。例:cassandra_install_location: /usr/share/dse
cassandra_log_location
DSEログが存在するディレクトリー。これは診断用tarボールでのみ使用され、これらのログがデフォルト以外の場所にある場合にのみ設定する必要があります。例:cassandra_log_location: /var/log/cassandra
cassandra_binary_location
Cassandraのバイナリー(cqlsh、nodetool、sstableloader)のディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:cassandra_binary_location: /usr/bin
cassandra_conf_location
Cassandraの構成ファイル(cassandra.yaml、cassandra-env.sh)のディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:cassandra_conf_location: /etc/dse/cassandra
dse_env_location
dse-env.shが保持されているディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:dse_env_location: /etc/dse
dse_binary_location
dsetoolが保持されているディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:dse_binary_location: /usr/bin
dse_conf_location
dse.yamlが保持されているディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:dse_conf_location: /etc/dse
spark_conf_location
spark-env.shが保持されているディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:spark_conf_location: /etc/dse/spark
spark_log_location
Sparkログが保持されているディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:spark_log_location: /var/log/spark
solr_log_location
Solrログが保持されているディレクトリーの場所。設定されていない場合、エージェントは場所の自動検出を試みます。例:solr_log_location: /var/log/cassandra
cassandra_rpc_interface
指定しない場合、エージェントはcassandra.yamlのrpc_addressを読み取ってcassandraのrpc_addressを決定しようとします。指定した場合はエージェント検索はスキップされ、代わりに指定された値が使用されます。例:cassandra_rpc_interface: 172.10.0.2
api_port
Http apiエンドポイントに使用するポート。例:api_port: 61621
runs_sudo
sudoを使用してDataStaxエージェントを実行するかどうかを設定します。このオプションをfalseに設定すると、エージェントでsudoは使用されず、エージェント・ユーザーは昇格した権限を使用して実行されません。このオプションをtrueに設定すると、エージェントはsudoと昇格した権限を使用して実行されます。デフォルトはtrueです。例:runs_sudo: true
s3_proxy_host
クライアントが接続に使用するオプションのプロキシ・ホスト。例: s3_proxy_host: localhost
s3_proxy_port
クライアントが接続に使用するオプションのプロキシ・ポート。例: s3_proxy_port: 80
destination-transfer-pool-size
デスティネーション・プロセス用に割り当てるスレッド・プールのサイズ。例: destination-transfer-pool-size: 10
destination-transfer-pool-keepalive
シャットダウンする前に、デスティネーション・プロセスのスレッド・プールのスレッドがアイドル状態を維持できる分数。スレッド・プールに対する需要が高まると、シャットダウンするスレッドが再び作成されます。例: destination-transfer-pool-keepalive: 2
restore_req_update_period
Backup Service(バックアップ・サービス)の復元操作中にopscenterdにステータス更新が送信される間隔(秒)。デフォルト:60。例:restore_req_update_period: 60
backup_staging_dir
DSEからディスクに書き込まれた後に、commitlogsがコピーされるディレクトリ。DataStaxエージェントは、このディレクトリを監視し、commitlogsを構成されたデスティネーションに移動します。すべてのデスティネーションが関連するコミット・ログを受け取ったら、ログはbackup_storage_dirに移動されます。commitlogsをステージ化できない場合、ログが蓄積されないため、このディレクトリは、ディレクトリのサイズ以上でなければなりません。デフォルトの場所は/var/lib/datastax-agent/commitlogs/です。例:backup_staging_dir: /var/lib/datastax-agent/commitlogs/
backup_storage_dir
すべての構成されたデスティネーションにコピーされた後の、commitlogバックアップが格納されるディレクトリ。保存先の場所「On Server」に対して構成された保持ポリシーに基づいて、ディレクトリがクリーンアップされます。ディレクトリには、保持ポリシーの期間の間commitlogsを保持するのに十分なスペースが確保されている必要があります。デフォルトの場所は/var/lib/datastax-agent/backups/です。例: backup_storage_dir: /var/lib/datastax-agent/backups/
tmp_dir
復元時に一時的にファイルをステージ化するために使用されるディレクトリ。デフォルトの場所は/var/lib/datastax-agent/tmpです。例:tmp_dir: /var/lib/datastax-agent/tmp/
remote_backup_retries
復元時にファイルのダウンロードが失敗したときの試行回数。デフォルト:3。例:remote_backup_retries: 3
remote_backup_timeout
バックアップをリモート・デスティネーションにプッシュする際に使用する接続のタイムアウト(ミリ秒)。デフォルト:1000。例:remote_backup_timeout: 1000
use_s3_cli
ラボ機能。バックアップをAmazon S3の場所に一括読み込みするときに、AWS SDKではなくAWS CLIの使用を有効にします。デフォルト:false。例: use_s3_cli: true
remote_verify_initial_delay
バックアップ操作時にファイルが正常にアップロードされたかどうかを確認するため待機する初期遅延(ミリ秒)。この構成オプションはremote_verify_maxオプションと併用して、SSTableをクリーンアップする際にバックアップが破損しているのか、または遅れているのかを区別することができます。remote_verify_initial_delayの値は、この値がremote_verify_maxの値を超えるまで、ファイル転送検証が失敗するたびに倍増します。デフォルト:1000(1秒)。例:remote_verify_initial_delay: 1000
remote_verify_max
ファイルのアップロードは完了したが、リモート・デスティネーションから読み取ることができない場合の最大待機時間。この遅延時間を超えると、転送は失敗と見なされます。この構成オプションは、remote_verify_initial_delayオプションと併用して、SSTableをクリーンアップする際にバックアップが破損しているのか、または遅れているのかを区別することができます。デフォルト:30000(30秒)。例:remote_verify_max: 300000
restore_on_transfer_failure
trueに設定すると、リモート・デスティネーションからのファイル転送が失敗しても、復元プロセスは停止されません。以降の復元では、転送に成功したファイルが使用されます。デフォルト:false。例:restore_on_transfer_failure: false
remote_backup_region
リモート・バックアップの転送に使用するAWSリージョン。デフォルト:us-west-1。例:remote_backup_region: us-west-1
max_file_transfer_attempts
ファイルのアップロード、またはリモート・デスティネーションの作成の最大試行回数。デフォルト:3。例:max_file_transfer_attempts: 30
sstableloader_max_heap_size
復元操作中にsstableloaderで使用される最大ヒープ・サイズ。DSE 4.8.4以降でのみサポートされています。デフォルト:256M。例:sstableloader_max_heap_size: 256M
trace_delay
Performance Service(パフォーマンス・サービス)の[Slow Queries]パネルでトレースするクエリーを発行してトレース・イベントをフェッチするまでの待機時間(ミリ秒)。デフォルト:300。例:trace_delay: 300
support_shell_timeout
nodetoolなどのシェル・プロセスが実行されるまで待機する時間(秒)。この時間を経過するとタイムアウトします。この設定は、診断用tarボールの生成にのみ使用されます。デフォルト:30。例:support_shell_timeout: 30
graphite_host
graphite_hostを設定すると、指定されたアドレスのGraphiteサーバーにメトリクスを転送できます。graphite_hostを空白にすると、Graphiteサーバーへのメトリクスの転送が無効になります。例:graphite_host: graphite.myhost.com
graphite_port
Graphiteのプレーンテキスト・プロトコルのポート。例:graphite_port: 2003
graphite_prefix
メトリクスを挿入するプレフィックス。例:graphite_prefix: opscenter
slow_query_past
スロー・クエリーをどこまで遡って検索するかを指定します(ミリ秒)。デフォルト:3600000(1,000時間)。例:slow_query_past: 3600000
slow_query_refresh
スロー・クエリーの更新間隔(秒)。デフォルト:5。例:slow_query_refresh: 5
slow_query_fetch_size
スロー・クエリーをフェッチする数の上限。デフォルト:500。例:slow_query_fetch_size: 500
slow_query_ignore
Performance Service(パフォーマンス・サービス)のスロー・クエリー・ログで無視されるキースペースのリスト。デフォルト:["OpsCenter" "dse_perf"] 例:slow_query_ignore: ["OpsCenter" "dse_perf"]
config_encryption_active
OpsCenterが機密構成値の復号化を試行するかどうかを指定します。デフォルト:False
config_encryption_key_name
暗号化キーに使用されるファイル名。カスタム名を指定しない場合、デフォルトでopsc_system_keyが使用されます。例:config_encryption_key_name: opsc_system_key
config_encryption_key_path
暗号化キーを配置する場所のパス。指定しない場合、デフォルトでaddress.yamlのディレクトリーが使用されます。例:config_encryption_key_path: /var/lib/datastax-agent/conf/
running-request-cache-size
実行中の要求のキャッシュのサイズ。例:running-request-cache-size: 500
finished-request-cache-size
終了した要求のキャッシュのサイズ。例:finished-request-cache-size: 100
tcp_response_timeout
JMXで使用されるTCP応答タイムアウト(ミリ秒)。この値は、大量のデータを使用してノートで実行されるいくつかの操作が完了できるように、非常に高く設定する必要がある場合があります。タイムアウトなしにするには、0を設定します。デフォルト:240000 例:tcp_response_timeout: 120000
pong_timeout_ms
stompを介したopscenterdからのpong応答の待機時間(ミリ秒)。この時間を経過するとpingがタイムアウトします。例:pong_timeout_ms: 5000
destination_pretest_timeout
デスティネーションへの読み取りと書き込みが可能であることを確認するための最大時間(秒)。デフォルト:60。例:destination_pretest_timeout: 60