DevOpsロギングの詳細
DevOpsログのロギング詳細。
リソース
- devopsproject
ログ・カテゴリ
API値(ID): | コンソール(表示名) | 説明 |
---|---|---|
all | DevOpsログ | すべてのDevOpsサービス関連のログが含まれます。 |
可用性
DevOpsロギングは、商用レルムのすべてのリージョンで使用できます。
コメント
指定したプロジェクトに対してDevOpsログを有効にできます。これは、そのプロジェクト内のすべてのパイプラインでデプロイメントがログに記録されることを意味します。詳細は、DevOpsログを参照してください。
DevOpsログの内容
DevOpsログ・レコードには、次のフィールドが含まれます:
フィールド | 説明 | 例 |
---|---|---|
specversion | Oracle Cloud Infrastructure Loggingのスキーマ・バージョン。 | 1.0 |
type | ログのカテゴリ。使用可能な値:
|
com.oraclecloud.devops.build, com.oraclecloud.devops.deployment |
source | ログが関連付けられているプロジェクトの名前、またはログが属しているビルド・パイプラインのOCID。 | myDemoProject、ocid1.devopsbuildpipeline.oc1.<region_ID> .<unique_ID> |
subject | デプロイメントが実行されるターゲット・リソースのOCIDまたはログが属するビルド・パイプラインのビルド実行のOCID。 ターゲット・リソースに使用可能な値:
|
ocid1.devopsbuildrun.oc1.<region_ID> .<unique_ID> , ocid1.instance.oc1.<region_ID> .<unique_ID> |
id | 各ログ・エントリに固有のランダムUUID。 | e3002eaa-d717-472e-8474-d024943a0f27 |
time | ログがDevOpsサービスで生成された時間。 | 2021-02-18T18:21:52.024Z |
oracle.loggroupid | ログ・グループのOCID。 | ocid1.<loggroup>.oc1.<region_ID>.<unique_ID> |
oracle.logid | サービス・ログ・オブジェクトのOCID。 | ocid1.log.oc1.<region_id>.<unique_ID> |
oracle.tenantid | テナンシのOCID。 | ocid1.<tenancy>.oc1..<unique_ID> |
oracle.compartmentid | ログ・グループが属するコンパートメントのOCID。 | ocid1.<compartment>.oc1..<unique_ID> |
oracle.ingestedtime | ログがOCIロギングによって収集された時間。 | 2021-02-18T18:22:01.453Z |
data.buildRunId | ログ・メッセージが関連付けられているビルド実行のOCID。 | ocid1.devopsbuildrun.oc1.<region_ID> .<unique_ID> |
data.buildPipelineId | ログ・メッセージが関連付けられているビルド・パイプラインのOCID。 | ocid1.devopsbuildpipeline.oc1.<region_ID> .<unique_ID> |
data.buildStageId | ログ・メッセージが関連付けられているビルド・パイプライン・ステージのOCID。 | ocid1.devopsbuildpipelinestage.oc1.<region_ID> .<unique_ID> |
data.deploymentId | ログ・メッセージが関連付けられているデプロイメントのOCID。 | ocid1.devopsdeployment.oc1.<region_ID>.<unique_ID> |
data.deployPipelineId | ログ・メッセージが関連付けられているデプロイメント・パイプラインIDのOCID。 | ocid1.devopsdeploypipeline.oc1.<region_ID>.<unique_ID> |
data.deployStageId | ログ・メッセージが関連付けられているデプロイ・ステージIDのOCID。 | ocid1.devopsdeploystage.oc1.<region_ID>.<unique_ID> |
data.message | DevOpsサービス・ログ・メッセージ。 | Manual Approval stage: Waiting for required approvals. |
data.producer | ログ・メッセージのプロデューサ。一部のログはDevOpsサービス・コードによって生成され、その他のログは顧客からのスクリプトによって生成されます。たとえば、デプロイメント・サービスでは、インスタンス・グループへのデプロイメント中に顧客から提供されるスクリプトを実行できます。このような顧客提供のスクリプトでは、STDOUTおよびSTDERRORメッセージが生成される可能性があり、これらもログに含まれます。producerフィールドでは、これらをそれぞれ区別できます。 使用可能な値:
|
DEVOPS_SERVICE |
DevOpsログの例
サンプル・ビルド・ログ:
{
"specversion": "1.0",
"type": "com.oraclecloud.devops.build",
"source": "OCID of the build pipeline to which the log belongs",
"subject": "ocid1.devopsbuildrun.oc1.<region_ID>.<unique_ID>",
"id": "27868e6f-b91d-4318-868e-6fb91d9318e9",
"time": "2020-10-18T21:02:40.58Z",
"oracle": {
"logid": "ocid1.log.oc1.<region_ID>.<unique_ID>",
"loggroupid": "ocid1.<loggroup>.oc1.<region_ID>.<unique_ID>",
"tenantid": "ocid1.<tenancy>.oc1..<unique_ID>",
"compartmentid": "ocid1.<compartment>.oc1..<unique_ID>",
"ingestedtime": "2020-10-18T21:02:40.58Z",
},
"data": {
"buildPipelineId": "ocid1.devopsbuildpipeline.oc1.<region_ID>.<unique_ID>",
"buildRunId": "ocid1.devopsbuildrun.oc1.<region_ID>.<unique_ID>",
"buildStageId": "ocid1.devopsbuildpipelinestage.oc1.<region_ID>.<unique_ID>",
"message": ""Starting BUILD_SPEC_EXECUTION"",
"producer": "DEVOPS_SERVICE"
}
}
サンプル・デプロイメント・ログ:
{
"specversion": "1.0",
"type": "com.oraclecloud.devops.deployment",
"source": "Project name",
"subject": "ocid1.instance.oc1.<region_ID>.<unique_ID>",
"id": "e3002eaa-d717-472e-8474-d024943a0f27",
"time": "2020-10-18T21:02:40.58Z",
"oracle": {
"logid": "ocid1.log.oc1.<region_ID>.<unique_ID>",
"loggroupid": "ocid1.<loggroup>.oc1.<region_ID>.<unique_ID>",
"tenantid": "ocid1.<tenancy>.oc1..<unique_ID>",
"compartmentid": "ocid1.<compartment>.oc1..<unique_ID>",
"ingestedtime": "2020-10-18T21:02:40.58Z",
},
"data": {
"deploymentId": "ocid1.devopsdeployment.oc1.<region_ID>.<unique_ID>",
"deployPipelineId": "ocid1.devopsdeploypipeline.oc1.<region_ID>.<unique_ID>",
"deployStageId": "ocid1.devopsdeploystage.oc1.<region_ID>.<unique_ID>",
"message": "Manual Approval stage: Waiting for required approvals",
"producer": "DEVOPS_SERVICE"
}
}
CLIを使用したデプロイメント・ログの表示
指定された詳細を指定して、次のCLIコマンドを実行します。コンパートメント、ログ・グループおよびDevOpsプロジェクトに関連付けられたログ。デプロイ時間に関連する時間範囲。
deploymentId
で結果をフィルタできます。- REGION (例:
us-ashburn-1
) - START_YYYY_MM_DD (例:
2023-01-09
) - END_YYYY_MM_DD (例:
2023-01-10
) - COMPARTMENT_ID (例:
ocid1.compartment.oc1..<unique_ID>
) - LOG_GROUP (例:
ocid1.loggroup.oc1.<region_ID>.<unique_ID>
) - LOG (例:
ocid1.log.oc1.<region_ID>.<unique_ID>
) - DEPLOYMENT_ID (例:
ocid1.devopsdeployment.oc1.<region_ID>.<unique_ID>
)
oci logging-search search-logs --region ${REGION} --time-start ${START_YYYY_MM_DD} --time-end ${END_YYYY_MM_DD} --search-query "search \"${COMPARTMENT_ID}/${LOG_GROUP}/${LOG}\" | where data.deploymentId = '${DEPLOYMENT_ID}'"
サンプル・ログ出力:
{
"data": {
"fields": null,
"results": [
{
"data": {
"datetime": 1673308749702,
"logContent": {
"data": {
"deployPipelineId": "ocid1.devopsdeploypipeline.oc1.<region_ID>,<unique_ID>",
"deployStageId": "",
"deploymentId": "ocid1.devopsdeployment.oc1.<region_ID>,<unique_ID>",
"message": "Starting Deployment execution",
"producer": "DEVOPS_SERVICE"
},
"id": "c871db9d-857a-498e-81ae-245fcf77e827",
"oracle": {
"compartmentid": "ocid1.compartment.oc1..<unique_ID>",
"ingestedtime": "2023-01-09T23:59:10.012Z",
"loggroupid": "ocid1.loggroup.oc1.<region_ID>,<unique_ID>",
"logid": "ocid1.log.oc1.<region_ID>,<unique_ID>",
"tenantid": "ocid1.tenancy.oc1..<unique-ID>"
},
"source": "my_proj",
"specversion": "1.0",
"subject": "",
"time": "2023-01-09T23:59:09.702Z",
"type": "com.oraclecloud.devops.deployment"
}
}
},
{
"data": {
"datetime": 1673308794062,
"logContent": {
"data": {
"deployPipelineId": "ocid1.devopsdeploypipeline.oc1.<region_ID>,<unique_ID>",
"deployStageId": "ocid1.devopsdeploystage.oc1.<region_ID>,<unique_ID>",
"deploymentId": "ocid1.devopsdeployment.oc1.<region_ID>,<unique_ID>",
"message": "Helm chart deployment completed",
"producer": "DEVOPS_SERVICE"
},
"id": "f90969d1-6fbc-49c1-928f-afc623829c64",
"oracle": {
"compartmentid": "ocid1.compartment.oc1..<unique_id>",
"ingestedtime": "2023-01-10T00:00:03.947Z",
"loggroupid": "ocid1.loggroup.oc1.<region_ID>,<unique_ID>",
"logid": "ocid1.log.oc1.<region_ID>,<unique_ID>",
"tenantid": "ocid1.tenancy.oc1..<unique_id>"
},
"source": "my_proj",
"specversion": "1.0",
"subject": "",
"time": "2023-01-09T23:59:54.062Z",
"type": "com.oraclecloud.devops.deployment"
}
}
}
],
"summary": {
"field-count": null,
"result-count": 28
}
}
}