Details zu DevOps-Logging

Loggingdetails für DevOps-Logs.

Ressourcen

devopsproject

Logkategorien


API-Wert (ID):	Konsole (Anzeigename)	Beschreibung
alle	DevOps-Logs	Enthält alle servicebezogenen DevOps-Logs.

Verfügbarkeit

DevOps-Logging ist in allen Regionen der kommerziellen Realms verfügbar.

Kommentare

Sie können DevOps-Logs für ein bestimmtes Projekt aktivieren. Das heißt, dass Deployments für alle Pipelines in diesem Projekt geloggt werden. Weitere Informationen finden Sie unter DevOps-Logs.

Inhalt eines DevOps-Logs

Ein DevOps-Logdatensatz enthält die folgenden Felder:


Feld	Beschreibung	Beispiel
specversion	Oracle Cloud Infrastructure Logging-Schemaversion.	1.0
type	Kategorie des Logs. Mögliche Werte: Erstellen deployment	com.oraclecloud.devops.build, com.oraclecloud.devops.deployment
source	Name des Projekts, dem das Log zugeordnet ist, oder OCID der Build-Pipeline, zu der das Log gehört.	myDemoProject, ocid1.devopsbuildpipeline.oc1.`<region_ID>`.`<unique_ID>`
subject	OCID der Zielressource, in der das Deployment ausgeführt wird, oder OCID der Build-Ausführung für die Build-Pipeline, zu der die Logs gehören. Mögliche Werte für Zielressource: instance fnfunc cluster	ocid1.devopsbuildrun.oc1.`<region_ID>`.`<unique_ID>`, ocid1.instance.oc1.`<region_ID>`.`<unique_ID>`
id	Zufällige UUID, die für jeden Logeintrag eindeutig ist.	e3002eaa-d717-472e-8474-d024943a0f27
time	Uhrzeit, zu der das Log im DevOps-Service generiert wurde.	2021-02-18T18:21:52.024Z
oracle.loggroupid	OCID der Loggruppe.	ocid1.`<loggroup>`.oc1.`<region_ID>`.`<unique_ID>`
oracle.logid	OCID des Servicelogobjekts.	ocid1.log.oc1.`<region_id>`.`<unique_ID>`
oracle.tenantid	OCID des Mandanten.	ocid1.`<tenancy>`.oc1..`<unique_ID>`
oracle.compartmentid	OCID des Compartments, zu dem die Loggruppe gehört.	ocid1.`<compartment>`.oc1..`<unique_ID>`
oracle.ingestedtime	Zeit, zu der das Log von OCILogging aufgenommen wurde.	2021-02-18T18:22:01.453Z
data.buildRunId	OCID des Build-Laufs, mit dem die Logmeldung verknüpft ist.	ocid1.devopsbuildrun.oc1.`<region_ID>`.`<unique_ID>`
data.buildPipelineId	OCID der Build Pipeline, mit der die Logmeldung verknüpft ist.	ocid1.devopsbuildpipeline.oc1.`<region_ID>`.`<unique_ID>`
data.buildStageId	OCID der Build-Pipeline-Phase, mit der die Logmeldung verknüpft ist.	ocid1.devopsbuildpipelinestage.oc1.`<region_ID>`.`<unique_ID>`
data.deploymentId	OCID des Deployments, mit dem die Logmeldung verknüpft ist.	ocid1.devopsdeployment.oc1.`<region_ID>`.`<unique_ID>`
data.deployPipelineId	OCID der Deployment-Pipeline-ID, mit der die Logmeldung verknüpft ist.	ocid1.devopsdeploypipeline.oc1.`<region_ID>`.`<unique_ID>`
data.deployStageId	OCID der Deployment-Phasen-ID, mit der die Logmeldung verknüpft ist.	ocid1.devopsdeploystage.oc1.`<region_ID>`.`<unique_ID>`
data.message	DevOps-Servicelogmeldung.	Manual Approval stage: Waiting for required approvals.
data.producer	Producer der Logmeldung. Manche Logs werden vom DevOps-Servicecode erzeugt, während andere Logs von Skripten des Kunden erzeugt werden. Beispiel: Während des Deployments in Instanzgruppen kann der Deployment-Service vom Kunden bereitgestellte Skripte ausführen. Solche vom Kunden bereitgestellten Skripte könnten STDOUT- und STDERROR-Meldungen erzeugen, die ebenfalls im Log enthalten sind. Im Producer-Feld können sie entsprechend unterschieden werden. Mögliche Werte: DEVOPS_SERVICE USER_SCRIPT USER_COMMAND	DEVOPS_SERVICE

DevOps-Beispiellogs

Beispiel-Build-Log:

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

Beispiel-Deployment-Log:

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

Deployment-Logs mit CLI anzeigen

Führen Sie den folgenden CLI-Befehl mit den angegebenen Details aus. Das Compartment, die Loggruppe und das mit dem DevOps-Projekt verknüpfte Log. Zeitraum, der sich auf den Zeitpunkt des Deployments bezieht. Sie können das Ergebnis nach deploymentId filtern:

REGION, z.B. us-ashburn-1
START_YYYY_MM_DD, Beispiel: 2023-01-09
END_YYYY_MM_DD, Beispiel: 2023-01-10
COMPARTMENT_ID, Beispiel: ocid1.compartment.oc1..<unique_ID>
LOG_GROUP, Beispiel: ocid1.loggroup.oc1.<region_ID>.<unique_ID>
LOG, z.B. ocid1.log.oc1.<region_ID>.<unique_ID>
DEPLOYMENT_ID, Beispiel: 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}'"

Beispiellogausgabe:

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

Oracle Cloud Infrastructure-Dokumentation