Skip to content

Commit

Permalink
Add CRI core check metadata (#2276)
Browse files Browse the repository at this point in the history
  • Loading branch information
mfpierre authored Oct 10, 2018
1 parent ed98f07 commit 4f1768c
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 0 deletions.
54 changes: 54 additions & 0 deletions cri/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Agent Check: CRI

## Overview

This check monitors a Container Runtime Interface

## Setup

### Installation

CRI is a core agent 6 check and thus need to be configured in both in `datadog.yaml` and with `cri.d/conf.yaml`.

In `datadog.yaml` you will need to configure your `cri_socket_path` for the agent to query your current CRI (you can also configure default timeouts) and in `cri.d/conf.yaml` you can configure the check instance settings such as `collect_disk` if your CRI (such as `containerd`) reports disk usage metrics.

Note that if you're using the agent in a container, setting `DD_CRI_SOCKET_PATH` environment variable will automatically enable the `CRI` check with the default configuration.

### Configuration

1. Edit the `cri.d/conf.yaml` file, in the `conf.d/` folder at the root of your
Agent's configuration directory to start collecting your crio performance data.
See the [sample cri.d/conf.yaml][2] for all available configuration options.

2. [Restart the Agent][3]

### Validation

[Run the Agent's `status` subcommand][4] and look for `cri` under the Checks section.

## Data Collected

### Metrics

CRI collect metrics about the resource usage of your containers running through the CRI.

CPU and memory metrics are collected out of the box and you can additionally collect some disk metrics
if they are supported by your CRI (CRI-O doesn't support them for now)

### Service Checks

CRI does not include service checks.

### Events

CRI does not include any events.

## Troubleshooting

Need help? Contact [Datadog Support][6].

[1]: https://kubernetes.io/blog/2016/12/container-runtime-interface-cri-in-kubernetes/
[3]: https://github.com/DataDog/datadog-agent/blob/master/cmd/agent/dist/conf.d/cri.d/conf.yaml.example
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[5]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[6]: https://docs.datadoghq.com/help/
Binary file added cri/logos/avatars-bot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added cri/logos/saas_logos-bot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added cri/logos/saas_logos-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions cri/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"categories": [
"containers"
],
"creates_events": false,
"display_name": "CRI",
"guid": "6eb96c6a-3e2d-4236-9387-fa3b0c455336",
"is_public": false,
"maintainer": "help@datadoghq.com",
"manifest_version": "1.0.0",
"metric_prefix": "cri.",
"metric_to_check": "cri.cpu.usage",
"name": "CRI",
"public_title": "Datadog-CRI Integration",
"short_description": "Track all your CRI metrics with Datadog",
"support": "core",
"supported_os": [
"linux"
],
"type": "check"
}
5 changes: 5 additions & 0 deletions cri/metadata.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name
cri.mem.rss,gauge,,byte,,The amount of working set memory in bytes ,0,crio,ops count
cri.cpu.usage,rate,,nanocore,,Cumulative CPU usage (sum across all cores) since object creation,0,crio,ops count
cri.disk.used,gauge,,byte,,Represents the bytes used for images on the filesystem,0,crio,ops count
cri.disk.inodes,gauge,,inode,,Represents the inodes used by the images,0,crio,ops count

0 comments on commit 4f1768c

Please sign in to comment.