Prometheus スクレイピングの新しいターゲットの追加に関するチュートリアル: Amazon EKS クラスターと Kubernetes クラスター上の Redis OSS

サンプル Redis OSS ワークロードの名前空間を設定します。

REDIS_NAMESPACE=redis-sample

Fargate 起動タイプのクラスター上で Redis OSS を実行している場合は、Fargate プロファイルを設定する必要があります。プロファイルを設定するには、次のコマンドを入力します。MyCluster をクラスターの名前に置き換えます。

eksctl create fargateprofile --cluster MyCluster \
--namespace $REDIS_NAMESPACE --name $REDIS_NAMESPACE

次のコマンドを入力して、サンプル Redis OSS ワークロードをインストールします。

curl https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/sample_traffic/redis/redis-traffic-sample.yaml \
| sed "s/{{namespace}}/$REDIS_NAMESPACE/g" \
| kubectl apply -f -

インストールには、ポート 9121 で Redis OSS Prometheus メトリクスを公開する、my-redis-metrics という名前のサービスが含まれています。サービスの詳細を取得するには、次のコマンドを入力します。

kubectl describe service/my-redis-metrics  -n $REDIS_NAMESPACE

結果の Annotations セクションには、CloudWatch エージェントの Prometheus スクレイプ設定に一致する 2 つの注釈が表示されます。これにより、ワークロードを自動検出できます。

prometheus.io/port: 9121
prometheus.io/scrape: true

関連する Prometheus スクレイプの設定は、- job_name: kubernetes-service-endpoints または kubernetes-eks.yaml の kubernetes-k8s.yaml のセクションに記載されています。

次のコマンドのいずれかを入力して、最新バージョンの kubernetes-eks.yaml または kubernetes-k8s.yaml ファイルをダウンロードします。EC2 起動タイプの Amazon EKS クラスターの場合は、次のコマンドを入力します。

curl -O https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/prometheus-eks.yaml

Fargate 起動タイプの Amazon EKS クラスターの場合は、次のコマンドを入力します。

curl -O https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/prometheus-eks-fargate.yaml

Amazon EC2 インスタンスで実行されている Kubernetes クラスターの場合は、このコマンドを入力します。

curl -O https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/prometheus-k8s.yaml

テキストエディタでファイルを開き、cwagentconfig.json セクションを見つけます。次のサブセクションを追加し、変更を保存します。インデントが既存のパターンに従っていることを確認してください。

{
  "source_labels": ["pod_name"],
  "label_matcher": "^redis-instance$",
  "dimensions": [["Namespace","ClusterName"]],
  "metric_selectors": [
    "^redis_net_(in|out)put_bytes_total$",
    "^redis_(expired|evicted)_keys_total$",
    "^redis_keyspace_(hits|misses)_total$",
    "^redis_memory_used_bytes$",
    "^redis_connected_clients$"
  ]
},
{
  "source_labels": ["pod_name"],
  "label_matcher": "^redis-instance$",
  "dimensions": [["Namespace","ClusterName","cmd"]],
  "metric_selectors": [
    "^redis_commands_total$"
  ]
},
{
  "source_labels": ["pod_name"],
  "label_matcher": "^redis-instance$",
  "dimensions": [["Namespace","ClusterName","db"]],
  "metric_selectors": [
    "^redis_db_keys$"
  ]
},

セクションの追加により、Redis OSS メトリクスが CloudWatch エージェントの許可リストに配置されます。これらのメトリクスのリストについては、次のセクションを参照してください。

Prometheus をサポートする CloudWatch エージェントが既にこのクラスターにデプロイされている場合は、次のコマンドを入力してエージェントを削除する必要があります。

kubectl delete deployment cwagent-prometheus -n amazon-cloudwatch

次のいずれかのコマンドを入力して、更新した設定で CloudWatch エージェントをデプロイします。MyCluster と リージョンを設定に合わせて置き換えます。

EC2 起動タイプの Amazon EKS クラスターの場合は、次のコマンドを入力します。

kubectl apply -f prometheus-eks.yaml

Fargate 起動タイプの Amazon EKS クラスターの場合は、次のコマンドを入力します。

cat prometheus-eks-fargate.yaml \
| sed "s/{{cluster_name}}/MyCluster/;s/{{region_name}}/region/" \
| kubectl apply -f -

Kubernetes クラスターの場合は、このコマンドを入力します。

cat prometheus-k8s.yaml \
| sed "s/{{cluster_name}}/MyCluster/;s/{{region_name}}/region/" \
| kubectl apply -f -

環境変数を作成し、以下の値をデプロイに合わせて置き換えます。

DASHBOARD_NAME=your_cw_dashboard_name
REGION_NAME=your_metric_region_such_as_us-east-1
CLUSTER_NAME=your_k8s_cluster_name_here
NAMESPACE=your_redis_service_namespace_here

次のコマンドを入力して、ダッシュボードを作成します。

curl https://raw.githubusercontent.com/aws-samples/amazon-cloudwatch-container-insights/latest/k8s-deployment-manifest-templates/deployment-mode/service/cwagent-prometheus/sample_cloudwatch_dashboards/redis/cw_dashboard_redis.json \
| sed "s/{{YOUR_AWS_REGION}}/${REGION_NAME}/g" \
| sed "s/{{YOUR_CLUSTER_NAME}}/${CLUSTER_NAME}/g" \
| sed "s/{{YOUR_NAMESPACE}}/${NAMESPACE}/g" \