Detalhes do Registro em Log do Serviço DevOps

Registrando detalhes de logs DevOps.

Recursos

devopsproject

Categoria de Log


Valor da API (ID):	Console (Nome para Exibição)	Descrição
all	Logs do Serviço DevOps	Inclui todos os logs relacionados ao serviço DevOps.

Disponibilidade

O log DevOps está disponível em todas as regiões dos realms comerciais.

Comentários

Você pode ativar logs do serviço DevOps para um determinado projeto, o que significa que as implantações são registradas para todos os pipelines dentro desse projeto. Para obter mais informações, consulte Logs do Serviço DevOps.

Conteúdo de um log do Serviço DevOps

Um registro de log do serviço DevOps contém os seguintes campos:


Campo	Descrição	Exemplo
specversion	Versão do esquema do Oracle Cloud Infrastructure Logging.	1.0
type	Categoria do log. Os valores possíveis são: criar implantação	com.oraclecloud.devops.build, com.oraclecloud.devops.deployment
source	Nome do Projeto ao qual o log está associado ou OCID do pipeline de compilação ao qual o log pertence.	myDemoProject, ocid1.devopsbuildpipeline.oc1.`<region_ID>`.`<unique_ID>`
subject	OCID do recurso de destino ao qual a implantação está sendo executada ou OCID da execução de build para o pipeline de build ao qual os logs pertencem. Valores possíveis para o recurso de destino: instância fnfunc cluster	ocid1.devopsbuildrun.oc1.`<region_ID>`.`<unique_ID>`, ocid1.instance.oc1.`<region_ID>`.`<unique_ID>`
id	UUID Aleatório, exclusivo de cada entrada de log.	e3002eaa-d717-472e-8474-d024943a0f27
time	A hora em que o log foi gerado no Serviço DevOps.	2021-02-18T18:21:52.024Z
oracle.loggroupid	OCID do grupo de logs.	ocid1.`<loggroup>`.oc1.`<region_ID>`.`<unique_ID>`
oracle.logid	OCID do objeto de log do serviço.	ocid1.log.oc1.`<region_id>`.`<unique_ID>`
oracle.tenantid	OCID da tenancy.	ocid1.`<tenancy>`.oc1..`<unique_ID>`
oracle.compartmentid	OCID do compartimento ao qual o grupo de logs pertence.	ocid1.`<compartment>`.oc1..`<unique_ID>`
oracle.ingestedtime	O horário em que o log foi ingerido por OCILogging.	2021-02-18T18:22:01.453Z
data.buildRunId	OCID da execução de compilação à qual a mensagem de log está associada.	ocid1.devopsbuildrun.oc1.`<region_ID>`.`<unique_ID>`
data.buildPipelineId	OCID do pipeline de criação ao qual a mensagem de log está associada.	ocid1.devopsbuildpipeline.oc1.`<region_ID>`.`<unique_ID>`
data.buildStageId	OCID do estágio do pipeline de criação ao qual a mensagem de log está associada.	ocid1.devopsbuildpipelinestage.oc1.`<region_ID>`.`<unique_ID>`
data.deploymentId	OCID da implantação à qual a mensagem de log está associada.	ocid1.devopsdeployment.oc1.`<region_ID>`.`<unique_ID>`
data.deployPipelineId	OCID do ID do pipeline de implantação com o qual a mensagem de log está associada.	ocid1.devopsdeploypipeline.oc1.`<region_ID>`.`<unique_ID>`
data.deployStageId	OCID do ID do estágio de implantação ao qual a mensagem de log está associada.	ocid1.devopsdeploystage.oc1.`<region_ID>`.`<unique_ID>`
data.message	Mensagem de log do serviço DevOps.	Estágio de Aprovação Manual: Aguardando aprovações necessárias.
data.producer	Produtor da mensagem de log. Alguns dos logs são gerados pelo código do serviço DevOps, e outros logs são gerados por scripts do cliente. Por exemplo, o serviço de implantação pode executar scripts fornecidos pelo cliente durante a implantação em grupos de instâncias. Tais scripts fornecidos pelo cliente podem gerar mensagens STDOUT e STDERROR, que também são incluídas no log. O campo produtor pode distingui-los adequadamente. Valores Possíveis: DEVOPS_SERVICE USER_SCRIPT USER_COMMAND	DEVOPS_SERVICE

Logs de Amostra DevOps

Log de build de amostra:

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

Exemplo de log de implantação:

{
  "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 da CLI para Exibir Logs de Implantação

Execute o seguinte comando da CLI fornecendo os detalhes fornecidos. O compartimento, o grupo de logs e o log associado ao projeto DevOps. O intervalo de tempo, que está relacionado ao horário de implantação. Você pode filtrar o resultado por deploymentId:

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

Saída de log de amostra:

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

Documentação do Oracle Cloud Infrastructure