콘텐츠로 이동

Func 사용자 정의 쿼리 함수

이 문서에서는 DataFlux Func를 통해 사용자 정의 쿼리 함수를 작성하고, 외부 데이터를 처리하며, 차트 요구 사항에 맞게 반환 결과를 구성하는 방법을 설명합니다. QueryHub의 네이티브 쿼리와 DQL Like는 서버에서 결과를 처리하므로 Func 차트 데이터 구조로 래핑할 필요가 없습니다.

커넥터 구성

Func의 개발 > 커넥터에서 대상 데이터 소스 유형과 일치하는 커넥터를 생성하고 연결 주소와 자격 증명을 입력한 뒤 연결을 테스트합니다.

다음 예시는 ID가 mysql인 MySQL 커넥터가 이미 생성되었다고 가정합니다.

mysql = DFF.CONN('mysql')

스크립트에서 Guance API를 호출해야 하는 경우 해당 커넥터와 워크스페이스 API 키를 별도로 구성할 수 있습니다. 데이터베이스 커넥터와 API 커넥터의 자격 증명 용도는 다르며, 구성 진입점은 Func를 통한 연동을 참고하세요.

데이터 쿼리 함수 작성

category='dataPlatform.dataQueryFunc'를 사용하여 데이터 쿼리에 사용할 수 있는 함수를 등록합니다.

다음 예시는 my_table 테이블을 읽으며, 다음과 같이 가정합니다.

  • createTime은 Unix 타임스탬프를 저장하며 단위는 초입니다.
  • reqCost는 요청 소요 시간입니다.
  • 차트에서 전달되는 time_range에는 시작 시간과 종료 시간이 포함되며 단위는 밀리초입니다.
@DFF.API('查询请求耗时', category='dataPlatform.dataQueryFunc')
def query_request_cost(time_range):
    mysql = DFF.CONN('mysql')

    sql = '''
        SELECT createTime, reqCost
        FROM my_table
        WHERE createTime >= ? AND createTime < ?
        ORDER BY createTime
        LIMIT 100
    '''
    parameters = [
        int(time_range[0] / 1000),
        int(time_range[1] / 1000),
    ]
    rows = mysql.query(sql, parameters)

    return {
        'series': [[{
            'columns': ['time', 'req_cost'],
            'tags': {},
            'values': [
                [row['createTime'] * 1000, row['reqCost']]
                for row in rows
            ],
        }]],
    }

커넥터 ID, 테이블 이름 및 필드 이름을 교체하고, 실제 데이터의 시간 단위에 맞게 변환을 조정하세요. 예시의 SQL 매개변수는 ?가 나타나는 순서대로 바인딩되며 문자열 연결로 시간 값을 이어 붙이지 않습니다.

반환 구조 이해

필드 의미
series 쿼리 표시에 사용되는 데이터 시리즈이며, 예시에서는 바깥쪽에 2차원 배열이 유지됩니다.
columns 각 행 값의 필드 순서이며, 예시에서 첫 번째 열은 time, 두 번째 열은 req_cost입니다.
tags 현재 시리즈의 태그이며, 서로 다른 태그 조합은 각각 별도의 시리즈로 구성해야 합니다.
values columns에 대응하는 2차원 데이터이며, 예시에서는 시간 열이 일괄적으로 밀리초로 출력됩니다.

이는 Func 차트 반환 구조이며, 스크립트가 QueryHub의 DQL Like 표현식을 실행 중임을 의미하지 않습니다.

차트 유형별 결과 구성

차트마다 시리즈, 시간 열 및 태그 요구 사항이 다릅니다. 자세한 형식은 다음을 참고하세요.

함수 구성 및 호출 설명은 Function 외부 함수 구성 및 차트 데이터 소스 쿼리도 참고할 수 있습니다.

문서 평가

이 페이지가 도움이 되었나요?