IBM Cloud Log Analysis integration

IBM® Cloudant® for IBM Cloud® is integrated with IBM Cloud® Log Analysis, so you can view database logs.

Currently, IBM Cloud Log Analysis integration is available for IBM Cloudant deployments according to the following table:

Table 1. IBM Cloud Log Analysis regions
Deployment Region	IBM Cloud Log Analysis Region
`Chennai`	`Chennai`
`Dallas`	`Dallas`
`Frankfurt`	`Frankfurt`
`London`	`London`
`Osaka`	`Tokyo`
`São Paulo`	`São Paulo`
`Sydney`	`Sydney`
`Tokyo`	`Tokyo`
`Toronto`	`Toronto`
`Washington DC`	`Washington DC`

Provisioning IBM Cloud Log Analysis

Log information from your databases is automatically forwarded to IBM Cloud Log Analysis. In order to access it, you must provision IBM Cloud Log Analysis in your IBM Cloud account and configure the service to receive IBM Cloud service logs.

This setting enables logs from all IBM Cloud services on your account with IBM Cloud Log Analysis integration sending logs to your IBM Cloud Log Analysis service. For more information, see the list of integrated services.

IBM Cloud Log Analysis has a Lite plan that is free to use, but it offers only streaming events. To take advantage of the tagging, export, retention, and other features, you need to use one of the paid plans.

HIPAA

IBM Cloud Log Analysis does not currently offer a HIPAA-compliant plan for the service.

Use caution when you configure the platform service logs, since this setting can impact other services that require HIPAA compliance.

Using IBM Cloud Log Analysis

Once logs are being live-streamed, each log can be expanded to a detailed view by clicking the arrow by the timestamp.

The expanded view has some handy, color-coded fields to help you parse your logs.

Table 2. Line identifiers
Line Identifiers	Description
`Source`	The region the logs are being sent from.
`App`	The CRN of your database deployment that is sending the logs.

Table 3. Log lines
Log Lines	Description
`accountName`	The IBM Cloudant account identifier that you can use when you contact support about your environment.
`httpMethod`	Request method, for example, `GET`, `PUT`, to indicate the action to be performed for a specific resource.
`httpRequest`	The URL path for the HTTP request.
`bytesRead`	The size of the response body.
`clientIp`	The IP address of the originating request.
`clientPort`	The port address for the originating request.
`statusCode`	The HTTP status code returned from IBM Cloudant. For more information, see HTTP status codes.
`terminationState`	Session termination indicator for TCP and HTTP logs. For more information, see Session state at disconnection.
`dbName`	The IBM Cloudant database name targeted by the HTTP Request.
`dbRequest`	The database request endpoint.
`userAgent`	Software that is acting on behalf of the user, such as a browser or client library.
`sslVersion`	The version of Transport Layer Security that the request is using.
`cipherSuite`	The cipher suite used for the request.
`requestClass`	The class of metrics that the request is billed against. `Unlimited` is an unmetered event. For more information, see Request classes.
`parsedQueryString`	A parsed version that shows the breakdown of the parameters that are passed in the query string. If IBM Cloudant cannot parse the `rawQueryString`, this value is null.
`rawQueryString`	Full text of the query string as passed to the service.
`logSourceCRN`	The CRN of the IBM Cloudant instance emitting logs.
`meta`	A line reserved for additional information from IBM Cloudant.
`timings`	`connect` - The total time to accept TCP connection and execute handshakes for SSL protocol. This time happens only once during the connection's lifetime, so subsequent requests that are sent over the same connection show `0` for this value. `request` - The total time to get the client request. It's the time that is elapsed between the first bytes received and the moment the service receives the last byte of the request body. `transfer`- The data transmission time to transfer the full response from the service to the client. `response`- The total active time for the HTTP request, between the moment the service received the first byte of the request header and the emission of the last byte of the response body.

The request and transfer timings are included in response.

IBM Cloud Log Analysis offers searching and filtering to help you navigate your logs. Export and archive are available so you can customize retention (and cost) for your use case.