---
title: Kyoto Tycoon
description: Track get, set, and delete operations; monitor replication lag.
breadcrumbs: Docs > Integrations > Kyoto Tycoon
---

# Kyoto Tycoon
Supported OS Integration version4.5.0
## Overview{% #overview %}

The Agent's KyotoTycoon check tracks get, set, and delete operations, and lets you monitor replication lag.

**Minimum Agent version:** 6.0.0

## Setup{% #setup %}

### Installation{% #installation %}

The KyotoTycoon 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 KyotoTycoon servers.

### Configuration{% #configuration %}

1. Edit the `kyototycoon.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 kyototycoon.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/kyototycoon/datadog_checks/kyototycoon/data/conf.yaml.example) for all available configuration options:

   ```yaml
   init_config:
   
   instances:
     ## @param report_url - string - required
     ## The report URL should be a URL to the Kyoto Tycoon "report" RPC endpoint.
     #
     - report_url: http://localhost:1978/rpc/report
   ```

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

##### Log collection{% #log-collection %}

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your `datadog.yaml` file:

   ```yaml
   logs_enabled: true
   ```

1. Add this configuration block to your `kyototycoon.d/conf.yaml` file to start collecting Kyoto Tycoon logs:

   ```yaml
   logs:
     - type: file
       path: /var/data/ktserver.log
       source: kyototycoon
   ```

Change the `path` parameter value based on your environment. See the [sample kyototycoon.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/kyototycoon/datadog_checks/kyototycoon/data/conf.yaml.example) for all available configuration options.

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 `kyototycoon` under the Checks section.

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

### Metrics{% #metrics %}

|  |
|  |
| **kyototycoon.connections\_per\_s**(rate)     | Total number of connections*Shown as connection* |
| **kyototycoon.ops.get.hits\_per\_s**(rate)    | Rate of get hits*Shown as hit*                   |
| **kyototycoon.ops.get.misses\_per\_s**(rate)  | Rate of get misses*Shown as hit*                 |
| **kyototycoon.ops.get.total\_per\_s**(rate)   | Rate of total get hits*Shown as hit*             |
| **kyototycoon.ops.set.hits\_per\_s**(rate)    | Rate of set hits*Shown as hit*                   |
| **kyototycoon.ops.set.total\_per\_s**(rate)   | Rate of total set hits*Shown as hit*             |
| **kyototycoon.opts.del.hits\_per\_s**(rate)   | Rate of deleted hits*Shown as hit*               |
| **kyototycoon.opts.del.misses\_per\_s**(rate) | Rate of deleted misses*Shown as miss*            |
| **kyototycoon.opts.del.total\_per\_s**(rate)  | Rate of total deleted hits*Shown as hit*         |
| **kyototycoon.opts.set.misses\_per\_s**(rate) | Rate of set misses*Shown as miss*                |
| **kyototycoon.records**(gauge)                | Total amount of records*Shown as record*         |
| **kyototycoon.replication.delay**(gauge)      | Replication delay*Shown as millisecond*          |
| **kyototycoon.size**(gauge)                   | Current size of the kyoto tycoon DB              |
| **kyototycoon.threads**(gauge)                | Total number of threads*Shown as thread*         |

### Events{% #events %}

The KyotoTycoon check does not include any events.

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

**kyototycoon.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/).