---
title: Riak CS
description: Track the rate and mean latency of GETs, PUTs, DELETEs, and other operations.
breadcrumbs: Docs > Integrations > Riak CS
---

# Riak CS
Supported OS Integration version4.13.0


## Overview{% #overview %}

Capture RiakCS metrics in Datadog to:

- Visualize key RiakCS metrics.
- Correlate RiakCS performance with the rest of your applications.

**Minimum Agent version:** 6.0.0

## Setup{% #setup %}

### Installation{% #installation %}

The RiakCS check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you don't need to install anything else on your RiakCS nodes.

### Configuration{% #configuration %}

1. Edit the `riakcs.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory). See the [sample riakcs.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/riakcs/datadog_checks/riakcs/data/conf.yaml.example) for all available configuration options:

   ```yaml
   init_config:
   
   instances:
     ## @param access_id - string - required
     ## Enter you RiakCS access key.
     #
     - access_id: "<ACCESS_KEY>"
   
       ## @param access_secret - string - required
       ## Enter the corresponding RiakCS access secret.
       #
       access_secret: "<ACCESS_SECRET>"
   ```

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent).

### Validation{% #validation %}

[Run the Agent's `status` subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `riakcs` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **riakcs.block\_delete.latency\_mean**(gauge)         | Mean latency of BLOCK DELETE operations performed*Shown as microsecond*  |
| **riakcs.block\_delete.meter\_rate**(gauge)           | Rate of BLOCK DELETE operations performed*Shown as operation*            |
| **riakcs.block\_get.latency\_mean**(gauge)            | Mean latency of BLOCK GET operations performed*Shown as microsecond*     |
| **riakcs.block\_get.meter\_rate**(gauge)              | Rate of BLOCK GET operations performed*Shown as operation*               |
| **riakcs.block\_put.latency\_mean**(gauge)            | Mean latency of BLOCK PUT operations performed*Shown as microsecond*     |
| **riakcs.block\_put.meter\_rate**(gauge)              | Rate of BLOCK PUT operations performed*Shown as operation*               |
| **riakcs.bucket\_create.latency\_mean**(gauge)        | Mean latency of BUCKET CREATE operations performed*Shown as microsecond* |
| **riakcs.bucket\_create.meter\_rate**(gauge)          | Rate of BUCKET CREATE operations performed*Shown as operation*           |
| **riakcs.bucket\_delete.latency\_mean**(gauge)        | Mean latency of BUCKET DELETE operations performed*Shown as microsecond* |
| **riakcs.bucket\_delete.meter\_rate**(gauge)          | Rate of BUCKET DELETE operations performed*Shown as operation*           |
| **riakcs.object\_delete.latency\_mean**(gauge)        | Mean latency of DELETE operations performed*Shown as microsecond*        |
| **riakcs.object\_delete.meter\_rate**(gauge)          | Rate of DELETE operations performed*Shown as operation*                  |
| **riakcs.object\_get.latency\_mean**(gauge)           | Mean latency of GET operations performed*Shown as microsecond*           |
| **riakcs.object\_get.meter\_rate**(gauge)             | Rate of GET operations performed*Shown as operation*                     |
| **riakcs.object\_put.latency\_mean**(gauge)           | Mean latency of PUT operations performed*Shown as microsecond*           |
| **riakcs.object\_put.meter\_rate**(gauge)             | Rate of PUT operations performed*Shown as operation*                     |
| **riakcs.service\_get\_buckets.latency\_mean**(gauge) | Mean latency of GET BUCKETS operations performed*Shown as microsecond*   |
| **riakcs.service\_get\_buckets.meter\_rate**(gauge)   | Rate of GET BUCKETS operations performed*Shown as operation*             |

For RiakCS v2.1+, the default metrics collected by this integrations includes most S3 API metrics as well as memory stats. Some have been excluded:

- bucket*acl*(get|put)
- object*acl*(get|put)
- bucket*policy*(get|put|delete)
- *in*(one|total)
- *time\_error*\*
- _time_100

Any of the excluded metrics or additional metrics (1000+) can be added to the `riakcs.d/conf.yaml` configuration file with the `metrics` key in the `instance_config`. The value should be a list of metric names.

See the [complete list of available metrics](https://github.com/basho/riak_cs/wiki/Riak-cs-and-stanchion-metrics).

### Events{% #events %}

The RiakCS check does not include any events.

### Service Checks{% #service-checks %}

**riakcs.can\_connect**

Returns `CRITICAL` if the Agent is unable to connect to the monitored KyotoTycoon instance. Returns `OK` otherwise.

*Statuses: ok, critical*

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).

## Further Reading{% #further-reading %}

- [Monitor Riak CS performance and availability](https://www.datadoghq.com/blog/monitor-riak-cs-performance-and-availability)