IBM Cloud Logs integration

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

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

IBM Cloud Logs regions
Deployment Region	IBM Cloud Logs 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`
`Madrid`	`Madrid`

Provisioning IBM Cloud Logs

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

HIPAA

IBM Cloud Logs 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 Logs

Once logs are being routed to the IBM Cloud Logs instances, each log can be viewed in detail. With the following values being delivered:

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.

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 Logs offers querying and filtering to help you navigate your logs. Export, COS archiving and multiple levels of indexing are available, so you can optimize the total cost of log streams for your use case.