Verwaltung von IBM Cloud Logs Erweiterungen

In IBM Cloud Logs bieten die Erweiterungen Standardkonfigurationen für die Verwaltung von Protokolldaten. Eine Erweiterung enthält eine Reihe von vordefinierten Ressourcendefinitionen, wie z. B. Warnmeldungen, Parsing-Regeln, Dashboards usw., die Sie verwenden können, um schnell in Betrieb zu gehen und Daten zu überwachen, die für die Erweiterung relevant sind, und entsprechende Warnmeldungen zu versenden.

Sie können alle Ressourcen oder eine Teilmenge der Ressourcen einer Erweiterung im Kontext ausgewählter Anwendungen und Subsysteme bereitstellen.
Sie können eine Erweiterung grafisch über die Benutzeroberfläche oder programmatisch über die API verwalten.
Nachdem Sie Ressourcen aus einer Erweiterung bereitgestellt haben, können Sie diese anpassen.

Um zu verhindern, dass benutzerdefinierte Änderungen an vordefinierten Ressourcen überschrieben werden, müssen Sie diese Ressourcen von der Bereitstellung der Erweiterung abkoppeln. Sie können Ressourcen nur grafisch über die Benutzeroberfläche abtrennen.
Erweiterungen werden nach Typ klassifiziert. Gültige Typen sind Security, und Observability.
Erweiterungen enthalten Bezeichnungen, mit denen Sie sie filtern können. Beispielsweise ist das Tag IBM mit Erweiterungen verbunden, die Sie zur Überwachung der IBM Cloud verwenden können.
Zu den Erweiterungen können vordefinierte Warnmeldungen, Parsing-Regeln, Definitionen von Ereignissen zu Metriken, Dashboards und Anreicherungen gehören.

Liste der verfügbaren Erweiterungen

In der folgenden Liste sind die Erweiterungen aufgeführt, die Sie zur Überwachung von Protokollen einsetzen können:

Systemüberwachung: Nutzen Sie diese Funktion, um Einblicke in die Leistung Ihres Systems und die Nutzung einer IBM Cloud Logs-Instanz zu erhalten.
Aktivitätstracking: Nutzen Sie es, um Einblicke in Ihre IBM Cloud Aktivitätsdaten zu erhalten.
IBM Cloud Kubernetes Service: Nutzen Sie es, um Einblicke in Ihre IBM Cloud Kubernetes Service Protokolle zu erhalten.
IBM Cloud® Databases for MySQL: Nutzen Sie es, um Einblicke in Ihre IBM Cloud® Databases for MySQL Protokolle zu erhalten.
IBM Cloud Databases for PostgreSQL: Nutzen Sie es, um Einblicke in Ihre IBM Cloud Databases for PostgreSQL Protokolle zu erhalten.
IBM® Cloudant® for IBM Cloud®: Nutzen Sie es, um Einblicke in Ihre IBM® Cloudant® for IBM Cloud® Protokolle zu erhalten.
Cloudflare: Verwenden Sie es, um Einblicke in Ihre Cloudflare-Protokolle zu erhalten.
IBM Cloud® Databases for Redis: Nutzen Sie es, um Einblicke in Ihre IBM Cloud Databases for Redis Protokolle zu erhalten.
Linux: Nutzen Sie es, um Einblicke in Ihre Linux Protokolle zu erhalten.
MongoDB: Nutzen Sie es, um Einblicke in Ihre MongoDB Protokolle zu erhalten.
NGINX: Verwenden Sie es, um Einblicke in Ihre Nginx-Protokolle zu erhalten.

Liste der verfügbaren Erweiterungen nach ID

In der folgenden Tabelle sind die IDs der Erweiterungen aufgeführt, die Sie bei der Verwendung der Erweiterungs-API verwenden müssen:

Erweiterungsaktionen unter Verwendung der IBM Cloud Logs REST API
Erweiterung	ID
Systemüberwachung	`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`

API-Methoden

In der folgenden Tabelle sind die Aktionen aufgeführt, die Sie zur Verwaltung von Erweiterungen ausführen können:

Erweiterungsaktionen unter Verwendung der IBM Cloud Logs REST API
Aktion	REST-API-Methode	API_URL
Erweiterungen auflisten	`GET`	`<ENDPOINT>/v1/extensions`
Abrufen einer Erweiterung nach ID	`GET`	`<ENDPOINT>/v1/extensions/{id}`
Einsatzdetails einer Erweiterung abrufen	`GET`	`<ENDPOINT>/v1/extensions/{id}/deployment`
Bereitstellen einer Erweiterung	`PUT`	`<ENDPOINT>/v1/extensions/{id}/deployment`
Aktualisierung einer Erweiterung	`PUT`	`<ENDPOINT>/v1/extensions/{id}/deployment`
Entfernen einer Erweiterung	`DELETE`	`<ENDPOINT>/v1/extensions/{id}/deployment`

Sie können die öffentliche oder die private ENDPOINT verwenden, um Erweiterungen zu verwalten. Weitere Informationen zu den Endpunkten finden Sie unter Dienst-API-Endpunkte.

Weitere Informationen über die REST-API finden Sie unter Erweiterungen.

Abrufen der Liste der verfügbaren Erweiterungen über die Benutzeroberfläche

Führen Sie die folgenden Schritte aus, um die Erweiterungen anzuzeigen, die über die Benutzeroberfläche IBM Cloud Logs verfügbar sind:

Starten Sie die Benutzerschnittstelle von IBM Cloud Logs.
Klicken Sie auf das Integrationssymbol > Erweiterungen.

Die Liste der verfügbaren Erweiterungen wird angezeigt.

Abrufen der Liste der verfügbaren Erweiterungen mit Hilfe der API

Führen Sie die folgenden Schritte aus, um die Liste der für die Bereitstellung verfügbaren Erweiterungen zu erhalten, einschließlich zusätzlicher Details zu den bereitgestellten Erweiterungen:

Abrufen des Authentifizierungs-Tokens. Siehe Authentifizierung über API.
Ermitteln Sie den Endpunkt der Instanz, in der Sie Erweiterungen verwalten möchten. Siehe Dienst-API-Endpunkte.

Alle Erweiterungen auflisten, einschließlich Version und eingesetzte Ressourcen pro Erweiterung.

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

Abrufen der Liste der installierten Erweiterungen mit Hilfe der API

Um Informationen über die Erweiterungen zu erhalten, die in einer IBM Cloud Logs-Instanz bereitgestellt werden, können Sie die Methode Get list of extensions verwenden. Die Informationen umfassen Details zur Version und zu den eingesetzten Ressourcen.

Führen Sie zum Beispiel die folgenden Schritte aus:

Abrufen des Authentifizierungs-Tokens. Siehe Authentifizierung über API.
Ermitteln Sie den Endpunkt der Instanz, in der Sie eine Erweiterung bereitstellen möchten. Siehe Service-API-Endpunkte.

Abrufen von Details zu einer eingesetzten Erweiterung.

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

Abrufen der Liste der Erweiterungen, die nicht über die API bereitgestellt werden

Um Informationen über die Erweiterungen zu erhalten, die noch nicht in einer IBM Cloud Logs Instanz bereitgestellt wurden, können Sie die Methode Get list of extensions verwenden.

Führen Sie zum Beispiel die folgenden Schritte aus:

Abrufen des Authentifizierungs-Tokens. Siehe Authentifizierung über API.
Ermitteln Sie den Endpunkt der Instanz, in der Sie eine Erweiterung bereitstellen möchten. Siehe Service-API-Endpunkte.

Abrufen von Details zu einer eingesetzten Erweiterung.

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

Bereitstellen einer Erweiterung über die API

Um Ressourcen, die in einer Erweiterung enthalten sind, bereitzustellen, können Sie die API-Methode Deploy oder Update Deploy einer Erweiterung verwenden...

Führen Sie die folgenden Schritte aus, um eine Erweiterung bereitzustellen:

Abrufen des Authentifizierungs-Tokens. Siehe Authentifizierung über API.
Ermitteln Sie den Endpunkt der Instanz, in der Sie eine Erweiterung bereitstellen möchten. Siehe Service-API-Endpunkte.
Ermitteln Sie die ID der Erweiterung, die Sie bereitstellen möchten. Siehe Liste der verfügbaren Erweiterungen.

Abrufen von Details zu einer Erweiterung nach ID, einschließlich Informationen über eingesetzte Ressourcen.

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

Um zum Beispiel die Informationen für die Erweiterung Kubernetes abzurufen, führen Sie diesen Befehl aus:

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

Sie werden eine Antwort erhalten, die wie folgt aussieht:

{
"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"
    }
]
}

Stellen Sie die Erweiterung bereit. Sie können zum Beispiel den folgenden cURL Befehl ausführen, um die Kubernetes Erweiterung teilweise zu verteilen. Dieses Beispiel erstellt ein Dashboard und 2 Warnmeldungen:

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"



## Aktualisierung einer Erweiterung mit Hilfe der API {: #extensions-mgmt-update-api api}

Möglicherweise möchten Sie eine neue Version einer Erweiterung bereitstellen, zusätzliche Ressourcen bereitstellen oder die Anwendungen und Subsysteme ändern, die als Quellen der für die Erweiterung relevanten Daten konfiguriert sind. Um Ressourcen zu aktualisieren, die in einer Erweiterung enthalten sind, können Sie die API-Methode [Deploy oder Update Deploy einer Erweiterung](/apidocs/logs-service-api#update-extension-deployment) verwenden...

Führen Sie die folgenden Schritte aus, um eine Erweiterung zu aktualisieren:

Stellen Sie sicher, dass Sie im API-Aufruf alle Ressourcen dieser Erweiterung angeben, die derzeit bereitgestellt werden. Wenn Sie Ressourcen geändert haben, die zuvor über diese Erweiterung bereitgestellt wurden, trennen Sie die Ressourcen, bevor Sie das Update ausführen. Wenn Sie nicht alle zuvor bereitgestellten Ressourcen einbeziehen, werden die nicht einbezogenen Ressourcen entfernt.
{: attention}

1. Abrufen des Authentifizierungs-Tokens. Siehe [Authentifizierung über API](/apidocs/logs-service-api#authentication).

2. Ermitteln Sie den Endpunkt der Instanz, in der Sie eine Erweiterung bereitstellen möchten. Siehe [Service-API-Endpunkte](/docs/cloud-logs?topic=cloud-logs-endpoints_api).

3. Ermitteln Sie die ID der Erweiterung, die Sie bereitstellen möchten. Siehe [Liste der verfügbaren Erweiterungen](#extensions-mgmt-list).

4. Abrufen von Details zu einer Erweiterung nach ID, einschließlich Informationen über eingesetzte Ressourcen. Prüfen Sie im Abschnitt Bereitstellung, welche Ressourcen bereits bereitgestellt sind.

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

Aktualisieren Sie die Erweiterung. Sie können z. B. den folgenden Befehl cURL ausführen, um die Erweiterung Kubernetes zu aktualisieren und nur 1 Dashboard und 1 Alarm zu behalten:

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"

## Bereitstellen einer Erweiterung {: #extensions-mgmt-deploy-ui ui}

Führen Sie die folgenden Schritte aus, um eine Erweiterung bereitzustellen:

1. [Melden Sie sich bei Ihrem IBM Cloud Konto an](https://cloud.ibm.com/login){: external}.

2. [Zugriff auf Ihre IBM Cloud Logs Instanz](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Klicken Sie auf das **Integrationssymbol** ![Integrationssymbol Integration](/icons/integrations.svg "Integration") > **Erweiterungen**.

4. Klicken Sie auf der Kachel der Erweiterung, die Sie bereitstellen möchten, auf **Bereitstellen**.

5. Wählen Sie die *Anwendungen* und *Teilsysteme* aus, auf die die Erweiterung angewendet werden soll.

6. Standardmäßig wird alles, was in der Erweiterung definiert ist, bereitgestellt. Sie können das Häkchen bei jedem Element, das Sie nicht bereitstellen möchten, entfernen.

7. Klicken Sie auf **+ Deploy**, um die Erweiterung in Ihren IBM Cloud Logs Instanzen zu installieren.


## Ändern einer bereitgestellten Erweiterung {: #extensions-mgmt-modify-ui ui}

Möglicherweise möchten Sie eine neue Version einer Erweiterung bereitstellen, zusätzliche Ressourcen bereitstellen oder die Anwendungen und Subsysteme ändern, die als Quellen der für die Erweiterung relevanten Daten konfiguriert sind.

Vergewissern Sie sich, dass Sie alle Ressourcen dieser Erweiterung, die derzeit bereitgestellt werden, ausgewählt haben. Wenn Sie Ressourcen geändert haben, die zuvor über diese Erweiterung bereitgestellt wurden, trennen Sie die Ressourcen, bevor Sie das Update ausführen. Wenn Sie nicht alle zuvor bereitgestellten Ressourcen einbeziehen, werden die nicht einbezogenen Ressourcen entfernt.
{: attention}

Führen Sie die folgenden Schritte aus, um eine Erweiterung zu aktualisieren:

1. [Melden Sie sich bei Ihrem IBM Cloud Konto an](https://cloud.ibm.com/login){: external}.

2. [Zugriff auf Ihre IBM Cloud Logs Instanz](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Klicken Sie auf das **Integrationssymbol** ![Integrationssymbol Integration](/icons/integrations.svg "Integration") > **Erweiterungen**.

4. Klicken Sie auf die Kachel der bereitgestellten Erweiterung, die Sie ändern möchten.

5. Ändern Sie die Werte für *Anwendungen* und *Subsysteme* nach Bedarf.

   Wenn Sie die Werte für *Anwendungen* und *Subsysteme* in der Erweiterung aktualisieren, werden alle Ressourcen in der Erweiterung, die Sie bereitstellen, mit der neuen Liste der Werte für *Anwendungen* und *Subsysteme* aktualisiert.
   {: attention}

6. Klicken Sie auf **Aktualisieren**.

## Entfernen einer Erweiterung {: #extensions-mgmt-remove-ui ui}


Um eine Erweiterung zu entfernen, die Sie bereits in Ihrer Instanz installiert haben, führen Sie die folgenden Schritte aus:

1. [Melden Sie sich bei Ihrem IBM Cloud Konto an](https://cloud.ibm.com/login){: external}.

2. [Zugriff auf Ihre IBM Cloud Logs Instanz](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Klicken Sie auf das **Integrationssymbol** ![Integrationssymbol Integration](/icons/integrations.svg "Integration") > **Erweiterungen**.

4. Klicken Sie auf die Kachel der installierten Erweiterung, die Sie entfernen möchten.

5. Klicken Sie auf **- Entfernen**.

6. Wählen Sie, ob Sie die bereitgestellten Assets löschen oder behalten möchten.

   Wenn Sie sich für das Löschen der bereitgestellten Elemente entscheiden, wird die Erweiterung zusammen mit den von der Erweiterung bereitgestellten Elementen in Ihrer IBM Cloud Logs Instanz gelöscht.

   Wenn Sie sich beim Löschen der Erweiterung für die Beibehaltung der bereitgestellten Assets entscheiden, verbleiben die von der Erweiterung bereitgestellten Assets in Ihrer IBM Cloud Logs Instanz, werden aber nicht mehr mit der Erweiterung verknüpft. Wenn Sie die Erweiterung erneut bereitstellen, wird eine neue Kopie der Erweiterung bereitgestellt, und die zuvor bereitgestellten Elemente verbleiben in Ihrer Instanz IBM Cloud Logs und werden nicht überschrieben.

7. Klicken Sie auf **Entfernen**.

## Abkoppeln von Ressourcen von einer bereitgestellten Erweiterung {: #extensions-mgmt-dettach-ui ui}

Führen Sie die folgenden Schritte aus, um Ressourcen von einer bereitgestellten Erweiterung zu trennen:

1. [Melden Sie sich bei Ihrem IBM Cloud Konto an](https://cloud.ibm.com/login){: external}.

2. [Zugriff auf Ihre IBM Cloud Logs Instanz](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. Klicken Sie auf das **Integrationssymbol** ![Integrationssymbol Integration](/icons/integrations.svg "Integration") > **Erweiterungen**.

4. Klicken Sie auf die Kachel der installierten Erweiterung, die Sie entfernen möchten.

5. Klicken Sie auf **- Entfernen**.

6. Wählen Sie `Retain all assets`, um die geänderten Assets, die von der Erweiterung bereitgestellt werden, in Ihrer IBM Cloud Logs Instanz zu behalten.

7. Klicken Sie auf **Entfernen**.

   Dettach-Ressourcen werden nicht mehr mit der Erweiterung verknüpft.

   Wenn Sie die Erweiterung erneut bereitstellen, wird eine neue Kopie der Erweiterung bereitgestellt, und die zuvor bereitgestellten Elemente verbleiben in Ihrer Instanz IBM Cloud Logs und werden nicht überschrieben.


## Entfernen einer Erweiterung {: #extensions-mgmt-remove-api api}


Um eine Nebenstelle zu löschen, können Sie den folgenden API-Aufruf ausführen:

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