NerdGraph 튜토리얼: Pathpoint 플로우 생성 및 관리

시사

이 기능은 아직 개발 중이지만 꼭 사용해 보시기 바랍니다!

이 기능은 현재 출시 전 정책 에 따라 미리보기 프로그램의 일부로 제공됩니다.

UI에서 빌드하는 대신 NerdGraph API를 사용하여 프로그래밍 방식으로 Pathpoint 플로우를 생성하고 관리할 수 있습니다.

플로우는 결제, 인증 또는 온보딩과 같은 하나의 비즈니스 여정을 나타냅니다. API를 통해 생성하고 관리하는 단위입니다. 플로우는 엔티티이므로, 각각에는 읽기, 업데이트 또는 삭제하는 데 사용하는 엔티티 GUID이(가) 있습니다.

모든 플로우는 4개 티어 계층 구조를 따르며, KPI는 플로우 레벨, 스테이지 레벨 또는 둘 다에 연결됩니다:

Flow
├── Flow KPIs
└── Stages
    ├── Stage KPIs
    └── Levels
        └── Steps
            └── Signals (entity GUIDs, alert condition GUIDs, or a dynamic query)

Pathpoint 자체에 대한 소개는 Pathpoint 시작하기를 참조하십시오.

시작하기 전에

필요한 것:

계정에서 Pathpoint가 활성화되었습니다.
requests를 인증하기 위한 뉴렐릭
귀하의 계정 ID.

플로우 작업

이러한 예제를 대화형으로 실행하려면 NerdGraph GraphiQL 탐색기를 열고 스키마에서 pathPoint을(를) 검색하십시오. 예제를 실행하기 전에 플레이스홀더를 자체 값: YOUR_ACCOUNT_ID, TARGET_ACCOUNT_ID, FLOW_GUID, SOURCE_FLOW_GUID, ENTITY_GUID, ANOTHER_ENTITY_GUID, ENTITY_NAME, ALERT_CONDITION_GUID 및 스테이지, 레벨, 스텝 ID로 교체하십시오.

플로우 생성

단일 뮤테이션으로 중첩된 스테이지, 레벨, 스텝 및 신호를 전달하여 플로우를 생성하십시오.

이는 3개의 단계를 포함하는 하나의 스테이지인 "Frontend"가 있는 "Checkout flow"를 생성합니다. "Login page"는 동적 쿼리로 엔티티를 일치시키고, "Cart service"는 GUID로 하나의 특정 엔티티를 고정하며, "Checkout errors"는 공지 조건을 고정합니다.

mutation {
  pathPointCreate(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    pathpoint: {
      name: "Checkout flow"
      description: "End-to-end checkout journey"
      category: "E-Commerce"
      refreshInterval: FIVE_MINUTES
      stages: [
        {
          name: "Frontend"
          healthRollup: AUTOMATIC_ROLL_UP
          levels: [
            {
              steps: [
                {
                  name: "Login page"
                  entitySearchQuery: {
                    query: "domain = 'BROWSER' AND type = 'APPLICATION' AND name = 'Login'"
                  }
                }
                {
                  name: "Cart service"
                  signals: [
                    { guid: "ENTITY_GUID", name: "Cart service", type: ENTITY }
                  ]
                }
                {
                  name: "Checkout errors"
                  signals: [
                    {
                      guid: "ALERT_CONDITION_GUID"
                      name: "Checkout error rate"
                      type: ALERT
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ) {
    guid
    name
    version
    message
    excludedKpis
    stages {
      totalCount
      items {
        id
        name
        levels {
          items {
            id
            steps {
              items {
                id
                name
              }
            }
          }
        }
      }
    }
  }
}

최상위 레벨의 KPI는 전체 플로우에 적용됩니다. 스테이지(stageKpis) 내부의 KPI는 해당 스테이지에만 적용됩니다. 둘 다 동일한 스키마를 사용합니다.

각 KPI의 timeWindow은(는) 고정된 기간으로 빌드된 relativeRange 또는 원시 NRQL 시간 표현식을 포함하는 customRange 중 하나를 사용하며, 둘 다 사용할 수는 없습니다.

mutation {
  pathPointCreate(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    pathpoint: {
      name: "Checkout flow"
      refreshInterval: FIVE_MINUTES
      kpis: [
        {
          name: "Order success rate"
          category: "Revenue"
          description: "Orders completed successfully"
          query: {
            from: "Transaction"
            where: "transactionType = 'Web' AND name = 'checkout'"
            select: { aggregationType: COUNT, alias: "orders" }
            timeWindow: {
              relativeRange: {
                since: TWENTY_FOUR_HOURS
                compareAgainst: SEVEN_DAYS
              }
            }
          }
        }
      ]
      stages: [
        {
          name: "Payment"
          stageKpis: [
            {
              name: "Payment errors"
              category: "Reliability"
              query: {
                from: "TransactionError"
                select: { aggregationType: COUNT, alias: "errors" }
                timeWindow: { customRange: "SINCE 30 minutes ago" }
              }
            }
          ]
          levels: [
            {
              steps: [
                {
                  name: "Payment gateway"
                  config: {
                    healthRollup: WORST_STATUS_WINS
                    thresholdType: FIXED
                    thresholdValue: 1
                  }
                  entitySearchQuery: {
                    query: "domain = 'APM' AND name = 'PaymentGateway'"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ) {
    guid
    name
    version
    excludedKpis
    kpis {
      id
      name
      category
      query {
        from
        where
        select {
          aggregationType
          attribute
          alias
        }
        timeWindow {
          customRange
          relativeRange {
            since
            compareAgainst
          }
        }
      }
    }
  }
}

플로우와 각 스테이지는 두 가지 방법 중 하나로 상태를 계산하며, 해당 레벨의 healthRollup 필드를 사용하여 설정합니다.

플로우 레벨에서 healthRollup은(는) 플로우의 전반적인 상태가 도출되는 방식을 제어합니다:

Automatic rollup (AUTOMATIC_ROLL_UP, 기본값): 상태는 플로우의 스테이지에서 자동으로 롤업됩니다. 플로우의 전체 상태에서 제외하려면 스테이지에 isExcluded: true을(를) 설정하십시오. 해당 스테이지 자체의 레벨, 단계 및 신호는 여전히 평가되며 UI에 계속 표시됩니다. 스테이지는 플로우의 상태에 영향을 미치지 않게 되며, 이는 구축 중이거나 일시적으로 범위를 벗어난 스테이지에 유용합니다. 기본값인 isExcluded: false은(는) 스테이지가 정상적으로 참여함을 의미합니다.

Alert conditions (ALERT_CONDITIONS): 상태는 스테이지 롤업 대신 플로우의 KPI에 대한 공지 조건에서 가져옵니다. 플로우 레벨 kpis과(와) 페어링하십시오.

동일한 두 가지 방법이 스테이지 수준에 적용되며, 스테이지 자체의 healthRollup 필드로 설정됩니다. AUTOMATIC_ROLL_UP은(는) 해당 스테이지의 수준에서 단계와 신호를 통해 롤업됩니다. 해당 계산에서 제외하려면 단계, 신호 또는 entitySearchQuery에 isExcluded: true을(를) 설정하십시오. 대신 ALERT_CONDITIONS은(는) 스테이지의 상태를 자체 KPI(stageKpis) 중 하나에 연결합니다. 이는 마케팅 캠페인 스테이지의 이메일 오픈율 KPI와 같이 단계 및 신호 텔레메트리보다 비즈니스 성과를 반영해야 하는 상태를 가진 스테이지에 적합합니다.

플로우 레벨 및 스테이지 레벨 설정은 독립적이므로, 플로우는 한 가지 방법을 사용하고 스테이지는 다른 방법을 사용할 수 있습니다.

이 예제는 두 개의 스테이지를 가지며 자체적인 전반적인 상태를 위해 AUTOMATIC_ROLL_UP을(를) 사용하는 "Checkout flow"를 생성합니다. "Revenue"는 "Payment errors" KPI에 연결된 ALERT_CONDITIONS을(를) 사용하고, "Frontend"는 상태에서 하나의 신호를 제외하면서 AUTOMATIC_ROLL_UP을(를) 사용합니다.

mutation {
  pathPointCreate(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    pathpoint: {
      name: "Checkout flow"
      description: "End-to-end checkout pipeline"
      refreshInterval: FIVE_MINUTES
      healthRollup: AUTOMATIC_ROLL_UP
      stages: [
        {
          name: "Revenue"
          healthRollup: ALERT_CONDITIONS
          related: { source: false, target: true }
          stageKpis: [
            {
              name: "Payment errors"
              category: "Reliability"
              query: {
                from: "TransactionError"
                select: { aggregationType: COUNT, alias: "errors" }
              }
            }
          ]
          levels: [
            {
              steps: [
                {
                  name: "Order service"
                  config: { healthRollup: WORST_STATUS_WINS }
                  entitySearchQuery: {
                    query: "domain = 'APM' AND name = 'OrderService'"
                  }
                }
              ]
            }
          ]
        }
        {
          name: "Frontend"
          healthRollup: AUTOMATIC_ROLL_UP
          related: { source: true, target: false }
          levels: [
            {
              steps: [
                {
                  name: "Login page"
                  config: {
                    healthRollup: WORST_STATUS_WINS
                    thresholdType: FIXED
                    thresholdValue: 1
                  }
                  entitySearchQuery: {
                    query: "domain = 'BROWSER' AND name = 'Login'"
                  }
                  signals: [
                    {
                      guid: "ENTITY_GUID"
                      name: "ENTITY_NAME"
                      type: ENTITY
                      isExcluded: true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ) {
    guid
    name
    message
  }
}

pathPointCreate 계정 scope이(가) 필요합니다. 페이로드 내에서는 name만 필요합니다. stages을(를) 포함한 다른 모든 것은 선택 사항입니다. 단계는 세 가지 방법 중 하나로 신호를 가져오며, 이를 결합할 수 있습니다:

A dynamic query (entitySearchQuery): 쿼리와 일치하는 모든 엔티티이며, 새로 고칠 때마다 다시 평가됩니다.
A pinned entity (type: ENTITY): GUID로 식별되는 하나의 특정 엔티티입니다.
A pinned alert condition (type: ALERT): GUID로 식별되는 하나의 공지 조건입니다.

type 필드는 선택 사항입니다. GUID만으로도 신호를 식별하기에 충분합니다.

스테이지는 또한 상태 롤업과 독립적으로 UI가 스테이지 사이의 커넥터 화살표를 그리는 방법을 제어하는 선택적 related 블록을 사용합니다. 스테이지가 이전 스테이지에서 들어오는 화살표를 표시해야 하는 경우 source: true을(를) 설정하고, 다음 스테이지로 나가는 화살표를 표시해야 하는 경우 target: true을(를) 설정하십시오. 모든 스테이지가 순서대로 다음 스테이지에 연결되는 플로우에서 첫 번째 스테이지는 source: false, target: true이고 마지막 스테이지는 source: true, target: false이며, 그 사이의 모든 스테이지는 둘 다에 대해 true 입니다.

중요

KPI의 accountId은(는) 기본적으로 플로우의 계정으로 설정됩니다. 다른 계정으로 설정하면 KPI가 생성되지 않으며 오류도 반환되지 않습니다. 응답의 excludedKpis 필드를 확인하여 뮤테이션이 건너뛴 KPI를 확인하십시오.

플로우 읽기

엔티티 GUID로 플로우를 읽어 전체 설정과 플로우, 각 스테이지, 각 레벨 및 각 스텝의 현재 상태를 가져옵니다. healthStatus은(는) 읽기에만 나타납니다.

스테이지, 레벨 및 단계는 페이지당 50개의 항목을 반환합니다. nextCursor이(가) null이 아닌 값으로 반환되면, 이를 전달하여 다음 페이지를 가져오십시오.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      pathPoint {
        flow(guid: "FLOW_GUID") {
          guid
          name
          description
          category
          refreshInterval
          healthRollup
          healthStatus
          version
          message
          kpis {
            id
            name
            category
            accountId
            query {
              from
              where
              select {
                aggregationType
                attribute
                alias
                threshold
              }
              timeWindow {
                customRange
                relativeRange {
                  since
                  compareAgainst
                }
              }
            }
            metricQuery
          }
          stages {
            totalCount
            nextCursor
            items {
              id
              name
              link
              healthRollup
              healthStatus
              isExcluded
              related {
                source
                target
              }
              levels {
                totalCount
                nextCursor
                items {
                  id
                  healthStatus
                  steps {
                    totalCount
                    nextCursor
                    items {
                      id
                      name
                      healthStatus
                      isExcluded
                      scopedAccounts
                      config {
                        healthRollup
                        thresholdType
                        thresholdValue
                      }
                      entitySearchQuery {
                        query
                        isExcluded
                      }
                      signals {
                        guid
                        name
                        type
                        isExcluded
                      }
                    }
                  }
                }
              }
            }
          }
          metadata {
            createdAt
            createdBy {
              name
              email
            }
            updatedAt
            updatedBy {
              name
              email
            }
          }
        }
      }
    }
  }
}

전체 트리가 필요하지 않은 경우 더 적은 필드를 요청하십시오. 예를 들어 name 및 healthStatus만 읽어도 플로우의 상태를 폴링하기에 충분합니다.

플로우 업데이트

pathPointUpdate diff 기반 작업입니다. 전송한 페이로드를 플로우의 현재 상태와 비교하고 ID 포함 여부에 따라 각 스테이지, 레벨, 단계 및 KPI에 대해 작동합니다:

ID included: 기존 객체를 업데이트합니다.
ID omitted: 새 객체를 생성합니다.
Object left out of the payload entirely: 플로우에서 삭제합니다.

주의

생략은 삭제를 의미하므로, 항상 먼저 플로우를 읽고, 반환된 페이로드를 수정한 다음, 의도한 전체 상태를 전송하십시오. 부분적인 페이로드를 전송하면 누락된 모든 항목이 삭제됩니다.

version 필드도 필요합니다. 낙관적 동시성 제어에 사용되는 에포크 밀리초 단위의 플로우의 마지막 업데이트 타임스탬프입니다. 이를 생략하거나 오래된 값을 보내면 업데이트가 실패합니다.

첫 번째 스텝에는 id이(가) 포함되어 있으므로 제자리에서 업데이트됩니다. 두 번째 스텝에는 id이(가) 없으므로 새로 생성됩니다.

mutation {
  pathPointUpdate(
    guid: "FLOW_GUID"
    pathpoint: {
      name: "Checkout flow"
      refreshInterval: FIVE_MINUTES
      version: 1786624914316
      stages: [
        {
          id: "STAGE_ID"
          name: "Frontend"
          healthRollup: AUTOMATIC_ROLL_UP
          levels: [
            {
              id: "LEVEL_ID"
              steps: [
                {
                  id: "STEP_ID"
                  name: "Cart service"
                  signals: [
                    { guid: "ENTITY_GUID", name: "Cart service", type: ENTITY }
                  ]
                }
                {
                  name: "Recommendation service"
                  signals: [
                    {
                      guid: "ANOTHER_ENTITY_GUID"
                      name: "Recommendation service"
                      type: ENTITY
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ) {
    guid
    name
    version
    message
    stages {
      totalCount
      items {
        id
        name
        levels {
          items {
            id
            steps {
              items {
                id
                name
              }
            }
          }
        }
      }
    }
  }
}

플로우 복제

구조만 복제하거나 전체 플로우를 복제할 수 있습니다:

STRUCTURE: 시그널이나 KPI 없이 스테이지, 레벨 및 단계만 복사합니다.
WHOLE_FLOW: 신호 및 KPI와 함께 구조를 복사합니다.

입력에 설정한 모든 속성은 소스 플로우의 값을 재정의합니다. 속성을 상속하려면 해당 속성을 생략하십시오.

동일한 계정 내에서 복제하려면 scope 인수가 필요하지 않습니다. duplicateType: WHOLE_FLOW을(를) 설정하십시오.

mutation {
  pathPointDuplicate(
    sourceGuid: "SOURCE_FLOW_GUID"
    pathpoint: {
      name: "Checkout flow (copy)"
      category: "E-Commerce"
      refreshInterval: TEN_MINUTES
      duplicateType: WHOLE_FLOW
    }
  ) {
    guid
    name
  }
}

플로우를 다른 계정으로 복사하려면 scope을(를) 추가하고 해당 id을(를) 타겟 계정으로 설정하십시오. 소스 계정 내에서 복제하려면 scope을(를) 생략하십시오.

다른 계정으로 복제하면 KPI가 아닌 스테이지, 레벨, 단계 및 신호만 복사됩니다.

mutation {
  pathPointDuplicate(
    sourceGuid: "SOURCE_FLOW_GUID"
    scope: { id: TARGET_ACCOUNT_ID, type: ACCOUNT }
    pathpoint: { name: "Checkout flow", duplicateType: WHOLE_FLOW }
  ) {
    guid
    name
  }
}

신호나 KPI 없이 플로우의 형태만 복사하려면 duplicateType: STRUCTURE을(를) 설정하십시오.

mutation {
  pathPointDuplicate(
    sourceGuid: "SOURCE_FLOW_GUID"
    pathpoint: {
      name: "Checkout flow (copy)"
      category: "E-Commerce"
      refreshInterval: TEN_MINUTES
      duplicateType: STRUCTURE
    }
  ) {
    guid
    name
  }
}

플로우 삭제

플로우 삭제는 연쇄적으로 작용합니다: 모든 스테이지, 레벨, 단계 및 KPI와 함께 플로우를 제거합니다. 시그널 자체, 플로우가 가리키는 엔티티 및 공지 조건은 계정에 유지됩니다.

주의

플로우 삭제는 영구적입니다.

mutation {
  pathPointDelete(guid: "FLOW_GUID") {
    guid
    name
  }
}

부분 실패

개별 객체가 실패하더라도 전체적인 생성 또는 업데이트는 성공할 수 있습니다. 응답의 두 필드는 이러한 상황이 발생한 시기를 알려줍니다:

message: 실패한 스테이지, 레벨 또는 단계의 세부 정보입니다. 모든 것이 성공하면 null 입니다.
excludedKpis: 생성되지 않은 KPI의 이름으로, 가장 일반적인 이유는 KPI의 accountId이(가) 플로우의 계정과 일치하지 않기 때문입니다.

부분적인 성공을 완전한 성공으로 취급하지 않도록 뮤테이션에서 두 필드를 모두 요청하십시오.

제한

API를 통해 빌드하든 UI에서 빌드하든 모든 플로우에 다음 제한이 적용됩니다:

한계	값
플로우당 최대 스테이지 수	50
스테이지당 최대 레벨	50
레벨당 최대 스텝	50
페이지당 반환되는 최대 항목	50

유형 참조

이러한 열거형은 위의 작업에 나타납니다. 각 행에는 허용되는 값이 나열되며, 그 뒤에 제어하는 항목이 나열됩니다:

열거형	가치
`PathPointRefreshInterval`	`ONE_MINUTE` , `FIVE_MINUTES` , `TEN_MINUTES` , `FIFTEEN_MINUTES` , `THIRTY_MINUTES` . 플로우, 스테이지, 레벨 및 스텝 상태가 새로 고쳐지는 빈도입니다.
`PathPointFlowHealthRollup` , `PathPointStageHealthRollup`	`AUTOMATIC_ROLL_UP` , `ALERT_CONDITIONS` . 상태가 하위 객체에서 롤업되는지, 아니면 플로우 또는 스테이지의 KPI 전체에서 가장 나쁜 공지 조건에서 오는지 여부입니다.
`PathPointStepHealthRollup`	`WORST_STATUS_WINS` , `BEST_STATUS_WINS` . 스텝이 가장 상태가 나쁜 신호를 취할지 아니면 가장 상태가 좋은 신호를 취할지 여부입니다.
`PathPointThresholdType`	`FIXED` , `PERCENTAGE` . `thresholdValue` 이(가) 절대 개수인지 아니면 신호의 백분율인지 여부입니다.
`PathPointStatusValue`	`OPERATIONAL` , `DEGRADED` , `DISRUPTED` , `UNKNOWN` . 읽기 시 반환되는 컴퓨트 상태입니다.
`PathPointSignalType`	`ENTITY` , `ALERT` . GUID가 APM 서비스나 호스트와 같은 모니터 엔티티를 가리키는지, 아니면 공지 조건을 가리키는지 여부입니다.
`PathPointKpiNrqlAggregations`	`COUNT` , `SUM` , `AVERAGE` , `MAX` , `MIN` , `UNIQUE_COUNT` , `PERCENTILE` , `HISTOGRAM` . KPI 쿼리가 적용하는 집계입니다. `COUNT` 을(를) 제외한 모든 함수에는 `attribute` 이(가) 필요합니다.
`PathPointKpiTimeDuration`	`THIRTY_MINUTES` , `SIXTY_MINUTES` , `THREE_HOURS` , `SIX_HOURS` , `TWENTY_FOUR_HOURS` , `SEVEN_DAYS` , `THIRTY_DAYS` . KPI의 `since` 및 `compareAgainst` 에 대한 기간입니다.
`PathPointDuplicateType`	`STRUCTURE` , `WHOLE_FLOW` . 스테이지, 레벨 및 단계만 복사할지, 아니면 신호 및 KPI와 함께 구조를 복사할지 여부입니다.

Pathpoint 시작하기

Pathpoint가 무엇이며 어떻게 액세스하는지 알아보십시오.

플로우 생성 및 관리

UI에서 플로우를 빌드하고 구성하십시오.

NerdGraph 소개

뉴렐릭의 GraphQL API를 사용하는 방법을 알아보십시오.

사용자의 편의를 위해 제공되는 기계 번역입니다.

NerdGraph 튜토리얼: Pathpoint 플로우 생성 및 관리

시사

시작하기 전에

플로우 작업

플로우 생성

3개의 단계로 플로우를 생성하십시오.

KPI가 있는 플로우 생성

상태 롤업 계산

중요

플로우 읽기

플로우 업데이트

주의

기존 객체를 유지하면서 스텝 추가

플로우 복제

동일한 계정에서 전체 플로우 복제

전체 플로우를 다른 계정으로 복제

플로우의 구조 복제

플로우 삭제

주의

부분 실패

제한

유형 참조

Pathpoint 시작하기

플로우 생성 및 관리

NerdGraph 소개

사용자의 편의를 위해 제공되는 기계 번역입니다.

NerdGraph 튜토리얼: Pathpoint 플로우 생성 및 관리

시사

시작하기 전에 .css-21sua1{background:none;border:none;width:0;padding:0;}

플로우 작업

플로우 생성

KPI가 있는 플로우 생성

상태 롤업 계산

중요

플로우 읽기

플로우 업데이트

주의

기존 객체를 유지하면서 스텝 추가

플로우 복제

동일한 계정에서 전체 플로우 복제

전체 플로우를 다른 계정으로 복제

플로우의 구조 복제

플로우 삭제

주의

부분 실패

제한

유형 참조

관련 주제

Pathpoint 시작하기

플로우 생성 및 관리

NerdGraph 소개

시작하기 전에