Gerenciando as extensões do site IBM Cloud Logs

Em IBM Cloud Logs, as extensões oferecem configurações prontas para gerenciar os dados de registro. Uma extensão contém um conjunto de definições de recursos predefinidos, como alertas, regras de análise, painéis e outros, que você pode usar para começar a trabalhar rapidamente e monitorar e alertar sobre dados relevantes para a extensão.

É possível implementar todos os recursos ou um subconjunto de recursos de uma extensão no contexto de aplicativos e subsistemas selecionados.
Você pode gerenciar uma extensão graficamente por meio da interface do usuário ou programaticamente por meio da API.
Depois de implementar recursos de uma extensão, você pode personalizá-los.

Para evitar a substituição de alterações personalizadas em recursos predefinidos, você deve desanexar esses recursos da implementação da extensão. Você só pode desanexar recursos graficamente por meio da interface do usuário.
As extensões são classificadas por tipo. Os tipos válidos são Security e Observability.
As extensões incluem rótulos que você pode usar para filtrá-las. Por exemplo, a tag IBM está associada a extensões que você pode usar para monitorar o IBM Cloud.
As extensões podem incluir alertas predefinidos, regras de análise, definições de eventos para métricas, painéis e enriquecimentos.

Lista de extensões disponíveis

A lista a seguir descreve as extensões que podem ser implementadas para monitorar os registros:

Monitoramento do sistema: Use-o para obter informações sobre o desempenho de seu sistema e o uso de uma instância do IBM Cloud Logs.
Rastreamento de atividades: Use-o para obter insights sobre seus dados de rastreamento de atividades em IBM Cloud.
IBM Cloud Kubernetes Service: Use-o para obter informações sobre seus registros IBM Cloud Kubernetes Service.
IBM Cloud® Databases for MySQL: Use-o para obter informações sobre seus registros IBM Cloud® Databases for MySQL.
IBM Cloud Databases for PostgreSQL: Use-o para obter informações sobre seus registros IBM Cloud Databases for PostgreSQL.
IBM® Cloudant® for IBM Cloud®: Use-o para obter informações sobre seus registros IBM® Cloudant® for IBM Cloud®.
Cloudflare: Use-o para obter informações sobre seus registros do Cloudflare.
IBM Cloud® Databases for Redis: Use-o para obter informações sobre seus registros IBM Cloud Databases for Redis.
Linux: Use-o para obter informações sobre seus registros Linux.
MongoDB: Use-o para obter informações sobre seus registros MongoDB.
NGINX: Use-o para obter informações sobre os logs do nginx.

Lista de extensões disponíveis por ID

A tabela a seguir lista os IDs das extensões que você deve usar ao utilizar a API de extensões:

Ações de extensão usando a API REST do site IBM Cloud Logs
Extensão	ID
Monitoramento do Sistema	`SystemMonitoring`
Activity Tracking	`ActivityTracking`
IBM Cloud Kubernetes Service	`IBMCloudKubernetes`
IBM Cloud® Databases for MySQL	`IBMMySQL`
IBM Cloud Databases for PostgreSQL	`IBMPostgreSQL`
IBM® Cloudant® for IBM Cloud®	`IBMCloudant`
Cloudflare	`Cloudflare`
IBM Cloud® Databases for Redis	`IBMRedis`
Linux	`Linux`
MongoDB	`MongoDB`
NGINX	`NGINX`

Métodos de API

A tabela a seguir lista as ações que você pode executar para gerenciar as extensões:

Ações de extensão usando a API REST do site IBM Cloud Logs
Ação	Método de API de REST	API_URL
Listar extensões	`GET`	`<ENDPOINT>/v1/extensions`
Obter uma extensão por ID	`GET`	`<ENDPOINT>/v1/extensions/{id}`
Obter detalhes da implantação de uma extensão	`GET`	`<ENDPOINT>/v1/extensions/{id}/deployment`
Implantar uma extensão	`PUT`	`<ENDPOINT>/v1/extensions/{id}/deployment`
Atualizar uma extensão	`PUT`	`<ENDPOINT>/v1/extensions/{id}/deployment`
Remover uma extensão	`DELETE`	`<ENDPOINT>/v1/extensions/{id}/deployment`

Você pode usar o site público ou privado ENDPOINT para gerenciar as extensões. Para obter mais informações sobre os pontos de extremidade, consulte Pontos de extremidade da API de serviço.

Para obter mais informações sobre a API REST, consulte Extensões.

Obter a lista de extensões disponíveis por meio da interface do usuário

Para ver as extensões disponíveis na interface do usuário IBM Cloud Logs, conclua as etapas a seguir:

Ativar a IU do IBM Cloud Logs.
Clique no ícone Integrações > Extensões.

A lista de extensões disponíveis é exibida.

Obter a lista de extensões disponíveis usando a API

Para obter a lista de extensões disponíveis para implantação, incluindo detalhes adicionais sobre as que estão implantadas, conclua as etapas a seguir:

Obter o token de autenticação. Consulte Autenticação via API.
Obtenha o ponto de extremidade da instância em que você deseja gerenciar as extensões. Consulte Pontos de extremidade da API de serviço.

Liste todas as extensões, incluindo a versão e os recursos implantados por extensão.

curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions"

Obter a lista de extensões implantadas usando a API

Para obter informações sobre as extensões implantadas em uma instância do IBM Cloud Logs, você pode usar o método Get list of extensions. As informações incluem detalhes sobre a versão e os recursos implementados.

Por exemplo, conclua as etapas a seguir:

Obter o token de autenticação. Consulte Autenticação via API.
Obtenha o ponto de extremidade da instância em que você deseja implementar uma extensão. Consulte os pontos de extremidade da API de serviço.

Obter detalhes de uma extensão implantada.

curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions?deployed=true"

Obter a lista de extensões que não foram implantadas usando a API

Para obter informações sobre as extensões que ainda não foram implementadas em uma instância do IBM Cloud Logs, você pode usar o método Get list of extensions.

Por exemplo, conclua as etapas a seguir:

Obter o token de autenticação. Consulte Autenticação via API.
Obtenha o ponto de extremidade da instância em que você deseja implementar uma extensão. Consulte os pontos de extremidade da API de serviço.

Obter detalhes de uma extensão implantada.

curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions?deployed=false"

Implementação de uma extensão usando a API

Para implantar recursos incluídos em uma extensão, você pode usar o método de API Deploy ou atualizar a implantação de uma extensão.

Conclua as etapas a seguir para implementar uma extensão:

Obter o token de autenticação. Consulte Autenticação via API.
Obtenha o ponto de extremidade da instância em que você deseja implementar uma extensão. Consulte os pontos de extremidade da API de serviço.
Obtenha o ID da extensão que você deseja implantar. Consulte Lista de extensões disponíveis.

Obtenha detalhes de uma extensão por ID, incluindo informações sobre recursos implantados.

curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions/<ExtensionID>"

Por exemplo, para obter as informações da extensão Kubernetes, execute:

curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<ENDPOINT>/v1/extensions/IBMCloudKubernetes"

Você verá uma resposta parecida com a seguinte:

{
"id": "IBMCloudKubernetes",
"name": "IBM Cloud Kubernetes Service",
"revisions": [
    {
        "version": "1.0.0",
        "description": "# IBM Cloud Kubernetes Service\nThe dashboard provides an in-depth analysis of IBM Cloud Kubernetes Service, offering a comprehensive view of cluster performance, node activity, pod logs, and error analysis. It enables quick issue identification, trend analysis, and efficient Kubernetes monitoring.\n",
        "excerpt": "",
        "labels": [
            "IBM",
            "Kubernetes",
            "Сluster",
            "K8S",
            "Cloud",
            "Compute",
            "Observability"
        ],
        "items": [
            {
                "id": "1405e028-dd50-48a0-86c5-b361e029a3f1",
                "name": "IBM Kubernetes",
                "description": "Dashboard for IBM Cloud Kubernetes Service.",
                "target_domain": "dashboard"
            },
            {
                "id": "93cda01a-526e-4872-b29a-125645abf784",
                "name": "IBM Kubernetes - No logs from service",
                "description": "No logs have been received from the kubernetes service, indicating potential issues with logging configuration, service downtime, or connectivity problems affecting log transmission.",
                "target_domain": "alert"
            },
            {
                "id": "9e2099ee-78f4-4070-a1fd-7be109f136ce",
                "name": "IBM Kubernetes - More than 5 erroneous cluster logs within 15 minutes",
                "description": "Over five error logs have been recorded at the cluster level within a 15-minute window, indicating potential issues affecting the Kubernetes cluster's overall health or configuration.",
                "target_domain": "alert"
            },
            {
                "id": "f242dd8a-138a-4dcc-92b9-09f5ec1b4840",
                "name": "IBM Kubernetes - More than 5 erroneous pod logs within 15 minutes",
                "description": "More than five error logs have been detected in pod-level operations within 15 minutes, suggesting issues with workloads or pod-level configurations.",
                "target_domain": "alert"
            },
            {
                "id": "504c4f1a-4185-4619-bc7c-9d011b3f3245",
                "name": "IBM Kubernetes - Host change",
                "description": "A host change event has been detected, which might indicate a node replacement, scaling operation, or unexpected infrastructure changes.",
                "target_domain": "alert"
            },
            {
                "id": "c179c165-b12e-4f40-8e87-e4627d6dbdef",
                "name": "IBM Kubernetes - Permission denied",
                "description": "A permission denial has occurred during a Kubernetes operation, possibly caused by misconfigured access controls or insufficient permissions for the requested action.",
                "target_domain": "alert"
            }
        ]
    }
],
"changelog": [
    {
        "version": "1.0.0",
        "description_md": "### Changed\nRelease of an extension for the IBM Cloud Kubernetes Service.\n"
    }
]
}

Implemente a extensão. Por exemplo, você pode executar o seguinte comando cURL para implantar parcialmente a extensão Kubernetes. Esse exemplo cria um painel e dois alertas:

curl -X PUT --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data   '{
"version": "1.0.0",
"item_ids": [
  "1405e028-dd50-48a0-86c5-b361e029a3f1",
  "93cda01a-526e-4872-b29a-125645abf784",
  "9e2099ee-78f4-4070-a1fd-7be109f136ce"
],
"applications": [
  "myapp"
],
"subsystems": [
  "mysubsystem"
]

}' "https:// /v1/extensions/IBMCloudKubernetes/deployment"



## Atualização de uma extensão usando a API {: #extensions-mgmt-update-api api}

Talvez você queira implantar uma nova versão de uma extensão, implantar recursos adicionais ou modificar os aplicativos e subsistemas que estão configurados como fontes de dados relevantes para a extensão. Para atualizar os recursos incluídos em uma extensão, você pode usar o método de API [Deploy ou atualizar a implantação de uma extensão.](/apidocs/logs-service-api#update-extension-deployment)

Conclua as etapas a seguir para atualizar uma extensão:

Certifique-se de especificar na chamada à API todos os recursos dessa extensão que estão implantados no momento. Se você tiver modificado algum recurso implantado anteriormente a partir dessa extensão, desconecte-o antes de executar a atualização. Se você não incluir todos os recursos implantados anteriormente, os que não foram incluídos serão removidos.
{: attention}

1. Obter o token de autenticação. Consulte [Autenticação via API](/apidocs/logs-service-api#authentication).

2. Obtenha o ponto de extremidade da instância em que você deseja implementar uma extensão. Consulte [os pontos de extremidade da API de serviço](/docs/cloud-logs?topic=cloud-logs-endpoints_api).

3. Obtenha o ID da extensão que você deseja implantar. Consulte [Lista de extensões disponíveis](#extensions-mgmt-list).

4. Obtenha detalhes de uma extensão por ID, incluindo informações sobre recursos implantados. Verifique a seção de implementação para ver quais recursos já estão implementados.

   ```text {: codeblock}
   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions/<ExtensionID>"

Atualize a extensão. Por exemplo, você pode executar o seguinte comando cURL para atualizar a extensão Kubernetes e manter apenas 1 painel e 1 alerta:

curl -X PUT --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data   '{
"version": "1.0.0",
"item_ids": [
  "1405e028-dd50-48a0-86c5-b361e029a3f1",
  "93cda01a-526e-4872-b29a-125645abf784"
],
"applications": [
  "myapp"
],
"subsystems": [
  "mysubsystem"
]

}' "https:// /v1/extensions/IBMCloudKubernetes/deployment"

## Implementação de uma extensão {: #extensions-mgmt-deploy-ui ui}

Para implementar uma extensão, conclua as etapas a seguir:

1. [Faça login em sua conta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acesse sua instância IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Clique no **ícone Integrações** Ícone ![de integrações](/icons/integrations.svg "Integrações") > **Extensões**.

4. Clique em **Deploy** no bloco da extensão que você deseja implementar.

5. Selecione os *aplicativos* e *subsistemas* aos quais a extensão será aplicada.

6. Por padrão, tudo o que for definido na extensão será implantado. Você pode remover a marca de seleção de qualquer item que não queira implantar.

7. Clique em **+ Deploy** para instalar a extensão em suas instâncias de IBM Cloud Logs.


## Modificação de uma extensão implantada {: #extensions-mgmt-modify-ui ui}

Talvez você queira implantar uma nova versão de uma extensão, implantar recursos adicionais ou modificar os aplicativos e subsistemas que estão configurados como fontes de dados relevantes para a extensão.

Certifique-se de manter selecionados todos os recursos dessa extensão que estão implantados no momento. Se você tiver modificado algum recurso implantado anteriormente a partir dessa extensão, desconecte-o antes de executar a atualização. Se você não incluir todos os recursos implantados anteriormente, os que não foram incluídos serão removidos.
{: attention}

Conclua as etapas a seguir para atualizar uma extensão:

1. [Faça login em sua conta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acesse sua instância IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Clique no **ícone Integrações** Ícone ![de integrações](/icons/integrations.svg "Integrações") > **Extensões**.

4. Clique no bloco da extensão implantada que você deseja modificar.

5. Altere os valores de *Aplicativos* e *Subsistemas* conforme necessário.

   Quando você atualiza os valores de *Aplicativos* e *Subsistemas* na extensão, todos os recursos da extensão que você implanta são atualizados com a nova lista de valores de *Aplicativos* e *Subsistemas*.
   {: attention}

6. Clique em **Atualizar**.

## Remoção de uma extensão {: #extensions-mgmt-remove-ui ui}


Para remover uma extensão já implementada em sua instância, conclua as etapas a seguir:

1. [Faça login em sua conta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acesse sua instância IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Clique no **ícone Integrações** Ícone ![de integrações](/icons/integrations.svg "Integrações") > **Extensões**.

4. Clique no bloco da extensão implantada que você deseja remover.

5. Clique em **- Remove (Remover** ).

6. Selecione se deseja excluir ou manter os ativos implantados.

   Se você optar por excluir os ativos implementados, a extensão será excluída juntamente com os ativos implementados pela extensão na sua instância IBM Cloud Logs.

   Se você optar por manter os ativos implementados ao excluir a extensão, os ativos implementados pela extensão permanecerão em sua instância IBM Cloud Logs, mas não serão mais associados à extensão. Se você implantar a extensão novamente, uma nova cópia da extensão será implantada e os ativos implantados anteriormente permanecerão em sua instância IBM Cloud Logs e não serão substituídos.

7. Clique em **Remove**.

## Desvinculação de recursos de uma extensão implantada {: #extensions-mgmt-dettach-ui ui}

Para desanexar recursos de uma extensão implantada, conclua as etapas a seguir:

1. [Faça login em sua conta IBM Cloud](https://cloud.ibm.com/login){: external}.

2. [Acesse sua instância IBM Cloud Logs](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Clique no **ícone Integrações** Ícone ![de integrações](/icons/integrations.svg "Integrações") > **Extensões**.

4. Clique no bloco da extensão implantada que você deseja remover.

5. Clique em **- Remove (Remover** ).

6. Escolha `Retain all assets` para manter os ativos modificados que são implementados pela extensão em sua instância IBM Cloud Logs.

7. Clique em **Remove**.

   Os recursos de desanexação não serão mais associados à extensão.

   Se você implantar a extensão novamente, uma nova cópia da extensão será implantada e os ativos implantados anteriormente permanecerão em sua instância IBM Cloud Logs e não serão substituídos.


## Remoção de uma extensão {: #extensions-mgmt-remove-api api}


Para excluir uma extensão, você pode executar a seguinte chamada de API:

```text {: codeblock}
% curl -X DELETE --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<ENDPOINT>/v1/extensions/<ExtensionID>/deployment"