Cyral

Supported OS Linux

Integration version0.0.1

Overview

This check monitors a Cyral MySQL sidecar through the Datadog Agent.

Setup

The Cyral check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Cyral check on your host. See 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:

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

  2. Configure your integration similar to core integrations.

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 for all available configuration options.

    init_config:

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

  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for cyral under the Checks section.

Data Collected

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 sqlparsetime
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

Cyral does not include any service checks.

Events

Cyral does not include any events.

Troubleshooting

Agent cannot connect

    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.