Dettagli per il log DevOps

Dettagli di log per i log DevOps.

Risorse

  • oggetto di sviluppo

Categorie di log

Valore API (ID): Console (nome visualizzato) descrizione;
tutte DevOps Log Include tutti i log correlati al servizio DevOps.

Disponibilità

La registrazione DevOps è disponibile in tutte le aree dei regimi commerciali.

commenti

È possibile abilitare i log DevOps per un determinato progetto. Ciò significa che le distribuzioni vengono registrate per tutte le pipeline all'interno del progetto. Per ulteriori informazioni, vedere DevOps Log.

Contenuto di un log DevOps

Un record di log DevOps contiene i campi riportati di seguito.

Campo descrizione; Esempio
specversione Versione dello schema di Oracle Cloud Infrastructure Logging. 1.0
Tipo Categoria del log. Valori possibili:
  • creazione
  • implementazione
com.oraclecloud.devops.build, com.oraclecloud.devops.deployment
origine Nome del progetto a cui è associato il log o OCID della pipeline di build a cui appartiene il log. myDemoProject, ocid1.devopsbuildpipeline.oc1.<region_ID>.<unique_ID>
soggetto OCID della risorsa di destinazione in cui viene eseguita la distribuzione o OCID dell'esecuzione della build per la pipeline di build a cui appartengono i log.
Valori possibili per la risorsa di destinazione:
  • istanza
  • fnfunc
  • cluster
ocid1.devopsbuildrun.oc1.<region_ID>.<unique_ID>, ocid1.instance.oc1.<region_ID>.<unique_ID>
id UUID casuale, univoco per ogni voce del log. e3002eaa-d717-472e-8474-d024943a0f27
tempo Ora di generazione del log nel servizio DevOps. 2021-02-18T18:21:52.024Z
oracle.loggroupid OCID del gruppo di log. ocid1.<loggroup>.oc1.<region_ID>.<unique_ID>
oracle.logid OCID dell'oggetto log del servizio. ocid1.log.oc1.<region_id>.<unique_ID>
oracle.tenantid OCID della tenancy. ocid1.<tenancy>.oc1..<unique_ID>
oracle.compartmentid OCID del compartimento a cui appartiene il gruppo di log. ocid1.<compartment>.oc1..<unique_ID>
oracle.ingestedtime L'ora in cui il log è stato incluso da OCILogging. 2021-02-18T18:22:01.453Z
data.buildRunId OCID dell'esecuzione della build a cui è associato il messaggio di log. ocid1.devopsbuildrun.oc1.<region_ID>.<unique_ID>
data.buildPipelineId OCID della pipeline di build a cui è associato il messaggio di log. ocid1.devopsbuildpipeline.oc1.<region_ID>.<unique_ID>
data.buildStageId OCID della fase della pipeline di build a cui è associato il messaggio di log. ocid1.devopsbuildpipelinestage.oc1.<region_ID>.<unique_ID>
data.deploymentId OCID della distribuzione a cui è associato il messaggio di log. ocid1.devopsdeployment.oc1.<region_ID>.<unique_ID>
data.deployPipelineId OCID dell'ID pipeline di distribuzione a cui è associato il messaggio di log. ocid1.devopsdeploypipeline.oc1.<region_ID>.<unique_ID>
data.deployStageId OCID dell'ID fase di distribuzione a cui è associato il messaggio di log. ocid1.devopsdeploystage.oc1.<region_ID>.<unique_ID>
data.message Messaggio del log del servizio DevOps. Fase di approvazione manuale: in attesa delle approvazioni necessarie.
data.producer Producer del messaggio di log. Alcuni log sono prodotti dal codice servizio DevOps, mentre altri sono prodotti da script del cliente. Ad esempio, il servizio di distribuzione può eseguire script forniti dal cliente durante la distribuzione ai gruppi di istanze. Tali script forniti dal cliente potrebbero produrre messaggi STDOUT e STDERROR, inclusi anche nel log. Il settore dei produttori può distinguerli di conseguenza.
Valori possibili:
  • DEVOPS_SERVICE
  • USER_SCRIPT
  • USER_COMMAND
DEVOPS_SERVICE

Log DevOps di esempio

Log di build di esempio:

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

Log della distribuzione di esempio:

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

Uso dell'interfaccia CLI per visualizzare i log di distribuzione

Eseguire il comando CLI seguente fornendo i dettagli forniti. Il compartimento, il gruppo di log e il log associato al progetto DevOps. Intervallo di tempo correlato all'ora di distribuzione. È possibile filtrare il risultato in base a deploymentId:
  • REGIONE, ad esempio, us-ashburn-1
  • START_YYYY_MM_DD, ad esempio 2023-01-09
  • END_YYYY_MM_DD, ad esempio 2023-01-10
  • COMPARTMENT_ID, ad esempio ocid1.compartment.oc1..<unique_ID>
  • LOG_GROUP, ad esempio ocid1.loggroup.oc1.<region_ID>.<unique_ID>
  • LOG, ad esempio ocid1.log.oc1.<region_ID>.<unique_ID>
  • DEPLOYMENT_ID, ad esempio 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}'"

Output di log di esempio:

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