Instana 合成コードをCI/CDパイプラインに統合する

プロセスは、開発者がコード変更を GitHub リポジトリにコミットしてプッシュした時点で開始されます。

git push origin new-feature
 

CI/CDパイプラインは、 GitHub リポジトリを監視するように設定されています。 新たな変更を検出すると、自動的にビルドをトリガーします。

ビルドは GitHub, から最新のコードを取得し、コンパイルしてユニットテストまたは統合テストを実行します。

パイプラインは GitHub のコミットステータスを更新します。

• ビルドが失敗した場合：

  • 本番環境へのデプロイがブロックされています - 問題が解決されるまでパイプラインは停止します。

• ビルドが成功した場合：

  • パイプラインはデプロイメントに進みます。

ビルドが成功した場合、パイプラインは継続し、アプリのアップグレードをステージング環境またはテスト環境にデプロイします。

パイプラインは、更新された環境を対象に、既存の Instana Synthetic監視テスト（ OnDemand, ）を任意の数だけトリガーします。これには Instana api/synthetics/settings/tests/ci-cd API が使用されます。

これらのテストは、ユーザー操作をシミュレートし、アプリのパフォーマンス、レイテンシ、可用性を監視するために使用できます。

curl -s -X POST -H "Content-Type: application/json" -H "authorization: apiToken $INSTANA_API_TOKEN" \
  https://your-instance.instana.io/api/synthetics/settings/tests/ci-cd \
  -d '[ 
    {
      "testId":"<test-id>",
      "customization":{
        "locations":["<location-id>"],
        "configuration":{"timeout":"2m","retries":0}
      }
    }
  ]'
 

応答例:

[
  {
    "testResultId": "4e6451ba-7e47-487c-813d-5b95c73f391b",
    "testId": "<test-id>",
    "locationId": "<location-id>"
  }
] 
 

パイプラインは、以下のAPIを使用して OnDemand テストの完了を監視できます： Instana api/synthetics/settings/tests/ci-cdAPI および前述のサンプルレスポンスに示されている内容 testResultId 。

curl -s -H "Content-Type: application/json" -H "authorization: apiToken $INSTANA_API_TOKEN" \
  https://your-instance.instana.io/api/synthetics/settings/tests/ci-cd/4e6451ba-7e47-487c-813d-5b95c73f391b
 

応答例:

{
  "testResultId": "4e6451ba-7e47-487c-813d-5b95c73f391b",
  "locationId": "<location-id>",
  "locationLabel": "<location-label>",
  "testId": "<test-id>",
  "testLabel": "<test-label>",
  "testType": "<test-type>",
  "runType": "OnDemand",
  "completed": true,
  "customization": {"configuration":{"retries":0,"timeout":"2m"}}
}
 

テストの実行 OnDemand 結果（成功または失敗）の詳細は、Synthetic Playbackを使用して取得 api/synthetics/results/listAPI できます。

curl -s -H "Content-Type: application/json" -H "authorization: apiToken $INSTANA_API_TOKEN" \
  https://your-instance.instana.io/api/synthetics/results/list \
  -d '{
    "syntheticMetrics":["errors"],
    "tagFilterExpression":{
      "elements":[
        {"stringValue":"OnDemand","name":"synthetic.runType","operator":"EQUALS"},
        {"elements":[{"stringValue":"4e6451ba-7e47-487c-813d-5b95c73f391b","name":"id","operator":"EQUALS"}],"logicalOperator":"OR","type":"EXPRESSION"}
      ],
      "logicalOperator":"AND",
      "type":"EXPRESSION"
    },
    "pagination":{"page":1,"pageSize":5},
    "timeFrame":{"to":0,"windowSize":14400000}
  }'
 

応答例:

{
  "items":
  [
    {
      "testResultCommonProperties": 
        {
          "id": "4e6451ba-7e47-487c-813d-5b95c73f391b",
          "testId": "<test-id>",
          "testName": "<test-label>",
          "locationId": "<location-id>",
          "locationDisplayLabel": "<location-label>",
          "errors": ["{timeStamp=1759283474221, errorType=Assertion, errorMessage=Response time 1443.66ms exceeded 200msn}"],
          "runType": "OnDemand"
        }
    }
  ], 
  "page": 1,
  "pageSize": 5,
  "totalHits": 1
}
 

• OnDemand 合成テストが失敗した場合、パイプラインは次の処理を行います：

  • アプリケーションのアップグレードをロールバックする
  • ビルドに失敗する

• OnDemand 合成テストが成功した場合、パイプラインは次のことを行います：

  • アプリケーションのデプロイを維持する
  • ビルドを成功としてマークする