CLI do IBM Cloud Logs Routing

A interface da linha de comandos (CLI) da IBM Cloud® fornece recursos adicionais para ofertas de serviços. Estas informações descrevem como você pode usar a CLI para definir e gerenciar o serviço IBM Cloud Logs Routing usando a CLI.

Antes de Iniciar

Conclua as etapas a seguir:

Instale a CLI da IBM Cloud.
Instale e configure a CLI do IBM Cloud Logs Routing.

Você será notificado na linha de comandos quando as atualizações da CLI e dos plug-ins da IBM Cloud estiverem disponíveis. Certifique-se de manter sua CLI atualizada para poder usar os comandos mais recentes. É possível visualizar a versão atual de todos os plug-ins instalados executando ibmcloud plugin list.

ibmcloud logs-router route create

Use esse comando para criar uma rota que defina como os dados são roteados para os destinos IBM Cloud Logs Routing em uma conta de uma ou mais regiões. Uma rota pode ser gerenciada na conta em que foi criada ou pode ser gerenciada pela conta principal da empresa.

Os alvos devem ser instâncias de IBM Cloud Logs.

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

Opções de comando

--name ROUTE_NAME

O nome a ser fornecido à rota.

O comprimento máximo é de 1.000 caracteres. O comprimento mínimo é de 1 caractere.

O nome não pode incluir nenhum caractere especial além de (space) - . _ :.

Não inclua nenhuma PII (Personal Identifying Information) em quaisquer nomes de recursos.

--rules RULES | @RULES-FILE

Regras de roteamento que serão avaliadas na ordem em que foram configuradas.

Deve ser definido como uma cadeia de caracteres JSON entre aspas simples ou um caminho para um arquivo JSON.

O comprimento máximo é de 10 regras. O comprimento mínimo é de 1 regra.

Por exemplo, você pode definir uma cadeia de caracteres JSON da seguinte forma ou usar @filepath para passar o json:

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

Você pode formatar o arquivo JSON da seguinte maneira para rotear todos os dados para os destinos configurados na regra:

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

A definição da regra pode, opcionalmente, incluir filtros de inclusão. Você pode formatar o arquivo JSON da seguinte maneira:

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

Em que:

action

A ação define se o site IBM Cloud Logs Routing inclui ou exclui os registros na rota. Há suporte para duas ações: send e drop. Se não for especificado, a ação padrão é enviar os registros.

send: Os registros são enviados, com base na regra de roteamento, na rota definida.
drop: Os registros são excluídos, com base na regra de roteamento, quando os registros são enviados na rota definida.

targets

Os destinos definem os IBM Cloud Logs para onde os registros são encaminhados. É uma lista de IDs de destino separada por vírgulas.

inclusion_filters

Os filtros de inclusão definem quais dados são roteados.

Você pode configurar uma lista de filtros separada por vírgulas.

Um filtro é definido por um operando, um operador e valores.

Você pode definir um máximo de 7 filtros por regra.

operand

Operand é o nome da propriedade na qual o operator é executado.

Os operandos válidos são: location.

operator

Há suporte para dois operadores: in e is.

in

O valor da propriedade do operando é comparado a uma lista de valores.

Você pode definir até 20 valores.

is

O valor da propriedade do operando é comparado a um único valor.

Ao usar is, somente um valor pode ser especificado.

values

Uma cadeia de caracteres, ou uma matriz de cadeias de caracteres, a ser comparada com a propriedade operand para determinar se o registro é roteado ou não.

Quando o is operator é usado, o values deve incluir uma única cadeia de caracteres.

Quando o in operator é usado, o values pode incluir várias cadeias de caracteres em uma matriz.

--managed-by

Identifica como uma rota é gerenciada.

Uma rota pode ser gerenciada localmente na conta em que foi criada, definindo o valor padrão account, ou pode ser gerenciada pela conta corporativa, definindo o valor enterprise.

Os valores válidos são: enterprise, ou account.

O valor padrão é "account".

Não é possível alterar esse valor após a criação da rota.

--output FORMAT

Se JSON for especificado, a saída será retornada no formato JSON. Se JSON não for especificado, a saída será retornada em um formato tabular.

help | --help | -h

Liste as opções disponíveis para o comando.

ibmcloud logs-router route update

Use esse comando para atualizar uma rota que define como os dados são roteados para os destinos IBM Cloud Logs Routing em uma conta de uma ou mais regiões.

Qualquer valor especificado que seja diferente de quando a rota foi originalmente criada é atualizado para o valor especificado no comando. Qualquer configuração implantada anteriormente e não incluída na solicitação de atualização é removida.

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

Opções de comando

--route ROUTE

O ID ou o nome da rota.

O ID é um UUID v4 que identifica a rota de forma exclusiva.

O comprimento máximo do ID é de 1.028 caracteres. O comprimento mínimo do ID é de 24 caracteres.

--name NAME

O novo nome a ser dado à rota (opcional).

Não inclua nenhuma PII (Personal Identifying Information) em quaisquer nomes de recursos.

--rules RULES | @RULES-FILE

Regras de roteamento que serão avaliadas na ordem em que foram configuradas.

Deve ser definido como uma cadeia de caracteres JSON entre aspas simples ou um caminho para um arquivo JSON.

O comprimento máximo é de 10 regras. O comprimento mínimo é de 1 regra.

Mantenha sua configuração atual, além das modificações que você precisa fazer. Qualquer configuração de regra existente que não esteja incluída na atualização é excluída.

Por exemplo, veja o exemplo de uma definição de regra formatada em JSON ou use @filepath para passar o json:

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

Você pode formatar o arquivo JSON da seguinte maneira para rotear todos os dados para os destinos configurados na regra:

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

A definição da regra pode, opcionalmente, incluir filtros de inclusão. Você pode formatar o arquivo JSON da seguinte maneira:

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

action

send: Os registros são enviados, com base na regra de roteamento, na rota definida.
drop: Os registros são excluídos, com base na regra de roteamento, quando os registros são enviados na rota definida.

targets

Os destinos definem os IBM Cloud Logs para onde os registros são encaminhados. É uma lista de IDs de destino separada por vírgulas.

inclusion_filters

Os filtros de inclusão definem quais dados são roteados.

Você pode configurar uma lista de filtros separada por vírgulas.

Um filtro é definido por um operando, um operador e valores.

Você pode definir um máximo de 7 filtros por regra.

operand

Operand é o nome da propriedade na qual o operator é executado.

Os operandos válidos são: location.

operator

Há suporte para dois operadores: in e is.

in

O valor da propriedade do operando é comparado a uma lista de valores.

Você pode definir até 20 valores.

is

O valor da propriedade do operando é comparado a um único valor.

Ao usar is, somente um valor pode ser especificado.

values

Uma cadeia de caracteres, ou uma matriz de cadeias de caracteres, a ser comparada com a propriedade operand para determinar se o registro é roteado ou não.

Quando o is operator é usado, o values deve incluir uma única cadeia de caracteres.

Quando o in operator é usado, o values pode incluir várias cadeias de caracteres em uma matriz.

--output FORMAT

Se JSON for especificado, a saída será retornada no formato JSON. Se JSON não for especificado, a saída será retornada em um formato tabular.

help | --help | -h

Liste as opções disponíveis para o comando.

ibmcloud logs-router route delete

Use esse comando para excluir uma rota IBM Cloud Logs Routing.

ibmcloud logs-router route delete --route ROUTE

Opções de comando

--route ROUTE: A ID ou o nome da rota a ser excluída.
--force ou --f: Exclui a rota sem fornecer ao usuário nenhuma solicitação adicional.
help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router route get

Use esse comando para obter informações de configuração sobre uma rota IBM Cloud Logs Routing.

ibmcloud logs-router route get --route ROUTE

Opções de comando

--route ROUTE: O ID ou o nome da rota.
help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router route list

Use esse comando para listar todas as rotas configuradas para IBM Cloud Logs Routing na conta.

ibmcloud logs-router route list

Opções de comando

help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router target create

Use esse comando para criar um destino a ser usado para configurar um destino para métricas de plataforma. Você pode enviar os logs da plataforma de todas as regiões para um único alvo, diferentes alvos ou vários alvos. Não é necessário um alvo por região. Você pode definir até 16 alvos por conta.

Os alvos devem ser instâncias de IBM Cloud Logs.

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

Opções de comando

--region REGION

Nome da região, por exemplo, us-south ou eu-gb. Se não for especificado, será usada a região que estiver conectada ou direcionada. Isso é opcional.

--name NAME

O nome a ser fornecido ao destino.

Não inclua nenhuma PII (Personal Identifying Information) em quaisquer nomes de recursos.

--destination-crn DESTINATION-CRN

O CRN da instância de serviço ou recurso para receber os registros enviados por IBM Cloud Logs Routing. Certifique-se de que você tenha uma autorização de serviço entre IBM Cloud Logs Routing e seu recurso IBM Cloud. Para obter mais informações, consulte Gerenciamento de autorizações para conceder acesso entre serviços.

[--managed-by MANAGED-BY] Isso é opcional. Identifica quem gerencia esse alvo. Opcional no momento da criação. Se for definido como "enterprise", o destino se tornará gerenciado pela empresa e só poderá ser modificado por identidades autorizadas para as ações corporativas. Se for omitido ou definido como "account", o destino será gerenciado pela conta secundária. Esse valor é imutável após a criação. Os valores permitidos são: empresa, conta.

help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router target update

Use esse comando para atualizar um destino a ser usado para configurar um destino para métricas de plataforma.

Os alvos devem ser instâncias de IBM Cloud Logs.

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

Opções de comando

--target TARGET O ID ou nome do destino.

--name NAME

O novo nome a ser dado ao alvo.

Não inclua nenhuma PII (Personal Identifying Information) em quaisquer nomes de recursos.

--destination-crn DESTINATION_CRN

help | --help | -h

Liste as opções disponíveis para o comando.

ibmcloud logs-router target delete

Use este comando para excluir um destino.

ibmcloud logs-router target delete --target TARGET

Opções de comando

--target TARGET: O ID ou nome do destino.
--force | -f: Exclui o alvo sem fornecer ao usuário nenhum prompt adicional.
help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router target get

Use esse comando para obter informações sobre um alvo IBM Cloud Logs Routing.

ibmcloud logs-router target get --target TARGET

Opções de comando

--target TARGET: O ID ou nome do destino.
help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router target list

Use esse comando para listar todos os alvos configurados para IBM Cloud Logs Routing.

ibmcloud logs-router target list

Opções de comando

help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router setting get

Use esse comando para obter as configurações do nível de conta IBM Cloud Logs Routing.

ibmcloud logs-router setting get

Opções de comando

help | --help | -h: Liste as opções disponíveis para o comando.

atualização da configuração do roteador de logs do ibmcloud

Use esse comando para modificar as configurações atuais, como os destinos padrão, as regiões de destino permitidas e as regiões de metadados primárias e secundárias em IBM Cloud Logs Routing. Qualquer valor que seja diferente de quando o destino foi originalmente criado é atualizado para o valor especificado no comando. Se nenhuma opção for especificada, as configurações atuais serão retornadas.

Antes de desativar os terminais públicos, configurando --private-api-endpoint-only TRUE, certifique-se de que sua conta tenha acesso ao terminal privado. Você pode fazer isso executando o comando ibmcloud account show. Se VRF Enabled for true e Service Endpoint Enabled for true, você tem acesso ao terminal privado. Se você não tiver acesso ao ponto de extremidade privado, não poderá ativar o ponto de extremidade público. O acesso ao ponto de extremidade privado é necessário para ativar o ponto de extremidade público.

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]

Opções de comando

--api-version: Versão da API do serviço IBM Cloud Logs Routing na conta IBM Cloud. Os valores válidos são 1 e 3. O valor padrão é 1. Você pode atualizar de 1 para 3 para migrar sua configuração de serviço somente se tiver criado alvos e locatários válidos em V1. Observe que, depois de fazer essa atualização, não há opção para voltar à versão 1. Para obter mais informações, consulte https://ibm.biz/lr-v3migration.
--backup-metadata-region: Região de backup usada para fazer backup dos metadados do IBM Cloud Logs Routing. O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 3 caracteres.
--default-targets: Alvos que recebem registros que não são gerenciados explicitamente nas regras de roteamento da conta IBM Cloud Logs Routing. Você pode definir até 2 alvos. O número mínimo de alvos é 0.
--permitted-target-regions: Lista separada por vírgulas de regiões compatíveis com IBM Cloud Logs Routing, onde os usuários podem criar alvos na conta. Para obter mais informações, consulte https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations. O comprimento máximo é de 16 regiões. O comprimento mínimo é de 0 região.
--primary-metadata-region: Região primária usada para fazer backup dos metadados do IBM Cloud Logs Routing. O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 3 caracteres.
--private-api-endpoint-only: Conectividade de endpoint suportada. Defina esse valor como "false" para acessar a API por meio da rede pública. Defina esse valor como "true" para acessar a API somente por meio da rede privada.
help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router migrate complete

Use esse comando para concluir os registros de migração do roteamento da versão 1 para a versão 3. O status da migração deve ser PENDING_COMPLETION para usar esse comando.

ibmcloud logs-router migrate complete

Opções de comando

help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router migrate generate

Use esse comando para iniciar a migração assíncrona do roteamento de logs da versão 1 para a versão 3. O status da migração deve estar ANTES de usar esse comando.

ibmcloud logs-router migrate generate

Opções de comando

help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router migrate delete

Use esse comando para excluir todas as rotas e destinos da versão 3 do roteamento de registros e redefinir o status de migração para ANTES. Permitido somente quando o estado for PENDING_COMPLETION ou BEFORE.

ibmcloud logs-router migrate delete

Opções de comando

--force|-f`: Exclui a operação sem confirmação.
help | --help | -h: Liste as opções disponíveis para o comando.

ibmcloud logs-router migrate status

Use esse comando para recuperar os registros de status, o estado de migração de roteamento e as informações de versão. Os estados possíveis são: COMPLETE, BEFORE, IN_PROGRESS e PENDING_COMPLETION.

ibmcloud logs-router migrate status

Opções de comando

help | --help | -h: Liste as opções disponíveis para o comando.