프로필 실행

이 시나리오에서는 Talend API를 사용하여 프로필을 실행하여 프로젝트 품질을 개선합니다.

Method: POST
endpoint: api/v1/projects/quality/profiles/{id}/executions
payload:
    {
  "repository": "string",
  "authentication": {
    "username": "string",
    "passcode": "string"
  },
  "branch": "string",
  "workspace": "string",
  "client": "UI"
    }

1. 실행하려는 프로필의 ID를 가져오려면 GET api/v1/projects/quality/profiles 엔드포인트를 호출합니다.
2. 실행하려는 프로필의 ID를 기록합니다.
3. 프로필을 실행하려면 POST api/v1/projects/quality/profiles/{id}/executions 엔드포인트를 호출하십시오. 매개변수로 실행할 프로필의 ID를 추가합니다.
4. 본문 영역에 다음 정보를 입력합니다.

   파라메타 이름	값
   리포지토리	리포지토리 이름을 입력합니다.
   사용자 이름	사용자 이름을 입력하세요.
   비밀번호	비밀번호를 입력하세요.
   분기	분기 이름을 입력하세요.
   작업 영역	작업 영역 이름을 입력합니다.
   클라이언트	클라이언트 이름을 입력합니다.

   예:

    {
     "repository": "GIT",
     "authentication": {
       "username": "******",
       "passcode": "*************"
     },
     "branch": "master",
     "workspace": "PROJECT_73",
     "client": "UI"
   }

5. 호출을 발행하려면 실행을 클릭하십시오.

결과

다음은 응답의 예시입니다:

{
  "id": "67",
  "status": "FAILED",
  "startTimestamp": "2023-10-13 17:36",
  "duration": "2s",
  "specifications": [
    {
      "id": "69",
      "specification": {
        "id": "2",
        "name": "best-practice",
        "description": "This specification contains rules related to best practices",
        "operator": "is_Equal_to",
        "threshold": 100,
        "thresholdType": "PERCENTAGE",
        "createdBy": "system"
      },
      "status": "FAILED",
      "rules": [
        {
          "id": "77",
          "rule": {
            "id": "4",
            "name": "Active-tLogRow",
            "description": "Identify jobs with tLogRow components",
            "category": "COMPONENT",
            "severity": "MINOR",
            "operator": "is_less_than_or_Equal",
            "threshold": "5",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "30",
          "status": "FAILED"
        },
        {
          "id": "78",
          "rule": {
            "id": "5",
            "name": "JavaLogs",
            "description": "Identify jobs that contain java logs.",
            "category": "COMPONENT",
            "severity": "INFO",
            "operator": "is_less_than_or_Equal",
            "threshold": "50",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "4.56",
          "status": "PASSED"
        }
      ],
      "duration": "1s"
    }
  ],
  "sourceProvider": {
    "providerType": "LOCAL",
    "workspace": "D:\\Talend_Studio\\studio\\workspaces\\qtcmt_test",
    "project": "PROJECT_73"
  },
  "info": {
    "version": "7.3.1",
    "label": "PROJECT_73",
    "description": "Project imported from TalendPS organization",
    "productVersion": "Talend Real-time Big Data Platform-7.3.1.20221115_1012-patch",
    "type": "DQ",
    "bigData": false,
    "local": false
  },
  "inventory": {
    "total_artifact_assets": 258,
    "context_group": 11,
    "standard_job": 210,
    "standard_job_versions": 211,
    "standard_joblet": 24,
    "standard_joblet_versions": 24,
    "resource": 2,
    "resource_versions": 24,
    "bd_batch": 1,
    "bd_batch_versions": 1,
    "bd_batch_joblet": 0,
    "bd_batch_joblet_versions": 0,
    "bd_streaming": 1,
    "bd_streaming_versions": 1,
    "bd_streaming_joblet": 0,
    "bd_streaming_joblet_versions": 0,
    "route": 46,
    "route_versions": 46,
    "routelet": 1,
    "routelet_versions": 1
  },
  "commits": [
    {
      "id": "24b228d45561e0a741a0409195ef492437bf3",
      "date": "Tue Feb 21 01:29:11 2023 +0000",
      "author": "talend <talend@3bed803c5b79>",
      "message": "\tCreate Project: PRJ_731\n"
    }
  ]
}

이 예시에서 Active-tLogRow 규칙은 tLogRow 컴포넌트가 있는 작업을 찾습니다.조건에 정의된 바와 같이, 식별된 총 자산 수는 최대 임계값보다 작아야 하며, 여기서는 5입니다.

이 예시의 결과는 30입니다.규칙의 품질 검사가 실패했습니다.규칙의 상태는 실패입니다.각 규칙의 상태는 결과와 임계값 간의 비교를 기반으로 평가됩니다.

프로젝트의 전반적인 품질은 사양의 상태에 따라 결정됩니다.사양의 상태는 모든 규칙의 누적 결과 또는 상태에 의해 유효성이 검사됩니다.이 예시에서는 임계값이 100%로 설정되어 있습니다.여기서 단일 조건 또는 규칙이 실패하더라도 사양이 실패하고 상태는 실패로 설정됩니다.

임계값, 임계값 유형 및 연산자는 규칙과 사양이 Talend 프로젝트의 품질에 미치는 영향에 따라 업데이트될 수 있습니다.

모든 사양이 실행되면 실행 상태는 다음 조건에 따라 설정됩니다.

• 통과: 모든 사양이 통과된 경우의 상태.
• 실패함: 어떤 사양이라도 실패한 경우의 상태.
• 취소됨: 실행이 취소된 경우의 상태.
• 실행 중: 실행이 진행 중인 경우의 상태.

실행은 GET /api/v1/projects/quality/profiles/executions 엔드포인트를 사용하여 액세스할 수 있습니다.실행은 여러 기준에 따라 필터링할 수 있습니다: 특정 시작 시간부터의 실행 상태 또는 프로젝트 이름.

실행은 실행 ID 또는 상태, 시작 시간 또는 프로젝트 이름으로도 삭제될 수 있습니다.