IBM Cloudant extension

In IBM® Cloud Logs, you can use the IBM Cloudant extension to gain insights into logs that are generated in an IBM Cloud account.

IBM Cloudant is a fully managed NoSQL database service that offers scalability capabilities for developers and businesses. It allows users to effortlessly handle large volumes of data and high traffic loads with minimal maintenance. Built on CouchDB technology with compatible API and replication protocols, IBM Cloudant supports flexible, schema-free JSON document storage, which is ideal for applications that require rapid, iterative development and dynamic data structures. Its high availability and automated failover ensure 99.99% SLA reliability and minimal downtime. IBM Cloudant also integrates seamlessly with other IBM Cloud services, providing a cohesive ecosystem for developing and managing modern applications.

Before you begin

With this extension, you can create a dashboard designed to visualize and analyze logs from the IBM Cloudant service. The dashboard lets you track database performance, detect errors, analyze memory usage and commands, and provides valuable insights to optimize caching and data storage operations.

In IBM Cloud Logs, logs that are generated by IBM Cloud services (known as platform logs) include metadata fields that you can use to enhance searches and analyze the data.

applicationName: The application name is the environment that produces and sends logs to IBM Cloud Logs. It is set to ibm-platform-logs.
subsystemName: The subsystem name is the service or application that produces and sends logs to IBM Cloud Logs. It is set to cloudantnosqldb:<instanceID> where <instanceID> is the IBM Cloudant instance ID.

In IBM Cloud, you must configure IBM Cloud Logs Routing to route logs to the IBM Cloud Logs service.

Before you can monitor logs that are generated in an IBM Cloud account, you must configure the IBM Cloud Logs Routing service in the account to define the destination where you want to monitor the logs.

You can configure 1 or more IBM Cloud Logs instances in the account.
Platform logs generated in the region are routed to the IBM Cloud Logs instance configured in IBM Cloud Logs Routing. The IBM Cloud Logs instance can be in the same region, or in a different region, in the account.
You must define a service to service authorization between IBM Cloud Logs Routing and IBM Cloud Logs to grant permissions to the IBM Cloud Logs Routing service to send logs to the IBM Cloud Logs service.

For more information, see:

What this extension deploys

This extension includes one or more items.

Items included when extension is deployed
Includes	Number
Alerts	1
Dashboards	1
Enrichments	0
Events to metrics	0
Rules	1
Views	0

Before deploying this extension, make sure that deploying the extension will not cause you to exceed limits for your IBM Cloud Logs instance. If deploying the extension results in limits being exceeded, the deployment will fail.

Deploying the extension

You can deploy this extension in any IBM Cloud Logs instance that collects IBM Cloudant logs. This extension includes a set of pre-configured resources such as dashboards and alerts that help you monitor critical metrics, identify anomalies, and optimize your system's performance.

For more information about deploying the extension, see Deploying, managing, and removing IBM Cloud Logs extensions.

After deploying, verify that the extension configuration handles data in a way that matches your IBM Cloud Logs instance TCO configuration. Alerts, dashboards, and events to metrics are features available for data handled through the Analyze and alert and the Priority insights data pipelines. After you deploy the extension, make sure the configuration meets your needs. For example, if you have TCO policies sending data to the Analyze and alert pipeline, you will need to change the dashboard configured by this extension to use Analyze and Alert data instead of Priority insights.

Dashboard

One dashboard is provided providing data about IBM Cloudant logs. This dashboard is designed to visualize and analyze logs from the IBM Cloudant service.

The dashboard includes:

Total log count
Actions by service in line view
List by database and action by dbName
List by client and action by ClientIP
Response by statusCode
List of statusCode and method
Request information by httpMethod
List of dbRequest
Detailed information about requests and methods

Alert

You can deploy the following alert:

IBM Cloudant - HTTP error responses detected: One or more HTTP requests to the IBM Cloudant service returned status codes greater than 400, indicating client or server errors (for example, 4xx or 5xx). These responses might point to issues such as authentication failures, invalid requests, rate limiting, or internal server problems.

Rules

You can deploy a rule to replace message text to avoid mapping exceptions.