공지조건에 대한 설명 템플릿

일부 조건 유형의 경우 더 나은 인시던트 대응이나 다른 시스템에서 사용하기 위해 유용한 정보를 다운스트림으로 전달하는 설명 템플릿을 정의할 수 있습니다. UI에서 또는 GraphQL을 사용하여 설명 템플릿을 생성할 수 있습니다.

요구 사항

설명 템플릿 기능은 다음에 사용할 수 있습니다.

NRQL 경고 조건
인프라 모니터링 경고 조건

설명 템플릿 필드의 최대 문자 크기는 4000자입니다.

설명 템플릿이란 무엇입니까?

일부 조건 유형 의 경우 조건 및 해당 인시던트 다운스트림에 대한 정보를 전달하는 설명 템플릿을 만들 수 있습니다. 설명을 사용하여 다음을 수행할 수 있습니다.

조건의 이유를 캡처
모니터링 중인 신호 정의
다음 단계 정의
다운스트림 시스템에 메타데이터 추가

Description template 필드를 사용하면 인시던트가 생성될 때 일반 섹션을 특정 값으로 대체하는 일반 템플릿 구조를 사용할 수 있습니다. 예를 들어 설명에 다음을 사용했다고 가정해 보겠습니다.

This is my condition name : {{conditionName}}
The hostname is : {{tags.fullHostname}}

이 조건으로 인해 발생하는 사건은 세부 정보를 입력하고 다음과 같은 알림을 받게 됩니다.

This is my condition name : My Great Alert Condition
The hostname is : ip-123-45-67-89.us-west-1.compute.internal

설명 템플릿 만들기

A screenshot displaying a sample description template

one.newrelic.com > All capabilities > Alerts & AI > Alert conditions (Policies) > (select a policy) > (select a condition): 필드를 열려면 + Add description template 클릭하세요.

NRQL 알림 에 대한 전용 필드를 사용하거나 감시 알림 에 대해 이 조건 설명 섹션을 사용하여 설명 템플릿을 생성할 수 있습니다.

설명 템플릿 템플릿 예

설명 템플릿 템플릿의 예는 다음과 같습니다.

This is my condition name : {{conditionName}}
The hostname is : {{tags.fullHostname}}
Owning Team: {{tags.label.owning_team}}
Product: {{tags.label.product}}
ec2VpcId: {{tags.aws.ec2VpcId}}
Service name : {{tags.label.Name}}
AWS Region : {{tags.aws.awsRegion}}
AWS Availability Zone: {{tags.aws.awsAvailabilityZone}}
Department : {{tags.label.department}}
Environment: {{tags.label.environment}}
Cluster: {{tags.clusterName}}
Cluster Role: {{tags.clusterRole}}
EC2 Instance Type: {{tags.instanceType}}
EC2 InstanceID: {{tags.aws.ec2InstanceId}}
EC2 AmiId: {{tags.aws.ec2AmiId}}
EC2 Root Device Type: {{tags.aws.ec2RootDeviceType}}

속성을 사용하는 방법

설명 템플릿에 사용할 수 있는 속성은 인시던트 이벤트 에 연결된 속성의 하위 집합입니다. 사용 가능한 속성과 사용 방법에 대한 세부정보는 다음과 같습니다.

인시던트 이벤트 속성: 설명 템플릿에서 사용할 수 있는 표준 속성 의 경우 {{AN_ATTRIBUTE}} 형식을 사용합니다. 예를 들어:
```
The target name is : {{targetName}}
```
태그 속성: 태그의 경우 {{tags.TAG_NAME}} 형식을 사용합니다. 두 가지 유형의 태그가 있습니다.
- 엔터티 관련 태그: For infrastructure conditions only. 엔터티 탐색기 로 이동하여 서비스의 아래를 보거나 Metadata and tags 인시던트 세부 정보를 확인하여 사용 가능한 엔터티 관련 태그를 찾을 수 있습니다. 다음은 설명 템플릿에 태그를 사용하는 예입니다.
  The AWS region is : {{tags.aws.awsRegion}} Responsible team : {{tags.label.owning_team}}
- 패싯 절 태그: For NRQL conditions only. NRQL 조건이 FACET 절을 사용하는 경우 tags 형식을 사용하여 설명 템플릿에서 해당 값을 사용할 수 있습니다. 예를 들어 NRQL 쿼리에 FACET hostName, cluster 포함된 경우 다음을 사용할 수 있습니다.
  The host is : {{tags.hostName}} The cluster is : {{tags.cluster}}

태그 이름에는 공백이 포함될 수 없습니다. 확장된 값에는 공백이 포함될 수 있지만 태그 자체의 이름은 포함될 수 없습니다.

GraphQL을 사용하여 설명 템플릿 만들기

해당 설명이 포함된 GraphQL 변형을 통해 NRQL 공지 조건에 대한 설명 템플릿을 생성할 수 있습니다.

다음은 빈 돌연변이 템플릿입니다.

mutation {
  alertsNrqlConditionStaticUpdate(
    accountId: YOUR_ACCOUNT_ID
    id: "YOUR_CONDITION_ID"
    condition: { description: "" }
  ) {
    YOUR_CUSTOM_INCIDENT_DESCRIPTION
  }
}

다음은 설명 템플릿이 포함된 변형의 예입니다.

mutation {
  alertsNrqlConditionStaticUpdate(
    accountId: 123456
    id: "123456"
    condition: {
      description: "timestamp : {{timestamp}} \n accountId : {{accountId}} \n type : {{type}} \n event : {{event}} \n description : {{description}} \n policyId : {{policyId}} \n policyName: {{policyName}} \n conditionName : {{conditionName}} \n conditionId : {{conditionId}} \n product : {{product}} \n conditionType : {{conditionType}} \n RunbookUrl : {{runbookUrl}} \n nrqlQuery : {{nrqlQuery}} \n nrqlEventType : {{nrqlEventType}} \n targetID : {{targetId}} \n targetName : {{targetName}} \n commandLine : {{tags.commandLine}} \n entityGuid : {{tags.entityGuid}} \n entityName : {{tags.entityName}} \n fullHostname : {{tags.fullHostname}} \n instanceType : {{tags.instanceType}} \n processDisplayName : {{tags.processDisplayName}}"
    }
  ) {
    description
  }
}

NRQL 조건 및 NerdGraph API 사용에 대한 자세한 내용은 NerdGraph API: NRQL 조건 경고 로 이동합니다.
감시 관찰 조건의 경우 관측 관찰 공지 조건을 생성할 때 설명 템플릿을 생성할 수 있습니다.
설명 템플릿을 구성하는 방법에 대해 알아보려면 예제 템플릿 과 속성/태그 지침을 참조하세요.

Slack에서 사용자 멘션 또는 채널 알림

Slack 으로 전송될 설명을 작성할 때 사용자를 @mention 하거나 채널 전체 공지(예: @here 또는 @channel)를 생성할 수 있습니다. 이를 위해서는 < 및 > 문자로 둘러싸인 설명에 사용자 ID 또는 채널 전체 공지를 포함시키면 됩니다.

다음은 사용자를 언급하는 예입니다.

Attention <@LewCirne>

다음은 채널 전체 알림을 생성하는 예입니다.

Attention <!channel>

중요

Incoming Webhook의 채널 전체 알림에 대한 Slack 규칙은 @ 대신 ! 접두사를 사용하는 것입니다. 예: !here 또는 !channel .

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