Detalles del registro de DevOps

Detalles del registro para los logs de DevOps.

Recursos

devopsproject

Categorías de log


Valor de API (ID):	Consola (nombre mostrado)	Descripción
all	Logs de DevOps	Incluye todos los logs relacionados con el servicio DevOps.

Disponibilidad

El registro de DevOps está disponible en todas las regiones de los dominios comerciales.

Comentarios

Puede activar logs de DevOps para un proyecto determinado, lo que significa que los despliegues se registran para todos los pipelines incluidos en ese proyecto. Para obtener más información, consulte Logs de DevOps.

Contenido de un log de DevOps

Un registro de log de DevOps contiene los siguientes campos:


Campo	Descripción	Ejemplo
specversion	Versión del esquema de Oracle Cloud Infrastructure Logging.	1.0
type	Categoría del log. Posibles valores: compilación deployment	com.oraclecloud.devops.build, com.oraclecloud.devops.deployment
source	Nombre del proyecto al que está asociado el log o OCID del pipeline de creación al que pertenece el log.	myDemoProject, ocid1.devopsbuildpipeline.oc1.`<region_ID>`.`<unique_ID>`
subject	OCID del recurso de destino al que se está ejecutando el despliegue o OCID de la ejecución de compilación para el pipeline de creación al que pertenecen los logs. Posibles valores para el recurso de destino: instance fnfunc cluster	ocid1.devopsbuildrun.oc1.`<region_ID>`.`<unique_ID>`, ocid1.instance.oc1.`<region_ID>`.`<unique_ID>`
id	UUID aleatorio, único para cada entrada de log.	e3002eaa-d717-472e-8474-d024943a0f27
time	Hora a la que se generó el log en el servicio DevOps.	2021-02-18T18:21:52.024Z
oracle.loggroupid	OCID del grupo de logs.	ocid1.`<loggroup>`.oc1.`<region_ID>`.`<unique_ID>`
oracle.logid	OCID del objeto de log de servicio.	ocid1.log.oc1.`<region_id>`.`<unique_ID>`
oracle.tenantid	OCID del arrendamiento.	ocid1.`<tenancy>`.oc1..`<unique_ID>`
oracle.compartmentid	OCID del compartimento al que pertenece el grupo de logs.	ocid1.`<compartment>`.oc1..`<unique_ID>`
oracle.ingestedtime	Hora a la que OCILogging ingirió el log.	2021-02-18T18:22:01.453Z
data.buildRunId	OCID de la ejecución de creación con la que está asociado el mensaje de log.	ocid1.devopsbuildrun.oc1.`<region_ID>`.`<unique_ID>`
data.buildPipelineId	OCID del pipeline de creación con el que está asociado el mensaje de log.	ocid1.devopsbuildpipeline.oc1.`<region_ID>`.`<unique_ID>`
data.buildStageId	OCID de la etapa de creación del pipeline con la que está asociado el mensaje de log.	ocid1.devopsbuildpipelinestage.oc1.`<region_ID>`.`<unique_ID>`
data.deploymentId	OCID del despliegue al que está asociado el mensaje de log.	ocid1.devopsdeployment.oc1.`<region_ID>`.`<unique_ID>`
data.deployPipelineId	OCID del identificador de pipeline de despliegue al que está asociado el mensaje de log.	ocid1.devopsdeploypipeline.oc1.`<region_ID>`.`<unique_ID>`
data.deployStageId	OCID del ID de etapa de despliegue al que está asociado el mensaje de log.	ocid1.devopsdeploystage.oc1.`<region_ID>`.`<unique_ID>`
data.message	Mensaje del log del servicio DevOps.	Manual Approval stage: Waiting for required approvals.
data.producer	Productor del mensaje de log. Algunos de los logs son producidos por el código de servicio DevOps, mientras que otros logs son producidos por scripts del cliente. Por ejemplo, el servicio de despliegue puede ejecutar scripts proporcionados por el cliente durante el despliegue en grupos de instancias. Estos scripts proporcionados por el cliente pueden producir mensajes STDOUT y STDERROR, que también se incluyen en el log. El campo de productor puede distinguirlos como corresponde. Posibles valores: DEVOPS_SERVICE USER_SCRIPT USER_COMMAND	DEVOPS_SERVICE

Logs de ejemplo de DevOps

Log de creación de ejemplo:

{
  "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 de despliegue de ejemplo:

{
  "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 de la CLI para ver logs de despliegue

Ejecute el siguiente comando de la CLI con los detalles proporcionados. Compartimento, grupo de logs y log asociados al proyecto DevOps. Rango temporal, relacionado con la hora del despliegue. Puede filtrar el resultado por deploymentId:

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

Ejemplo de salida de log:

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

Documentación de Oracle Cloud Infrastructure