Skip to content

Commit 2e331b1

Browse files
authored
[celery] Readme (#20140)
1 parent f9d6411 commit 2e331b1

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

celery/README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,40 @@
22

33
## Overview
44

5-
This check monitors [celery][1] through the Datadog Agent.
5+
This check monitors [Celery][1] through the Datadog Agent. Celery is a distributed task queue system that enables asynchronous task processing in Python applications.
66

7-
Include a high level overview of what this integration does:
8-
- What does your product do (in 1-2 sentences)?
9-
- What value will customers get from this integration, and why is it valuable to them?
10-
- What specific data will your integration monitor, and what's the value of that data?
7+
The Celery integration provides valuable insights into your task queue system by:
8+
- Monitoring worker health, status, and task execution metrics
9+
- Tracking task processing rates, runtime, and prefetch times
10+
- Providing visibility into worker performance and task distribution
11+
- Helping identify bottlenecks and optimize task processing efficiency
1112

1213
## Setup
1314

1415
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.
1516

1617
### Installation
1718

18-
The celery check is included in the [Datadog Agent][2] package.
19+
The Celery check is included in the [Datadog Agent][2] package.
1920
No additional installation is needed on your server.
2021

22+
### Prerequisites
23+
24+
1. Install and configure [Celery Flower][10], the real-time web monitor and administration tool for [Celery][1].
25+
2126
### Configuration
2227

23-
1. Edit the `celery.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your celery performance data. See the [sample celery.d/conf.yaml][4] for all available configuration options.
28+
1. Edit the `celery.d/conf.yaml` file in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Celery performance data. See the [sample celery.d/conf.yaml][4] for all available configuration options.
29+
30+
```yaml
31+
init_config:
32+
33+
instances:
34+
## @param openmetrics_endpoint - string - required
35+
## Endpoint exposing the Celery Flower's Prometheus metrics
36+
#
37+
- openmetrics_endpoint: http://localhost:5555/metrics
38+
```
2439
2540
2. [Restart the Agent][5].
2641
@@ -32,24 +47,23 @@ No additional installation is needed on your server.
3247

3348
### Metrics
3449

35-
See [metadata.csv][7] for a list of metrics provided by this integration.
50+
See [metadata.csv][7] for a complete list of metrics provided by this integration.
3651

3752
### Events
3853

39-
The celery integration does not include any events.
54+
The Celery integration does not include any events.
4055

4156
### Service Checks
4257

43-
The celery integration does not include any service checks.
58+
The Celery integration includes the following service check:
4459

4560
See [service_checks.json][8] for a list of service checks provided by this integration.
4661

4762
## Troubleshooting
4863

4964
Need help? Contact [Datadog support][9].
5065

51-
52-
[1]: **LINK_TO_INTEGRATION_SITE**
66+
[1]: https://docs.celeryq.dev/en/stable/userguide/monitoring.html
5367
[2]: /account/settings/agent/latest
5468
[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/
5569
[4]: https://github.com/DataDog/integrations-core/blob/master/celery/datadog_checks/celery/data/conf.yaml.example
@@ -58,3 +72,4 @@ Need help? Contact [Datadog support][9].
5872
[7]: https://github.com/DataDog/integrations-core/blob/master/celery/metadata.csv
5973
[8]: https://github.com/DataDog/integrations-core/blob/master/celery/assets/service_checks.json
6074
[9]: https://docs.datadoghq.com/help/
75+
[10]: https://flower.readthedocs.io/en/latest/prometheus-integration.html

0 commit comments

Comments
 (0)