Documentation sur Oracle Cloud Infrastructure

Informations détaillées sur la journalisation pour le service DevOps

Détails de journalisation pour les journaux DevOps.

Ressources

  • devopsproject

Catégories de journaux

Valeur d'API (ID) : Console (Nom d'affichage) Description
all DevOps Logs Inclut tous les journaux associés au service DevOps.

Disponibilité

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

Commentaires

Vous pouvez activer des journaux du service DevOps pour un projet indiqué, ce qui signifie que les déploiements sont enregistrés pour tous les pipelines de ce projet. Pour plus d'informations, voir Journaux du service DevOps.

Contenu d'un journal du service DevOps

Un enregistrement de journal du service DevOps contient les champs suivants :

Champ Description Exemple
specversion Version de schéma du service Journalisation pour Oracle Cloud Infrastructure. 1.0
type Catégorie du journal. Valeurs possibles :
  • construction
  • 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 à laquelle le déploiement est exécuté ou OCID de l'exécution de la création pour le pipeline de construction 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, unique pour chaque entrée de journal. e3002eaa-d717-472e-8474-d024943a0f27
time Heure à laquelle le journal a été généré 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 à laquelle le journal a été ingéré par le service Journalisation pour OCI. 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 création auquel le message de journal est associé. ocid1.devopsbuildpipeline.oc1.<region_ID>.<unique_ID>
data.buildStageId OCID de l'étape de création de pipeline à 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 pipeline de déploiement auquel le message de journal est associé. ocid1.devopsdeploypipeline.oc1.<region_ID>.<unique_ID>
data.deployStageId OCID de l'ID é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. Manual Approval stage: Waiting for required approvals.
data.producer Fournisseur du message de journal. Certains journaux sont produits par le code du service DevOps, tandis que d'autres sont produits 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, qui sont également inclus dans le journal. Le champ de fournisseur peut les distinguer en conséquence.
Valeurs possibles :
  • DEVOPS_SERVICE
  • USER_SCRIPT
  • USER_COMMAND
 DEVOPS_SERVICE

Exemples de journaux DevOps

Exemple de journal de compilation :

{
  "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 voir les journaux de déploiement

Exécutez la commande CLI suivante fournissant les détails fournis. Compartiment, groupe de journaux et journal associés au projet DevOps. Intervalle de temps, qui est lié à l'heure du déploiement. Vous pouvez filtrer le résultat par deploymentId :
  • RÉGION, 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>
  • Journal, 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
    }
  }
}