IBM Cloud Logs Routing CLI

IBM Cloud® 명령행 인터페이스(CLI)는 서비스 오퍼링을 위한 추가 기능을 제공합니다. 이 정보에서는 CLI를 사용하여 IBM Cloud Logs Routing 서비스를 정의하고 관리하는 방법에 대해 설명합니다.

시작하기 전에

다음 단계를 완료하십시오.

  1. IBM Cloud CLI를 설치하십시오.

  2. IBM Cloud Logs Routing CLI를 설치하고 구성합니다.

IBM Cloud CLI 및 플러그인에 대한 업데이트가 사용 가능한 경우 명령행에서 알림을 받습니다. 최신 명령을 사용할 수 있도록 CLI를 최신 상태로 유지하세요. ibmcloud plugin list를 실행하여 설치된 모든 플러그인의 현재 버전을 볼 수 있습니다.

ibmcloud 로그-라우터 경로 생성

이 명령을 사용하여 하나 이상의 지역에서 계정의 IBM Cloud Logs Routing 타깃으로 데이터가 라우팅되는 방법을 정의하는 경로를 만들 수 있습니다. 경로를 만든 계정에서 관리하거나 기업 부모 계정에서 관리할 수 있습니다.

대상은 IBM Cloud Logs 인스턴스여야 합니다.

ibmcloud logs-router route create --name ROUTE_NAME ( --rules RULES | @RULES-FILE) [--managed-by MANAGED-BY] [--output FORMAT]

명령 옵션

--name ROUTE_NAME

라우트에 지정되는 이름입니다.

최대 길이는 1000자입니다. 최소 길이는 1자입니다.

이름에는 (space) - . _ : 이외의 특수 문자를 포함할 수 없습니다.

자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.

--rules RULES | @RULES-FILE

라우팅 규칙은 구성된 순서대로 평가됩니다.

작은따옴표로 묶은 JSON 문자열 또는 JSON 파일의 경로로 설정해야 합니다.

최대 길이는 10개의 규칙입니다. 최소 길이는 규칙 1개입니다.

예를 들어 다음과 같이 JSON 문자열을 설정하거나 @filepath를 사용하여 json을 전달할 수 있습니다:

--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values": ["us-south","eu-de"]}]}]'

규칙에 구성된 대상에 모든 데이터를 라우팅하기 위해 다음과 같이 JSON 파일의 형식을 지정할 수 있습니다:

[
  {
    "targets": [{"id":"ID1"},{"id":"ID2"}]
  }
]

규칙 정의에는 선택적으로 포함 필터를 포함할 수 있습니다. JSON 파일의 형식은 다음과 같이 지정할 수 있습니다:

[{
    "action": "send",
    "targets": [{
      "id":"11111111-1111-1111-1111-111111111111"
    }],
    "inclusion_filters": [
        {
          "operand": "location",
          "operator": "in",
          "values": [
            "us-south",
            "eu-de"
          ]
        }
    ]
 }]

여기서:

action

Action은 IBM Cloud Logs Routing 경로에 로그를 포함할지 아니면 제외할지를 정의합니다. send 와 drop 두 가지 작업이 지원됩니다. 지정하지 않으면 기본 작업은 로그를 전송하는 것입니다.

send
로그는 라우팅 규칙에 따라 정의된 경로로 전송됩니다.
drop
정의된 경로로 로그가 전송되면 라우팅 규칙에 따라 로그가 제외됩니다.
targets

대상은 로그가 라우팅되는 IBM Cloud Logs 대상을 정의합니다. 쉼표로 구분된 대상 ID 목록입니다.

inclusion_filters

포함 필터는 라우팅되는 데이터를 정의합니다.

쉼표로 구분된 필터 목록을 구성할 수 있습니다.

필터는 피연산자, 연산자, 값으로 정의됩니다.

규칙당 최대 7개의 필터를 정의할 수 있습니다.

operand

피연산자는 operator 이 실행되는 프로퍼티의 이름입니다.

유효한 피연산자는 location.

operator

in 와 is 의 두 가지 운영자가 지원됩니다.

in

피연산자 속성의 값은 값 목록과 비교됩니다.

최대 20개의 값을 정의할 수 있습니다.

is

피연산자 속성의 값은 단일 값과 비교됩니다.

is 을 사용하는 경우 하나의 값만 지정할 수 있습니다.

values

로그 라우팅 여부를 결정하기 위해 operand 속성과 비교할 문자열 또는 문자열 배열입니다.

is operator 을 사용하는 경우 values 에는 단일 문자열이 포함되어야 합니다.

in operator 을 사용하는 경우 values 은 배열에 여러 문자열을 포함할 수 있습니다.

--managed-by

경로가 관리되는 방식을 식별합니다.

기본값 account 을 설정하여 생성된 계정에서 로컬로 경로를 관리하거나 enterprise 값을 설정하여 기업 계정에서 경로를 관리할 수 있습니다.

유효한 값은 enterprise 또는 account 입니다.

기본값은 '계정'입니다.

경로가 생성된 후에는 이 값을 변경할 수 없습니다.

--output FORMAT

JSON 을 지정하면 출력은 JSON 형식으로 반환됩니다. JSON 을 지정하지 않으면 출력은 표 형식으로 반환됩니다.

help | --help | -h

명령에 사용할 수 있는 옵션을 나열합니다.

iBM클라우드 로그-라우터 경로 업데이트

이 명령을 사용하여 하나 이상의 지역에서 계정의 IBM Cloud Logs Routing 타깃으로 데이터가 라우팅되는 방법을 정의하는 경로를 업데이트할 수 있습니다.

경로를 처음 만들 때와 다른 지정된 값은 명령에 지정된 값으로 업데이트됩니다. 이전에 배포되었으나 업데이트 요청에 포함되지 않은 구성은 모두 제거됩니다.

ibmcloud logs-router route update --route ROUTE [--name NAME] [--rules RULES | @RULES-FILE]

명령 옵션

--route ROUTE

라우트의 ID 또는 이름입니다.

ID는 경로를 고유하게 식별하는 v4 UUID입니다.

ID의 최대 길이는 1028자입니다. ID의 최소 길이는 24자입니다.

--name NAME

경로에 부여할 새 이름(선택 사항).

자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.

--rules RULES | @RULES-FILE

라우팅 규칙은 구성된 순서대로 평가됩니다.

작은따옴표로 묶은 JSON 문자열 또는 JSON 파일의 경로로 설정해야 합니다.

최대 길이는 10개의 규칙입니다. 최소 길이는 규칙 1개입니다.

수정해야 하는 사항 외에 현재 구성을 그대로 유지하세요. 업데이트에 포함되지 않은 기존 규칙 구성은 모두 삭제됩니다.

예를 들어 JSON 형식의 규칙 정의 샘플을 참조하거나 @filepath를 사용하여 json을 전달하세요:

--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values": ["us-south","eu-de","eu-gb"]}]}]'

규칙에 구성된 대상에 모든 데이터를 라우팅하기 위해 다음과 같이 JSON 파일의 형식을 지정할 수 있습니다:

[
  {
    "targets": [{"id":"ID1"},{"id":"ID2"},{"id":"ID3"}]
  }
]

규칙 정의에는 선택적으로 포함 필터를 포함할 수 있습니다. JSON 파일의 형식은 다음과 같이 지정할 수 있습니다:

[{
    "action": "send",
    "targets": [{
      "id":"11111111-1111-1111-1111-111111111111"
    }],
    "inclusion_filters": [
        {
          "operand": "location",
          "operator": "in",
          "values": [
            "us-south",
            "eu-de",
            "eu-gb"
          ]
        }
    ]
 }]
action

Action은 IBM Cloud Logs Routing 경로에 로그를 포함할지 아니면 제외할지를 정의합니다. send 와 drop 두 가지 작업이 지원됩니다. 지정하지 않으면 기본 작업은 로그를 전송하는 것입니다.

send
로그는 라우팅 규칙에 따라 정의된 경로로 전송됩니다.
drop
정의된 경로로 로그가 전송되면 라우팅 규칙에 따라 로그가 제외됩니다.
targets

대상은 로그가 라우팅되는 IBM Cloud Logs 대상을 정의합니다. 쉼표로 구분된 대상 ID 목록입니다.

inclusion_filters

포함 필터는 라우팅되는 데이터를 정의합니다.

쉼표로 구분된 필터 목록을 구성할 수 있습니다.

필터는 피연산자, 연산자, 값으로 정의됩니다.

규칙당 최대 7개의 필터를 정의할 수 있습니다.

operand

피연산자는 operator 이 실행되는 프로퍼티의 이름입니다.

유효한 피연산자는 location.

operator

in 와 is 의 두 가지 운영자가 지원됩니다.

in

피연산자 속성의 값은 값 목록과 비교됩니다.

최대 20개의 값을 정의할 수 있습니다.

is

피연산자 속성의 값은 단일 값과 비교됩니다.

is 을 사용하는 경우 하나의 값만 지정할 수 있습니다.

values

로그 라우팅 여부를 결정하기 위해 operand 속성과 비교할 문자열 또는 문자열 배열입니다.

is operator 을 사용하는 경우 values 에는 단일 문자열이 포함되어야 합니다.

in operator 을 사용하는 경우 values 은 배열에 여러 문자열을 포함할 수 있습니다.

--output FORMAT

JSON 을 지정하면 출력은 JSON 형식으로 반환됩니다. JSON 을 지정하지 않으면 출력은 표 형식으로 반환됩니다.

help | --help | -h

명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그 라우터 경로 삭제

IBM Cloud Logs Routing 경로를 삭제하려면 이 명령을 사용합니다.

ibmcloud logs-router route delete --route ROUTE

명령 옵션

--route ROUTE
삭제할 경로의 ID 또는 이름입니다.
--force 또는 --f
사용자에게 추가 메시지를 표시하지 않고 경로를 삭제합니다.
help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그-라우터 경로 가져오기

이 명령을 사용하여 IBM Cloud Logs Routing 경로에 대한 구성 정보를 얻습니다.

ibmcloud logs-router route get --route ROUTE

명령 옵션

--route ROUTE
라우트의 ID 또는 이름입니다.
help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그 라우터 경로 목록

이 명령을 사용하여 계정에서 IBM Cloud Logs Routing 에 대해 구성된 모든 경로를 나열합니다.

ibmcloud logs-router route list

명령 옵션

help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그 라우터 대상 생성

이 명령을 사용하여 플랫폼 지표의 대상을 구성하는 데 사용할 대상을 만들 수 있습니다. 모든 지역의 플랫폼 로그를 단일 대상, 다른 대상 또는 여러 대상에 전송할 수 있습니다. 지역당 하나의 타겟은 필요하지 않습니다. 계정당 최대 16개의 대상을 정의할 수 있습니다.

대상은 IBM Cloud Logs 인스턴스여야 합니다.

ibmcloud logs-router target create --name NAME --destination-crn DESTINATION-CRN [--region REGION] [--managed-by MANAGED-BY]

명령 옵션

--region REGION

지역의 이름입니다(예: us-south 또는 eu-gb). 지정하지 않으면 로그인한 지역 또는 타겟팅된 지역이 사용됩니다. 이는 선택사항입니다.

--name NAME

대상에 지정되는 이름입니다.

자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.

--destination-crn DESTINATION-CRN

IBM Cloud Logs Routing 에서 전송한 로그를 수신할 서비스 인스턴스 또는 리소스의 CRN 입니다. IBM Cloud Logs Routing 리소스와 IBM Cloud 리소스 사이에 서비스 권한이 있는지 확인하세요. 자세한 내용은 서비스 간 액세스 권한 부여를 위한 권한 관리하기를 참조하세요.

[--managed-by MANAGED-BY] 이는 선택사항입니다. 이 대상을 관리하는 사람을 식별합니다. 생성 시 선택 사항입니다. '엔터프라이즈'로 설정하면 대상이 엔터프라이즈에서 관리되며 엔터프라이즈 작업에 대한 권한이 있는 ID만 수정할 수 있습니다. 생략하거나 '계정'으로 설정하면 대상이 하위 계정으로 관리됩니다. 이 값은 생성 후에는 변경할 수 없습니다. 허용되는 값은 기업, 계정입니다.

help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

iBM클라우드 로그 라우터 대상 업데이트

이 명령을 사용하여 플랫폼 지표의 대상을 구성하는 데 사용할 대상을 업데이트합니다.

대상은 IBM Cloud Logs 인스턴스여야 합니다.

ibmcloud logs-router target update --target TARGET [--name NAME] [--destination-crn DESTINATION-CRN]

명령 옵션

--target TARGET 대상의 ID 또는 이름입니다.

--name NAME

대상에 부여할 새 이름입니다.

자원 이름에 개인 식별 정보(PII)를 포함하지 마십시오.

--destination-crn DESTINATION_CRN

IBM Cloud Logs Routing 에서 전송한 로그를 수신할 서비스 인스턴스 또는 리소스의 CRN 입니다. IBM Cloud Logs Routing 리소스와 IBM Cloud 리소스 사이에 서비스 권한이 있는지 확인하세요. 자세한 내용은 서비스 간 액세스 권한 부여를 위한 권한 관리하기를 참조하세요.

help | --help | -h

명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그 라우터 대상 삭제

이 명령을 사용하여 대상을 삭제할 수 있습니다.

ibmcloud logs-router target delete --target TARGET

명령 옵션

--target TARGET
대상의 ID 또는 이름입니다.
--force | -f
사용자에게 추가 메시지를 표시하지 않고 대상을 삭제합니다.
help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그-라우터 대상 가져오기

이 명령을 사용하여 IBM Cloud Logs Routing 대상에 대한 정보를 얻습니다.

ibmcloud logs-router target get --target TARGET

명령 옵션

--target TARGET
대상의 ID 또는 이름입니다.
help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그 라우터 대상 목록

이 명령을 사용하여 IBM Cloud Logs Routing 에 대해 구성된 모든 대상을 나열합니다.

ibmcloud logs-router target list

명령 옵션

help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그 라우터 설정 가져오기

이 명령을 사용하여 IBM Cloud Logs Routing 계정 수준 구성에 대한 설정을 가져옵니다.

ibmcloud logs-router setting get

명령 옵션

help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

iBM클라우드 로그 라우터 설정 업데이트

이 명령을 사용하여 IBM Cloud Logs Routing 에서 기본 대상, 허용된 대상 영역, 기본 및 보조 메타데이터 영역 등의 현재 설정을 수정할 수 있습니다. 대상을 처음 만들 때와 다른 값은 모두 명령에 지정된 값으로 업데이트됩니다. 옵션을 지정하지 않으면 현재 설정이 반환됩니다.

--private-api-endpoint-only TRUE 설정을 통해 공용 엔드포인트를 사용 안함으로 설정하기 전에, 계정에 개인용 엔드포인트에 대한 액세스 권한이 있는지 확인하십시오. ibmcloud account show 명령을 실행하여 이를 수행할 수 있습니다. VRF Enabled가 true이고 Service Endpoint Enabled가 true인 경우 사설 엔드포인트에 대한 액세스 권한이 없습니다. 비공개 엔드포인트에 액세스할 수 없는 경우 공용 엔드포인트를 사용 설정할 수 없습니다. 공용 엔드포인트를 사용하려면 비공개 엔드포인트 액세스가 필요합니다.

ibmcloud logs-router setting update [--default-targets DEFAULT-TARGETS] [--permitted-target-regions PERMITTED-TARGET-REGIONS] [--primary-metadata-region PRIMARY-METADATA-REGION] [--backup-metadata-region BACKUP-METADATA-REGION] [--private-api-endpoint-only=PRIVATE-API-ENDPOINT-ONLY]

명령 옵션

--api-version
IBM Cloud 계정의 IBM Cloud 로그 라우팅 서비스용 API 버전입니다. 유효한 값은 1과 3입니다. 기본값은 1입니다. V1 에서 유효한 대상 및 테넌트를 생성한 경우에만 1에서 3으로 업데이트하여 서비스 구성을 마이그레이션할 수 있습니다. 이 업데이트를 수행한 후에는 버전 1로 돌아갈 수 있는 옵션이 없다는 점에 유의하세요. 자세한 내용은 https://ibm.biz/lr-v3migration 을 참조하세요.
--backup-metadata-region
IBM Cloud 로그 라우팅 메타데이터를 백업하는 데 사용되는 백업 영역입니다. 최대 길이는 256자입니다. 최소 길이는 3자입니다.
--default-targets
IBM Cloud 로그 라우팅 계정의 라우팅 규칙에서 명시적으로 관리되지 않는 로그를 수신하는 대상입니다. 최대 2개의 타겟을 정의할 수 있습니다. 최소 대상 수는 0입니다.
--permitted-target-regions
사용자가 계정에서 대상을 만들 수 있는 IBM Cloud Logs Routing 에서 지원하는 지역을 쉼표로 구분한 목록입니다. 자세한 내용은 https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations 을 참조하세요. 최대 길이는 16개 지역입니다. 최소 길이는 0 영역입니다.
--primary-metadata-region
IBM Cloud 로그 라우팅 메타데이터를 백업하는 데 사용되는 기본 영역입니다. 최대 길이는 256자입니다. 최소 길이는 3자입니다.
--private-api-endpoint-only
엔드포인트 연결이 지원됩니다. 공용 네트워크를 통해 API에 액세스하려면 이 값을 "false"로 설정합니다. 비공개 네트워크를 통해서만 API에 액세스하려면 이 값을 "true"로 설정합니다.
help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

iBM클라우드 로그 라우터 마이그레이션 완료

이 명령을 사용하여 버전 1에서 버전 3으로 라우팅하는 마이그레이션 로그를 완료합니다. 이 명령을 사용하려면 마이그레이션 상태가 PENDING_COMPLETION이어야 합니다.

ibmcloud logs-router migrate complete

명령 옵션

help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

iBM클라우드 로그-라우터 마이그레이션 생성

이 명령을 사용하여 버전 1에서 버전 3으로 라우팅하는 로그의 비동기 마이그레이션을 시작하세요. 이 명령을 사용하려면 마이그레이션 상태가 BEFORE여야 합니다.

ibmcloud logs-router migrate generate

명령 옵션

help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

ibmcloud 로그 라우터 마이그레이션 삭제

이 명령을 사용하여 버전 3 경로 및 대상을 라우팅하는 모든 로그를 삭제하고 마이그레이션 상태를 이전으로 재설정합니다. 상태가 PENDING_COMPLETION 또는 BEFORE인 경우에만 허용됩니다.

ibmcloud logs-router migrate delete

명령 옵션

--force|-f`
확인 없이 작업을 삭제합니다.
help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.

iBM클라우드 로그-라우터 마이그레이션 상태

이 명령을 사용하여 상태 로그 라우팅 마이그레이션 상태 및 버전 정보를 검색할 수 있습니다. 가능한 상태는 다음과 같습니다: 완료, 이전, 진행 중, 완료 보류 중입니다.

ibmcloud logs-router migrate status

명령 옵션

help | --help | -h
명령에 사용할 수 있는 옵션을 나열합니다.