SignalFx Smart Agent のコマンドリファレンス 🔗
このトピックでは、Smart Agent でよく使用されるコマンドについて説明します。
注釈
SignalFx Smart Agentのサポートが終了しました。エージェントはテレメトリをキャプチャして Splunk Observability Cloud にエクスポートできますが、Splunk はサポート、機能アップデート、セキュリティ、バグ修正を提供しなくなりました。このようなリクエストは SLA に拘束されません。
Splunk Distribution of OpenTelemetry Collectorでよく使用されるコマンドについては、Splunk Distribution of OpenTelemetry Collector コマンドリファレンス を参照してください。
Smart Agent の標準ポートは9080と8095です。デフォルトの設定は/etc/signalfx/agent.yamlに保存されています。
注釈
KubernetesクラスターにDaemonSetとしてエージェントをデプロイすると、エージェントの設定はエージェントのConfigMapによって管理されます。
次の表は、Smart Agent のすべてのコマンドとその使用法を示しています。コマンドをクリックすると、詳細な説明と構文の例が表示されます。
コマンド |
使用状況 |
|---|---|
Smart Agent Helmチャートリポジトリの削除 |
|
Smart Agent Helmチャートリポジトリのデプロイ |
|
Smart Agent Helmチャートリポジトリの追加 |
|
Smart Agent Helmチャートリポジトリの更新 |
|
ホスト上のエージェントログを確認する |
|
Kubernetesの設定を変更する |
|
Kubernetesリソースを作成する |
|
Kubernetesリソースを削除する |
|
Kubernetesのシステム構成を確認する |
|
Kubernetesリソースを編集する |
|
Kubernetesコンテナでコマンドを実行する |
|
Kubernetes上で稼働している1つまたは複数のリソースを表示する |
|
Kubernetesコンテナのログをチェックする |
|
ホスト上でエージェントを再起動する |
|
ホスト上でエージェントを起動する |
|
ホスト上のエージェントの状態を確認する |
|
エージェントに設定されているエンドポイントを確認する |
|
ホスト上のエージェントを停止する |
|
ホストに送信されているテールメトリクスのデータポイント |
helm delete 🔗
説明 🔗
Smart Agent Helmチャートリポジトリを削除します。
構文 🔗
helm delete signalfx-agent
helm install 🔗
説明 🔗
Smart Agent Helmチャートリポジトリをデプロイします。
構文 🔗
helm install \
--set signalFxAccessToken=$ACCESS_TOKEN \
--set clusterName=<MY-CLUSTER> \
--set kubeletAPI.url=https://localhost:10250 \
--set signalFxRealm=$REALM \
--set traceEndpointUrl=https://ingest.$REALM.signalfx.com/v2/trace \
--set gatherDockerMetrics=false \
signalfx-agent signalfx/signalfx-agent \
-f ~/workshop/k3s/values.yaml
helm repo add 🔗
説明 🔗
Smart Agent Helmチャートリポジトリを追加します。
構文 🔗
helm repo add signalfx https://dl.signalfx.com/helm-repo
# Use these two commands together to add and update the repository at the same time
helm repo add signalfx https://dl.signalfx.com/helm-repo && helm repo update
helm repo update 🔗
説明 🔗
Smart Agent Helmチャートリポジトリを更新します。
構文 🔗
helm repo update https://dl.signalfx.com/helm-repo
journalctl 🔗
説明 🔗
ホストのエージェントログを確認します。
構文 🔗
journalctl -u signalfx-agent | tail -f
tail -f /var/log/signalfx-agent.log
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
指定された systemd ユニット UNIT (サービスユニットなど)、または PATTERN でマッチしたユニットのメッセージを表示します。 |
|
ファイルの最後の部分を表示します。 |
kubectl config 🔗
説明 🔗
サブコマンドを使用してKubernetesの設定を変更します。サブコマンドとオプション引数の完全なリストについては、Kubectl Reference Documentationを参照してください。
構文 🔗
kubectl config [subcommand]
# Examples
# Show kubeconfig settings
kubectl config view
# Save namespace for all subsequent kubectl commands in context
kubectl config set-context --current --namespace=ggckad-s2
# Get the password for the e2e user
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
# Display the first user
kubectl config view -o jsonpath='{.users[].name}'
# Get a list of users
kubectl config view -o jsonpath='{.users[*].name}'
# Display list of contexts
kubectl config get-contexts
# Display the current-context
kubectl config current-context
# Set the default context to my-cluster-name
kubectl config use-context my-cluster-name
# Add a new user to your kubeconfig that supports basic authorization
kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword
# Set a context utilizing a specific username and namespace
kubectl config set-context gce --user=cluster-admin --namespace=foo \ && kubectl config use-context gce
kubectl create 🔗
説明 🔗
ファイルからリソースを作成します。使用可能なファイル形式はJSONとYAMLです。サブコマンドとオプション引数の完全なリストについては、Kubectl Reference Documentationを参照してください。
構文 🔗
sudo kubectl create -f <file-name>
# Examples
# Use the subcommand configmap to create a ConfigMap from a source file
sudo kubectl create configmap <map-name> --from-file=<file path>
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
リソースを作成するソースファイル |
|
ConfigMapを作成するソースファイルへのパス。 |
|
ConfigMapの名前 |
kubectl delete 🔗
説明 🔗
ソースファイルからリソースを削除します。サブコマンドとオプション引数の完全なリストは Kubectl Reference Documentation を参照してください。
構文 🔗
sudo kubectl delete -f <file-name>
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
リソースを削除するソースファイル |
kubectl describe 🔗
説明 🔗
Kubernetesのシステム構成を確認します。
構文 🔗
kubectl describe -n <namepsace> pod <pod-name>
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
コンフィギュレーションをチェックする名前空間 |
|
設定をチェックするポッド |
kubectl edit 🔗
説明 🔗
Kubernetesコンテナ上で動作するリソースを編集します。
構文 🔗
kubectl edit cm <name>
kubectl edit ds <name>
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
変更したい項目がConfigMapであることを指定する |
|
変更する項目がDaemonSetであることを指定する |
|
変更したいリソースの名前 |
kubectl exec 🔗
説明 🔗
Kubernetesコンテナでコマンドを実行します。
構文 🔗
kubectl exec <signalfx-agent-PODNAME> -- signalfx-agent status
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
ポッドの名前 |
|
エージェントの状態を確認する |
kubectl get 🔗
説明 🔗
Kubernetes上で稼働している1つまたは複数のリソースを表示します。
構文 🔗
kubectl get pods -n <namespace>
kubectl get configmap
kubectl get ds
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
ConfigMapを表示する |
|
デーモンセットを表示する |
|
名前空間 |
|
プロセス・ステータス出力形式ですべてのポッドをリストする |
kubectl logs 🔗
説明 🔗
Kubernetesコンテナのログをチェックします。
構文 🔗
sudo kubectl logs <pod-name | type/name> -l <label> -f -c <container-name>
# Examples
# Return snapshot logs from pod nginx with only one container
kubectl logs nginx
# Return snapshot logs from pod nginx with multiple containers
kubectl logs nginx --all-containers=true
# Return snapshot logs from all containers in pods defined by label app=nginx
kubectl logs -l app=nginx --all-containers=true
# Return snapshot of previous terminated ruby container logs from pod web-1
kubectl logs web-1 -p -c ruby
# Begin streaming the logs of the ruby container in pod web-1
kubectl logs web-1 -f -c ruby
# Begin streaming the logs from all containers in pods defined by label app=nginx
kubectl logs -f -l app=nginx --all-containers=true
# Display only the most recent 20 lines of output in pod nginx
kubectl logs nginx --tail=20
# Show all logs from pod nginx written in the last hour
kubectl logs nginx --since=1h
# Show logs from a kubelet with an expired serving certificate
kubectl logs nginx --insecure-skip-tls-verify-backend
# Return snapshot logs from first container of a job named hello
kubectl logs job/hello
# Return snapshot logs from container nginx-1 of a deployment named nginx
kubectl logs deployment/nginx -c nginx-1
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
trueの場合、Pod(s)内のすべてのコンテナのログを取得します。デフォルト値は |
|
ログの表示元のコンテナ |
|
新しいログエントリーが追加されるときに表示する |
|
ログが要求された kubelet の ID の検証をスキップします。サービス証明書の有効期限が切れたkubeletからログを取得する場合に使用します。 |
|
フィルターリングするラベル |
|
true の場合、Pod 内にコンテナの前のインスタンスが存在する場合に、そのインスタンスのログを表示します。デフォルト値は |
|
指定した期間内の最新のログのみを取得します |
|
表示する直近のログの行数 |
再起動 🔗
説明 🔗
ホスト上でエージェントを再起動します。
構文 🔗
sudo systemctl restart signalfx-agent
起動 🔗
説明 🔗
ホスト上でエージェントを起動します。
構文 🔗
sudo systemctl start signalfx-agent
status 🔗
説明 🔗
ホスト上のエージェントのステータスをチェックします。
構文 🔗
sudo signalfx-agent status
service signalfx-agent status
systemctl signalfx-agent status
ステータス・エンドポイント 🔗
説明 🔗
エージェントに設定されているエンドポイントを確認します。
構文 🔗
signalfx-agent status endpoints
停止 🔗
説明 🔗
ホスト上のエージェントを停止します。
構文 🔗
sudo systemctl stop signalfx-agent
tap-dps 🔗
説明 🔗
ホストに送信されているテールメトリクスのデータポイント。
構文 🔗
signalfx-agent tap-dps -h
signalfx-agent tap-dps -metric 'jenkins_*'
オプションの引数 🔗
引数 |
説明 |
|---|---|
|
コマンドの詳細を取得する |
|
説明はこちら |