Documentation Oracle Cloud Infrastructure

Détails relatifs à la journalisation DevOps

Détails de journalisation pour les journaux DevOps.

Ressources

  • devopsproject

Catégories de journal

Valeur d'API (ID) : Console (nom d'affichage) Description
all Journaux DevOps Inclut tous les journaux liés au service DevOps.

Disponibilité

La journalisation DevOps est disponible dans toutes les régions des domaines commerciaux.

Commentaires

Vous pouvez activer les journaux DevOps pour un projet donné, ce qui signifie que les déploiements sont consignés pour tous les pipelines de ce projet. Pour plus d'informations, reportez-vous à Journaux DevOps.

Contenu d'un journal DevOps

Un enregistrement de journal DevOps contient les champs suivants :

Champ Description Exemple
specversion Version du schéma Oracle Cloud Infrastructure Logging. 1.0
type Catégorie du journal. Valeurs possibles :
  • build
  • deployment
 com.oraclecloud.devops.build, com.oraclecloud.devops.deployment
source Nom du projet auquel le journal est associé ou OCID du pipeline de construction auquel le journal appartient. myDemoProject, ocid1.devopsbuildpipeline.oc1.<region_ID>.<unique_ID>
subject OCID de la ressource cible dans laquelle le déploiement est exécuté ou OCID de l'exécution de construction du pipeline auquel les journaux appartiennent.
Valeurs possibles pour la ressource cible :
  • instance
  • fnfunc
  • cluster
 ocid1.devopsbuildrun.oc1.<region_ID>.<unique_ID>, ocid1.instance.oc1.<region_ID>.<unique_ID>
id UUID aléatoire, propre à chaque entrée de journal. e3002eaa-d717-472e-8474-d024943a0f27
time Heure de génération du journal dans le service DevOps. 2021-02-18T18:21:52.024Z
oracle.loggroupid OCID du groupe de journaux. ocid1.<loggroup>.oc1.<region_ID>.<unique_ID>
oracle.logid OCID de l'objet de journal de service. ocid1.log.oc1.<region_id>.<unique_ID>
oracle.tenantid OCID de la location. ocid1.<tenancy>.oc1..<unique_ID>
oracle.compartmentid OCID du compartiment auquel appartient le groupe de journaux. ocid1.<compartment>.oc1..<unique_ID>
oracle.ingestedtime Heure d'import du journal par OCILogging. 2021-02-18T18:22:01.453Z
data.buildRunId OCID de l'exécution de création auquel le message de journal est associé. ocid1.devopsbuildrun.oc1.<region_ID>.<unique_ID>
data.buildPipelineId OCID du pipeline de construction auquel le message de journal est associé. ocid1.devopsbuildpipeline.oc1.<region_ID>.<unique_ID>
data.buildStageId OCID de l'étape de pipeline de création à laquelle le message de journal est associé. ocid1.devopsbuildpipelinestage.oc1.<region_ID>.<unique_ID>
data.deploymentId OCID du déploiement auquel le message de journal est associé. ocid1.devopsdeployment.oc1.<region_ID>.<unique_ID>
data.deployPipelineId OCID de l'ID de pipeline de déploiement auquel le message de journal est associé. ocid1.devopsdeploypipeline.oc1.<region_ID>.<unique_ID>
data.deployStageId OCID de l'ID d'étape de déploiement auquel le message de journal est associé. ocid1.devopsdeploystage.oc1.<region_ID>.<unique_ID>
data.message Message de journal du service DevOps. Phase d'approbation manuelle : en attente des approbations requises.
data.producer Emetteur du message de journal. Certains des journaux sont générés par le code de service DevOps, tandis que d'autres sont générés par des scripts du client. Par exemple, le service de déploiement peut exécuter des scripts fournis par le client lors du déploiement vers des groupes d'instances. Ces scripts fournis par le client peuvent générer des messages STDOUT et STDERROR, également inclus dans le journal. Le champ du fournisseur peut les distinguer.
Valeurs possibles :
  • DEVOPS_SERVICE
  • USER_SCRIPT
  • USER_COMMAND
 DEVOPS_SERVICE

Exemples de journaux DevOps

Exemple de journal de build :

{
  "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"
  }
}

Exemple de journal de déploiement :

{
  "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"
  }
}

Utilisation de l'interface de ligne de commande pour afficher les journaux de déploiement

Exécutez la commande CLI suivante en fournissant les détails indiqués. Compartiment, groupe de journaux et journal associé au projet DevOps. Période, qui est liée à l'heure du déploiement. Vous pouvez filtrer le résultat par deploymentId :
  • REGION, par exemple, us-ashburn-1
  • START_YYYY_MM_DD, par exemple, 2023-01-09
  • END_YYYY_MM_DD, par exemple, 2023-01-10
  • COMPARTMENT_ID, par exemple, ocid1.compartment.oc1..<unique_ID>
  • LOG_GROUP, par exemple, ocid1.loggroup.oc1.<region_ID>.<unique_ID>
  • LOG, par exemple, ocid1.log.oc1.<region_ID>.<unique_ID>
  • DEPLOYMENT_ID, par exemple, 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}'"

Exemple de sortie de journal :

{
  "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
    }
  }
}