---
title: Cyral
description: Collect runtime metrics from a Cyral instance monitoring MySQL.
breadcrumbs: Docs > Integrations > Cyral
---

# Cyral
Supported OS Integration version0.1.1
## Overview{% #overview %}

This check monitors a [Cyral](https://cyral.com/) MySQL sidecar through the Datadog Agent.

## Setup{% #setup %}

The Cyral check is not included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you need to install it.

### Installation{% #installation %}

For Agent v7.21+ / v6.21+, follow the instructions below to install the Cyral check on your host. See [Use Community Integrations](https://docs.datadoghq.com/agent/guide/use-community-integrations/) to install with the Docker Agent or earlier versions of the Agent.

1. Run the following command to install the Agent integration:

   ```shell
   datadog-agent integration install -t datadog-cyral==<INTEGRATION_VERSION>
   ```

1. Configure your integration similar to core [integrations](https://docs.datadoghq.com/getting_started/integrations/).

### Configuration{% #configuration %}

1. Edit the `cyral.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your cyral performance data. See the [sample cyral.d/conf.yaml](https://github.com/DataDog/integrations-extras/blob/master/cyral/datadog_checks/cyral/data/conf.yaml.example) for all available configuration options.

   ```yaml
   init_config:
   
   instances:
    # url of the metrics endpoint of prometheus
    - prometheus_url: http://localhost:9018/metrics
   ```

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

### Validation{% #validation %}

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

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

### Metrics{% #metrics %}

|  |
|  |
| **cyral.analysis\_time**(count)                    | Time spent in just doing analysis*Shown as millisecond* |
| **cyral.authentication\_failure\_count**(count)    | The number of authentication failures                   |
| **cyral.catalog\_query\_count**(count)             |
| **cyral.closed\_client\_conns\_count**(count)      |
| **cyral.closed\_listeners\_count**(count)          |
| **cyral.high\_latency\_query\_count**(count)       | Number of queries exceeding (configurable) threshold    |
| **cyral.open\_client\_conns\_count**(count)        |
| **cyral.open\_listeners\_count**(count)            |
| **cyral.policy\_eval\_time**(count)                |
| **cyral.policy\_eval\_time\_counter**(count)       |
| **cyral.policy\_violation\_count**(count)          | The number of queries with policy violations            |
| **cyral.portscan\_count**(count)                   | The number of detected portscan attempts                |
| **cyral.queries\_with\_errors**(count)             |
| **cyral.query\_duration\_count**(count)            | Number of increments to query_duration                  |
| **cyral.query\_duration\_sum**(count)              | The total duration of queries in milliseconds           |
| **cyral.repo\_dial\_errors\_count**(count)         |
| **cyral.row\_count**(count)                        | The number of rows per query                            |
| **cyral.sql\_parse\_time**(count)                  | Time spent doing parsing in milliseconds                |
| **cyral.sql\_parse\_time\_counter**(count)         | Number of increments to sql_parse_time                  |
| **cyral.storage\_watch\_events\_count**(count)     |
| **cyral.wire\_dial\_errors\_count**(count)         |
| **cyral.wire\_parse\_duration**(count)             |
| **cyral.wire\_parse\_duration\_increments**(count) |

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

Cyral does not include any service checks.

### Events{% #events %}

Cyral does not include any events.

## Troubleshooting{% #troubleshooting %}

### Agent cannot connect{% #agent-cannot-connect %}

```text
    cyral
    -------
      - instance #0 [ERROR]: "('Connection aborted.', error(111, 'Connection refused'))"
      - Collected 0 metrics, 0 events & 0 service check
```

Check that the `url` in `cyral.yaml` is correct.

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