Skip to content

Commit e65fd7c

Browse files
Update WarpStream integration
1 parent 10080f7 commit e65fd7c

1 file changed

Lines changed: 16 additions & 15 deletions

File tree

warpstream/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,36 @@ WarpStream is a data streaming platform compatible with Apache Kafka®, designed
88

99
### Installation
1010

11-
[Install the Datadog Agent][1] version `>=6.17` or `>=7.17`.
11+
1. [Download and launch the Datadog Agent][1].
12+
2. Manually install the WarpStream integration. See [Use Community Integrations][2] for more details based on the environment.
1213

1314
### Configuration
1415

15-
Complete all of the following steps to ensure the WarpStream integration works properly.
16+
Complete the following steps to set up the WarpStream integration.
1617

17-
There are two parts of the WarpStream integration:
18+
The WarpStream integration has two components:
1819

19-
-   The **Datadog Agent** portion, which makes requests to a provided endpoint for the WarpStream agent to report whether it can connect and is healthy.
20+
-   The **Datadog Agent** component, which makes requests to an endpoint to check whether WarpStream can connect and is healthy.
2021

21-
-   The **WarpStream StatsD** portion, where the WarpStream Agent can be configured to send metrics to the Datadog Agent.
22+
-   The **WarpStream StatsD** component, which you configure to send metrics to the Datadog Agent.
2223

23-
The WarpStream integration's [metrics][2] come from both the Agent and StatsD portions.
24+
The WarpStream integration's [metrics][3] come from both the Agent and StatsD portions.
2425

25-
##### Configure Datadog Agent WarpStream integration
26+
#### Configure the Datadog Agent WarpStream integration
2627

27-
Configure the WarpStream check included in the [Datadog Agent][3] package to collect health metrics and service checks. This can be done by editing the `url` within the `warpstream.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory, to start collecting your WarpStream service checks. See the [sample warpstream.d/conf.yaml][4] for all available configuration options.
28+
Edit the `url` in `warpstream.d/conf.yaml`, in the `conf.d/` folder at the root of your Agent's configuration directory. See the [sample `warpstream.d/conf.yaml`][4] for all available configuration options.
2829

29-
Ensure that `url` matches your WarpStream Agent HTTP server (port 8080 by default).
30+
The `url` value must match your WarpStream Agent HTTP server (port 8080 by default).
3031

3132
##### Connect WarpStream Agent to DogStatsD
3233

33-
Start the agent with the flag `-enableDatadogMetrics` or set the environment variable `WARPSTREAM_ENABLE_DATADOG_METRICS` to `true`.
34+
Start the WarpStream Agent with the flag `-enableDatadogMetrics` or set the environment variable `WARPSTREAM_ENABLE_DATADOG_METRICS` to `true`.
3435

3536
##### Restart Datadog Agent and WarpStream
3637

3738
1. [Restart the Agent][5].
3839

39-
2. Restart the WarpStream agent to start sending your WarpStream metrics to the Agent DogStatsD endpoint.
40+
2. Restart the WarpStream Agent to start sending your WarpStream metrics to the Agent DogStatsD endpoint.
4041

4142
## Uninstallation
4243

@@ -52,8 +53,8 @@ Need help? Contact us through the following channels:
5253

5354

5455

55-
[1]: https://docs.datadoghq.com/developers/dogstatsd/
56-
[2]: https://github.com/warpstreamlabs/integrations-extras/tree/epot/tier/warpstream#metrics
57-
[3]: https://app.datadoghq.com/account/settings/agent/latest
56+
[1]: https://docs.datadoghq.com/containers/kubernetes/log/
57+
[2]: https://docs.datadoghq.com/agent/guide/community-integrations-installation-with-docker-agent
58+
[3]: https://github.com/warpstreamlabs/integrations-extras/tree/epot/tier/warpstream#metrics
5859
[4]: https://github.com/DataDog/integrations-extras/blob/master/warpstream/datadog_checks/warpstream/data/conf.yaml.example
59-
[5]: https://github.com/DataDog/integrations-extras/blob/master/warpstream/metadata.csv
60+
[5]: https://docs.datadoghq.com/agent/configuration/agent-commands/#start-stop-and-restart-the-agent

0 commit comments

Comments
 (0)