Skip to content

Commit 7fc36d6

Browse files
Add the Ray integration
1 parent 5e4f8b4 commit 7fc36d6

37 files changed

+4904
-0
lines changed

.codecov.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,10 @@ coverage:
454454
target: 75
455455
flags:
456456
- rabbitmq
457+
Ray:
458+
target: 75
459+
flags:
460+
- ray
457461
Redis:
458462
target: 75
459463
flags:
@@ -1215,6 +1219,11 @@ flags:
12151219
paths:
12161220
- rabbitmq/datadog_checks/rabbitmq
12171221
- rabbitmq/tests
1222+
ray:
1223+
carryforward: true
1224+
paths:
1225+
- ray/datadog_checks/ray
1226+
- ray/tests
12181227
redisdb:
12191228
carryforward: true
12201229
paths:

.github/workflows/config/labeler.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,8 @@ integration/pulsar:
345345
- pulsar/**/*
346346
integration/rabbitmq:
347347
- rabbitmq/**/*
348+
integration/ray:
349+
- ray/**/*
348350
integration/redisdb:
349351
- redisdb/**/*
350352
integration/rethinkdb:

.github/workflows/test-all.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2576,6 +2576,25 @@ jobs:
25762576
test-py3: ${{ inputs.test-py3 }}
25772577
minimum-base-package: ${{ inputs.minimum-base-package }}
25782578
secrets: inherit
2579+
jcc172a7:
2580+
uses: ./.github/workflows/test-target.yml
2581+
with:
2582+
job-name: Ray
2583+
target: ray
2584+
platform: linux
2585+
runner: '["ubuntu-22.04"]'
2586+
repo: "${{ inputs.repo }}"
2587+
python-version: "${{ inputs.python-version }}"
2588+
standard: ${{ inputs.standard }}
2589+
latest: ${{ inputs.latest }}
2590+
agent-image: "${{ inputs.agent-image }}"
2591+
agent-image-py2: "${{ inputs.agent-image-py2 }}"
2592+
agent-image-windows: "${{ inputs.agent-image-windows }}"
2593+
agent-image-windows-py2: "${{ inputs.agent-image-windows-py2 }}"
2594+
test-py2: ${{ inputs.test-py2 }}
2595+
test-py3: ${{ inputs.test-py3 }}
2596+
minimum-base-package: ${{ inputs.minimum-base-package }}
2597+
secrets: inherit
25792598
ja7f6415:
25802599
uses: ./.github/workflows/test-target.yml
25812600
with:

ray/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CHANGELOG - Ray
2+
3+
## 1.0.0 / 2023-08-01
4+
5+
***Added***:
6+
7+
* Initial Release ([#15441](https://github.com/DataDog/integrations-core/pull/15441))

ray/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Agent Check: Ray
2+
3+
## Overview
4+
5+
This check monitors [Ray][1] through the Datadog Agent.
6+
7+
## Setup
8+
9+
Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying these instructions.
10+
11+
### Installation
12+
13+
The Ray check is included in the [Datadog Agent][2] package.
14+
No additional installation is needed on your server.
15+
16+
### Configuration
17+
18+
1. Edit the `ray.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your ray performance data. See the [sample ray.d/conf.yaml][4] for all available configuration options.
19+
20+
2. [Restart the Agent][5].
21+
22+
### Validation
23+
24+
[Run the Agent's status subcommand][6] and look for `ray` under the Checks section.
25+
26+
## Data Collected
27+
28+
### Metrics
29+
30+
See [metadata.csv][7] for a list of metrics provided by this integration.
31+
32+
### Events
33+
34+
The Ray integration does not include any events.
35+
36+
### Service Checks
37+
38+
The Ray integration does not include any service checks.
39+
40+
See [service_checks.json][8] for a list of service checks provided by this integration.
41+
42+
## Troubleshooting
43+
44+
Need help? Contact [Datadog support][9].
45+
46+
47+
[1]: **LINK_TO_INTEGRATION_SITE**
48+
[2]: https://app.datadoghq.com/account/settings/agent/latest
49+
[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/
50+
[4]: https://github.com/DataDog/integrations-core/blob/master/ray/datadog_checks/ray/data/conf.yaml.example
51+
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
52+
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
53+
[7]: https://github.com/DataDog/integrations-core/blob/master/ray/metadata.csv
54+
[8]: https://github.com/DataDog/integrations-core/blob/master/ray/assets/service_checks.json
55+
[9]: https://docs.datadoghq.com/help/

ray/assets/configuration/spec.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Ray
2+
files:
3+
- name: ray.yaml
4+
options:
5+
- template: init_config
6+
options:
7+
- template: init_config/openmetrics
8+
- template: instances
9+
options:
10+
- template: instances/openmetrics

ray/assets/service_checks.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[
2+
{
3+
"agent_version": "7.49.0",
4+
"integration": "Ray",
5+
"check": "ray.openmetrics.health",
6+
"statuses": [
7+
"ok",
8+
"critical"
9+
],
10+
"groups": [
11+
"host",
12+
"endpoint"
13+
],
14+
"name": "Ray openmetrics endpoint up",
15+
"description": "Returns `CRITICAL` if the check cannot access the openmetrics metrics endpoint of Ray."
16+
}
17+
]

ray/datadog_checks/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# (C) Datadog, Inc. 2023-present
2+
# All rights reserved
3+
# Licensed under a 3-clause BSD style license (see LICENSE)
4+
__path__ = __import__('pkgutil').extend_path(__path__, __name__) # type: ignore

ray/datadog_checks/ray/__about__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# (C) Datadog, Inc. 2023-present
2+
# All rights reserved
3+
# Licensed under a 3-clause BSD style license (see LICENSE)
4+
__version__ = '0.0.1'

ray/datadog_checks/ray/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# (C) Datadog, Inc. 2023-present
2+
# All rights reserved
3+
# Licensed under a 3-clause BSD style license (see LICENSE)
4+
from .__about__ import __version__
5+
from .check import RayCheck
6+
7+
__all__ = ['__version__', 'RayCheck']

0 commit comments

Comments
 (0)