ServiceNow MetricBase 통합 커넥터 - AWS IoT Greengrass
요구 사항파라미터입력 데이터출력 데이터사용 예라이선스Changelog다음 사항도 참조하세요.

AWS IoT Greengrass Version 1 2023년 6월 30일에 수명 연장 단계에 들어갔습니다. AWS IoT Greengrass V1 관리형 정책에 대한 자세한 정보는 섹션을 참조하세요. 이 날짜 이후에는 기능, 개선 사항, 버그 수정 또는 보안 패치를 제공하는 업데이트가 AWS IoT Greengrass V1 릴리스되지 않습니다. 에서 실행되는 기기는 AWS IoT Greengrass V1 중단되지 않으며 계속 작동하고 클라우드에 연결됩니다. 새로운 기능이 크게 추가되고 추가 플랫폼에 대한 지원이 추가되는 으로 마이그레이션하는 AWS IoT Greengrass Version 2 것이 좋습니다.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

ServiceNow MetricBase 통합 커넥터

주의

이 커넥터는 수명 연장 단계로 전환되었으며 AWS IoT Greengrass은(는) 기능, 기존 기능의 개선 사항, 보안 패치 또는 버그 수정을 제공하는 업데이트를 릴리스하지 않을 예정입니다. 자세한 내용은 AWS IoT Greengrass Version 1 유지 관리 정책 섹션을 참조하세요.

ServiceNow MetricBase 통합 커넥터는 Greengrass 디바이스의 시계열 지표를 ServiceNow MetricBase에 게시합니다. 이렇게 하면 Greengrass 코어 환경의 시계열 데이터를 저장, 분석, 시각화하고 로컬 이벤트를 처리할 수 있습니다.

이 커넥터는 MQTT 주제에 대한 시계열 데이터를 수신하고 정기적으로 이 데이터를 ServiceNow API에 게시합니다.

이 커넥터를 사용하여 다음과 같은 시나리오를 지원할 수 있습니다.

  • Greengrass 디바이스에서 수집한 시계열 데이터를 토대로 임계값 기반의 알림과 경보를 생성합니다.

  • ServiceNow 플랫폼에 내장된 사용자 지정 애플리케이션에 Greengrass 디바이스의 시간 서비스 데이터를 사용합니다.

이 커넥터의 버전은 다음과 같습니다.

버전

ARN

4

arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/4

3

arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/3

2

arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/2

1

arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/1

버전 변경 사항에 대한 자세한 내용은 Changelog를 참조하십시오.

요구 사항

이 커넥터에는 다음과 같은 요구 사항이 있습니다.

Version 3 - 4

  • AWS IoT Greengrass 코어 소프트웨어 v1.9.3 이상. AWS IoT Greengrass은(는) 비밀 요구 사항에 설명된 대로 로컬 암호를 지원하도록 구성해야 합니다.

    참고

    이 요구 사항에는 Secrets Manager 암호에 대한 액세스 허용이 포함됩니다. 기본 Greengrass 서비스 역할을 사용 중인 경우 는 이미 greengrass-로 시작하는 이름을 가진 암호에 액세스할 수 있습니다.

  • 코어 디바이스에 설치되고 PATH 환경 변수에 추가된 Python 버전 3.7 또는 3.8입니다..

    참고

    Python 3.8을 사용하려면 다음 명령을 실행하여 기본 Python 3.7 설치 폴더에서 설치된 Python 3.8 바이너리로 연결되는 심볼릭 링크를 만드십시오.

    sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7

    이렇게 하면 AWS IoT Greengrass에 대한 Python 요구 사항을 충족하도록 디바이스가 구성됩니다.

  • MetricBase 구독이 활성 상태인 ServiceNow 계정입니다. 이와 함께 해당 계정에 지표 및 지표 테이블이 생성되어 있어야 합니다. 자세한 내용은 ServiceNow 설명서의 MetricBase를 참조하십시오.

  • 기본 인증으로 ServiceNow 인스턴스에 로그인하기 위해 사용자 이름과 암호를 저장하는 AWS Secrets Manager의 텍스트 유형 암호입니다. 이 암호에는 "사용자" 및 "암호" 키와 해당 값이 들어 있어야 합니다. 자세한 정보는 AWS Secrets Manager 사용 설명서의 기본 비밀 생성을 참조하세요.

  • Secrets Manager 암호를 참조하는 Greengrass 그룹의 암호 리소스입니다. 자세한 내용은 AWS IoT Greengrass 코어에 암호 배포 섹션을 참조하세요.

Versions 1 - 2

  • AWS IoT Greengrass 코어 소프트웨어 v1.7 이상. AWS IoT Greengrass은(는) 비밀 요구 사항에 설명된 대로 로컬 암호를 지원하도록 구성해야 합니다.

    참고

    이 요구 사항에는 Secrets Manager 암호에 대한 액세스 허용이 포함됩니다. 기본 Greengrass 서비스 역할을 사용 중인 경우 는 이미 greengrass-로 시작하는 이름을 가진 암호에 액세스할 수 있습니다.

  • 코어 디바이스에 설치되고 PATH 환경 변수에 추가된 Python 버전 3.7입니다.

  • MetricBase 구독이 활성 상태인 ServiceNow 계정입니다. 이와 함께 해당 계정에 지표 및 지표 테이블이 생성되어 있어야 합니다. 자세한 내용은 ServiceNow 설명서의 MetricBase를 참조하십시오.

  • 기본 인증으로 ServiceNow 인스턴스에 로그인하기 위해 사용자 이름과 암호를 저장하는 AWS Secrets Manager의 텍스트 유형 암호입니다. 이 암호에는 "사용자" 및 "암호" 키와 해당 값이 들어 있어야 합니다. 자세한 정보는 AWS Secrets Manager 사용 설명서의 기본 비밀 생성을 참조하세요.

  • Secrets Manager 암호를 참조하는 Greengrass 그룹의 암호 리소스입니다. 자세한 내용은 AWS IoT Greengrass 코어에 암호 배포 섹션을 참조하세요.

커넥터 파라미터

이 커넥터는 다음 파라미터를 제공합니다.

Version 4
PublishInterval

ServiceNow에 대한 이벤트 게시 간격의 최대 대기 시간(초)입니다. 최대값은 900입니다.

이 커넥터는 PublishBatchSize이(가) 도달 또는 PublishInterval이(가) 만료되면 ServiceNow에 게시합니다.

AWS IoT 콘솔의 표시 이름: 게시 간격(초)

필수: true

형식: string

유효한 값: 1 - 900

유효한 패턴: [1-9]|[1-9]\d|[1-9]\d\d|900

PublishBatchSize

배치로 묶어 ServiceNow에 게시할 수 있는 지표 값의 최대 개수입니다.

이 커넥터는 PublishBatchSize이(가) 도달 또는 PublishInterval이(가) 만료되면 ServiceNow에 게시합니다.

AWS IoT 콘솔의 표시 이름: 배치 크기 게시

필수: true

형식: string

유효한 패턴: ^[0-9]+$

InstanceName

ServiceNow에 연결할 때 사용하는 인스턴스의 이름입니다.

AWS IoT 콘솔의 표시 이름: ServiceNow 인스턴스의 이름

필수: true

형식: string

유효한 패턴: .+

DefaultTableName

시계열 MetricBase 데이터베이스와 연결된 GlideRecord가 들어 있는 테이블의 이름입니다. 입력 메시지 페이로드의 table 속성으로 이 값을 재정의할 수 있습니다.

AWS IoT 콘솔의 표시 이름: 메트릭을 포함할 테이블 이름

필수: true

형식: string

유효한 패턴: .+

MaxMetricsToRetain

새 지표로 바뀌기 전에 메모리에 저장할 수 있는 최대 지표 수입니다.

이러한 제한은 인터넷에 연결되어 있지 않거나 커넥터가 나중에 게시할 지표를 버퍼링하기 시작할 때 적용됩니다. 버퍼가 꽉 차면 가장 오래된 지표가 새 지표로 바뀝니다.

참고

커넥터에 대한 호스트 프로세스가 중단되면 지표가 저장되지 않습니다. 예를 들어, 그룹 배포 중 또는 디바이스가 다시 시작될 때 발생할 수 있습니다.

이 값은 배치 크기보다 커야 하고, MQTT 메시지의 수신 속도에 따라 메시지를 보관할 수 있을 만큼 커야 합니다.

AWS IoT 콘솔의 표시 이름: 메모리에 보관할 최대 지표

필수: true

형식: string

유효한 패턴: ^[0-9]+$

AuthSecretArn

ServiceNow 사용자 이름 및 암호를 저장하는 AWS Secrets Manager의 암호입니다. 텍스트 유형의 암호여야 합니다. 이 암호에는 "사용자" 및 "암호" 키와 해당 값이 들어 있어야 합니다.

AWS IoT 콘솔의 표시 이름: 인증 암호의 ARN

필수: true

형식: string

유효한 패턴: arn:aws:secretsmanager:[a-z0-9\-]+:[0-9]{12}:secret:([a-zA-Z0-9\\]+/)*[a-zA-Z0-9/_+=,.@\-]+-[a-zA-Z0-9]+

AuthSecretArn-ResourceId

ServiceNow 보안 인증의 Secrets Manager 암호를 참조하는 그룹의 암호 리소스입니다.

AWS IoT 콘솔의 표시 이름: 인증 토큰 리소스

필수: true

형식: string

유효한 패턴: .+

IsolationMode

이 커넥터의 컨테이너화 모드입니다. 기본값은 GreengrassContainer이며 이는 커넥터가 AWS IoT Greengrass 컨테이너 내부의 격리된 런타임 환경에서 실행됨을 의미합니다.

참고

그룹의 기본 컨테이너화 설정은 커넥터에는 적용되지 않습니다.

AWS IoT 콘솔의 표시 이름: 컨테이너 격리 모드

필수: false

형식: string

유효한 값: GreengrassContainer 또는 NoContainer

유효한 패턴: ^NoContainer$|^GreengrassContainer$

Version 1 - 3
PublishInterval

ServiceNow에 대한 이벤트 게시 간격의 최대 대기 시간(초)입니다. 최대값은 900입니다.

이 커넥터는 PublishBatchSize이(가) 도달 또는 PublishInterval이(가) 만료되면 ServiceNow에 게시합니다.

AWS IoT 콘솔의 표시 이름: 게시 간격(초)

필수: true

형식: string

유효한 값: 1 - 900

유효한 패턴: [1-9]|[1-9]\d|[1-9]\d\d|900

PublishBatchSize

배치로 묶어 ServiceNow에 게시할 수 있는 지표 값의 최대 개수입니다.

이 커넥터는 PublishBatchSize이(가) 도달 또는 PublishInterval이(가) 만료되면 ServiceNow에 게시합니다.

AWS IoT 콘솔의 표시 이름: 배치 크기 게시

필수: true

형식: string

유효한 패턴: ^[0-9]+$

InstanceName

ServiceNow에 연결할 때 사용하는 인스턴스의 이름입니다.

AWS IoT 콘솔의 표시 이름: ServiceNow 인스턴스의 이름

필수: true

형식: string

유효한 패턴: .+

DefaultTableName

시계열 MetricBase 데이터베이스와 연결된 GlideRecord가 들어 있는 테이블의 이름입니다. 입력 메시지 페이로드의 table 속성으로 이 값을 재정의할 수 있습니다.

AWS IoT 콘솔의 표시 이름: 메트릭을 포함할 테이블 이름

필수: true

형식: string

유효한 패턴: .+

MaxMetricsToRetain

새 지표로 바뀌기 전에 메모리에 저장할 수 있는 최대 지표 수입니다.

이러한 제한은 인터넷에 연결되어 있지 않거나 커넥터가 나중에 게시할 지표를 버퍼링하기 시작할 때 적용됩니다. 버퍼가 꽉 차면 가장 오래된 지표가 새 지표로 바뀝니다.

참고

커넥터에 대한 호스트 프로세스가 중단되면 지표가 저장되지 않습니다. 예를 들어, 그룹 배포 중 또는 디바이스가 다시 시작될 때 발생할 수 있습니다.

이 값은 배치 크기보다 커야 하고, MQTT 메시지의 수신 속도에 따라 메시지를 보관할 수 있을 만큼 커야 합니다.

AWS IoT 콘솔의 표시 이름: 메모리에 보관할 최대 지표

필수: true

형식: string

유효한 패턴: ^[0-9]+$

AuthSecretArn

ServiceNow 사용자 이름 및 암호를 저장하는 AWS Secrets Manager의 암호입니다. 텍스트 유형의 암호여야 합니다. 이 암호에는 "사용자" 및 "암호" 키와 해당 값이 들어 있어야 합니다.

AWS IoT 콘솔의 표시 이름: 인증 암호의 ARN

필수: true

형식: string

유효한 패턴: arn:aws:secretsmanager:[a-z0-9\-]+:[0-9]{12}:secret:([a-zA-Z0-9\\]+/)*[a-zA-Z0-9/_+=,.@\-]+-[a-zA-Z0-9]+

AuthSecretArn-ResourceId

ServiceNow 보안 인증의 Secrets Manager 암호를 참조하는 그룹의 암호 리소스입니다.

AWS IoT 콘솔의 표시 이름: 인증 토큰 리소스

필수: true

형식: string

유효한 패턴: .+

커넥터 만들기 예(AWS CLI)

다음 CLI 명령은 ServiceNow MetricBase 통합 커넥터가 포함된 초기 버전을 사용하여 ConnectorDefinition을 생성합니다.

aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{
    "Connectors": [
        {
            "Id": "MyServiceNowMetricBaseIntegrationConnector",
            "ConnectorArn": "arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/4",
            "Parameters": {
                "PublishInterval" : "10",
                "PublishBatchSize" : "50",
                "InstanceName" : "myinstance",
                "DefaultTableName" : "u_greengrass_app",
                "MaxMetricsToRetain" : "20000",
                "AuthSecretArn" : "arn:aws:secretsmanager:region:account-id:secret:greengrass-secret-hash",
                "AuthSecretArn-ResourceId" : "MySecretResource", 
                "IsolationMode" : "GreengrassContainer"
            }
        }
    ]
}'
참고

이 커넥터의 Lambda 함수에는 수명이 긴 수명 주기가 있습니다.

AWS IoT Greengrass 콘솔에서는 그룹의 커넥터 페이지에서 커넥터를 추가할 수 있습니다. 자세한 내용은 Greengrass 커넥터 시작하기(콘솔) 섹션을 참조하세요.

입력 데이터

이 커넥터는 MQTT 주제에 대한 시계열 지표를 수락하고 이 지표를 ServiceNow에 게시합니다. 입력 메시지는 JSON 형식이어야 합니다.

구독의 주제 필터

servicenow/metricbase/metric

메시지 속성
request

테이블, 레코드, 지표에 대한 정보입니다. 이 요청은 시계열 POST 요청에서 seriesRef 객체를 나타냅니다. 자세한 내용은 Clotho 시계열 API - POST를 참조하십시오.

필수: true

유형: 다음 속성을 포함하는 object:

subject

표에 있는 특정 레코드의 sys_id입니다.

필수: true

형식: string

metric_name

지표의 필드 이름입니다.

필수: true

형식: string

table

레코드를 저장할 테이블의 이름입니다. 이 값을 지정하여 DefaultTableName 파라미터를 재정의할 수 있습니다.

필수: false

형식: string

value

개별 데이터 포인트의 값입니다.

필수: true

형식: float

timestamp

개별 데이터 포인트의 타임스탬프입니다. 기본값은 현재 시간입니다.

필수: false

형식: string

입력 예
{
    "request": {
        "subject":"ef43c6d40a0a0b5700c77f9bf387afe3",
        "metric_name":"u_count",
        "table": "u_greengrass_app"
        "value": 1.0,
        "timestamp": "2018-10-14T10:30:00"
    }
}

출력 데이터

이 커넥터는 상태 정보를 MQTT 주제에 출력 데이터로 게시합니다.

구독의 주제 필터

servicenow/metricbase/metric/status

출력 예: 성공
{
    "response": {
        "metric_name": "Errors",
        "table_name": "GliderProd",
        "processed_on": "2018-10-14T10:35:00",
        "response_id": "khjKSkj132qwr23fcba",
        "status": "success",
        "values": [
            {
                "timestamp": "2016-10-14T10:30:00",
                "value": 1.0
            },
            {
                "timestamp": "2016-10-14T10:31:00",
                "value": 1.1
            }
        ]
    }
}
출력 예: 실패
{
    "response": {
        "error": "InvalidInputException",
        "error_message": "metric value is invalid",
        "status": "fail"
    }
}
참고

커넥터가 재시도 가능한 오류(예: 연결 오류)를 감지하면 다음 배치에서 게시를 재시도합니다.

사용 예

다음 상위 수준 단계를 사용하여 커넥터를 사용해 보는 데 이용할 수 있는 예제 Python 3.7 Lambda 함수를 설정합니다.

참고

  • 다른 Python 런타임을 사용하는 경우 Python3.x에서 Python 3.7로의 심볼릭 링크를 만들 수 있습니다.

  • 커넥터 시작하기(콘솔) 및 커넥터 시작하기(CLI) 주제에는 예제 Twilio 알림 커넥터를 구성하고 배포하는 방법을 보여주는 자세한 단계가 포함되어 있습니다.

  1. 커넥터에 대한 요구 사항을 충족하는지 확인합니다.

  2. 입력 데이터를 커넥터로 보내는 Lambda 함수를 생성하고 게시합니다.

    예제 코드를 PY 파일로 저장합니다. Python용 AWS IoT Greengrass 코어 SDK를 다운로드하고 압축을 풉니다. 그런 다음 루트 수준에서 PY 파일과 greengrasssdk 폴더를 포함하는 zip 패키지를 생성합니다. 이 zip 패키지는 AWS Lambda에 업로드하는 배포 패키지입니다.

    Python 3.7 Lambda 함수를 생성한 후 함수 버전을 게시하고 별칭을 만듭니다.

  3. Greengrass 그룹을 구성합니다.

    1. 별칭으로 Lambda 함수를 추가합니다(권장). Lambda 수명 주기를 수명이 긴 함수(또는 CLI의 "Pinned": true)로 구성합니다.

    2. 필요한 보안 리소스를 추가하고 Lambda 함수에 대한 읽기 액세스 권한을 부여합니다.

    3. 커넥터를 추가하고 해당 파라미터를 구성합니다.

    4. 커넥터가 입력 데이터를 수신하고 지원되는 주제 필터에서 출력 데이터를 전송할 수 있도록 허용하는 구독을 추가합니다.

      • Lambda 함수를 소스로, 커넥터를 대상으로 설정하고 지원되는 입력 주제 필터를 사용합니다.

      • 커넥터를 소스로, AWS IoT Core를 대상으로 설정하고 지원되는 출력 주제 필터를 사용합니다. 이 구독을 사용하여 AWS IoT에서 상태 메시지를 확인합니다.

  4. 그룹을 배포합니다.

  5. AWS IoT 콘솔의 테스트 페이지에서 출력 데이터 주제를 구독하여 커넥터의 상태 메시지를 확인합니다. 예제 Lambda 함수는 수명이 긴 함수로 그룹이 배포된 직후 메시지 전송을 시작합니다.

    테스트를 마치면 Lambda 수명 주기를 온디맨드 함수(또는 CLI의 "Pinned": false)로 설정하고 그룹을 배포할 수 있습니다. 이렇게 하면 함수가 메시지 전송을 중지합니다.

예

다음 예제 Lambda 함수는 커넥터에 입력 메시지를 보냅니다.

import greengrasssdk
import json

iot_client = greengrasssdk.client('iot-data')
SEND_TOPIC = 'servicenow/metricbase/metric'

def create_request_with_all_fields():
    return {
        "request": {
             "subject": '2efdf6badbd523803acfae441b961961',
             "metric_name": 'u_count',
             "value": 1234,
             "timestamp": '2018-10-20T20:22:20',
             "table": 'u_greengrass_metricbase_test'
        }
    }

def publish_basic_message():
    messageToPublish = create_request_with_all_fields()
    print("Message To Publish: ", messageToPublish)
    iot_client.publish(topic=SEND_TOPIC,
        payload=json.dumps(messageToPublish))

publish_basic_message()

def lambda_handler(event, context):
    return

라이선스

ServiceNow MetricBase 통합 커넥터에는 다음 타사 소프트웨어/라이선스가 포함되어 있습니다.

이 커넥터는 Greengrass 코어 소프트웨어 라이선스 계약에 따라 릴리스됩니다.

Changelog

다음 표에서는 의 각 릴리스에서 변경된 중요 사항에 대해 설명합니다.

버전

변경

4

커넥터에 대한 컨테이너화 모드를 구성하는 IsolationMode 파라미터가 추가되었습니다.

3

Lambda 런타임 요구 사항을 변경하는 Python 3.7로 런타임을 업그레이드했습니다.

2

과도한 로깅을 줄이도록 고정합니다.

1

최초 릴리스.

Greengrass 그룹은 한 번에 하나의 커넥터 버전만 포함할 수 있습니다. 커넥터 버전 업그레이드에 대한 자세한 내용은 커넥터 버전 업그레이드을 참조하십시오.

다음 사항도 참조하세요.