Command Line Interface¶

Guance CLI(Command-Line Interface)는 Guance에 연결하고 Guance에서 리소스 관리 작업을 수행하기 위한 크로스 플랫폼 명령줄 도구입니다. 또한 다양한 타사 에코시스템의 콘텐츠를 Guance 플랫폼으로 가져와 통합 관리하는 데에도 사용할 수 있습니다.

실제 클라우드 서비스 상호 작용 시나리오에서는 SaaS 플랫폼과 상호 작용하는 세 가지 방식이 있습니다.

• 명령형 API 및 도구: 특정 리소스를 조작하는 방법을 설명하기 위해 작업 술어를 사용합니다. 예를 들어 RESTFul 및 명령어 동작이 포함됩니다.
• 선언형 API 및 도구: 필요한 리소스만 설명합니다. 구체적인 작업은 플랫폼 또는 도구가 현재 상태를 분석하여 자동으로 계산하고 실행합니다.
• 대화형 도구: 사용자와의 상호 작용을 통해 사용자가 점진적으로 목표를 달성하도록 유도합니다. 예를 들어 API 디버거는 사용자가 매개변수를 지속적으로 조정하고 요청을 시작하여 원하는 결과를 얻을 때까지 반복할 수 있도록 합니다.

CLI는 SaaS 공급자에게 필수적인 개발자 도구로, GUI를 대체하여 사용자 상호 작용을 위한 또 다른 인터페이스 역할을 합니다. CLI는 일반적으로 소프트웨어 자동화 문제를 해결하고 자동화된 명령형 작업(예: 스크립트를 작성하여 CLI를 호출함으로써 자동화 운영의 마지막 단계를 구현)을 구현하는 데 사용됩니다.

Guance CLI는 현재 다음 세 가지 명령형 작업을 지원합니다.

• 리소스 가져오기 도구: 타사 에코시스템의 콘텐츠를 Guance으로 가져와 통합 관리합니다(예: Grafana 대시보드를 Guance으로 가져오기).
• 데이터 업로드 도구: 일회성 데이터(예: 단일 데이터 파일, CI/CD 산출물 등)를 Guance에 보고합니다(예: 테스트 데이터 업로드).
• 설치 도구: Guance 에코시스템의 각 구성 요소를 원클릭으로 설치합니다.

사용 사례¶

CLI를 사용하여 Grafana 대시보드를 Guance으로 가져오기¶

Grafana는 다양한 데이터 소스에서 데이터를 가져와 시각화할 수 있는 인기 있는 오픈 소스 데이터 시각화 도구입니다. 라인 차트, 막대 차트, 산점도, 히트맵 등 여러 차트 유형을 지원하며, 직관적인 차트 표시 방식을 통해 사용자가 데이터의 변화 추세와 분포를 더 잘 이해하고 데이터 분석 및 의사 결정을 내릴 수 있도록 돕습니다.

Guance CLI는 Grafana의 대시보드를 Guance 플랫폼에서 지원하는 형식으로 내보내 Guance으로 가져올 수 있도록 지원합니다. 또한 대규모 프로젝트 통합을 위해 Terraform 파일을 내보낼 수도 있습니다.

사용 방법¶

제한 사항¶

다음 사용 제한 사항이 사용에 불편을 초래하는 경우, 링크를 참조하여 피드백을 보내주십시오. (https://github.com/GuanceCloud/guance-cli/issues)

일부 패널 형식이 지원되지 않음

현재 지원되는 패널 유형은 총 10가지이며, 여기에는 두 가지 더 이상 사용되지 않는 유형(이전 대시보드와의 호환성을 위해)이 포함됩니다.

일부 템플릿 변수 구문이 지원되지 않음

Grafana PromQL 대시보드의 PromQL 쿼리는 Guance의 DQL 쿼리로 변환됩니다. 그러나 현재는 중첩되지 않은 표현식 함수 label_values만 변환을 지원합니다. query_result와 같은 다른 함수는 빈 쿼리로 변환됩니다.

PromQL 결과에 대한 단축 표기 미지원

PromQL의 시리즈 이름은 쿼리에 따라 자동 생성되며, 단축 표기(DQL의 as 키워드와 유사)를 지원하지 않습니다.